1 /***
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Exoffice Technologies. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Exoffice Technologies. Exolab is a registered
23 * trademark of Exoffice Technologies.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2003-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: ManagedConnectionFactory.java,v 1.1 2004/11/26 01:51:03 tanderson Exp $
44 */
45 package org.exolab.jms.net.connector;
46
47 import java.security.Principal;
48 import java.util.List;
49
50
51 /***
52 * A factory for {@link ConnectionFactory}, {@link ManagedConnection} and {@link
53 * ManagedConnectionAcceptor} instances
54 *
55 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
56 * @version $Revision: 1.1 $ $Date: 2004/11/26 01:51:03 $
57 */
58 public interface ManagedConnectionFactory {
59
60 /***
61 * Creates a new connection factory
62 *
63 * @param manager the connection manager
64 * @return a new connection factory
65 * @throws ResourceException if the factory cannot be created
66 */
67 ConnectionFactory createConnectionFactory(ConnectionManager manager)
68 throws ResourceException;
69
70 /***
71 * Creates a new connection
72 *
73 * @param principal the security principal
74 * @param info the connection request info. May be <code>null</code>
75 * @return a new connection
76 * @throws ResourceException if a connection cannot be established
77 */
78 ManagedConnection createManagedConnection(Principal principal,
79 ConnectionRequestInfo info)
80 throws ResourceException;
81
82 /***
83 * Creates an acceptor for connections
84 *
85 * @param authenticator authenticates incoming connections
86 * @param info the connection request info. May be
87 * <code>null</code>
88 * @return a new connection acceptor
89 * @throws ResourceException if an acceptor cannot be created
90 */
91 ManagedConnectionAcceptor createManagedConnectionAcceptor(
92 Authenticator authenticator, ConnectionRequestInfo info)
93 throws ResourceException;
94
95 /***
96 * Returns a matched connection from the candidate set of connections
97 *
98 * @param connections the candidate connections
99 * @param principal the security principal
100 * @param info the connection request info. May be <code>null</code>
101 * @return the first acceptable match, or <code>null</code> if none is
102 * found
103 * @throws ResourceException for any error
104 */
105 ManagedConnection matchManagedConnections(List connections,
106 Principal principal,
107 ConnectionRequestInfo info)
108 throws ResourceException;
109
110 /***
111 * Returns a matched connection acceptor from the candidate set of
112 * acceptors
113 *
114 * @param acceptors the candidate connection acceptors
115 * @param info the connection request info. May be <code>null</code>
116 * @return the first acceptable match, or <code>null</code> if none is
117 * found
118 * @throws ResourceException for any error
119 */
120 ManagedConnectionAcceptor matchManagedConnectionAcceptors(
121 List acceptors, ConnectionRequestInfo info)
122 throws ResourceException;
123
124 }