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-2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: ConnectionPool.java,v 1.5 2005/06/04 14:51:06 tanderson Exp $
44 */
45 package org.exolab.jms.net.connector;
46
47 import java.security.Principal;
48
49 import org.exolab.jms.net.uri.URI;
50
51
52 /***
53 * Manages a pool of {@link ManagedConnection} instances, for a particular
54 * {@link ManagedConnectionFactory}.
55 *
56 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
57 * @version $Revision: 1.5 $ $Date: 2005/06/04 14:51:06 $
58 */
59 public interface ConnectionPool {
60
61 /***
62 * Creates a new connection.
63 *
64 * @param principal the security principal
65 * @param info the connection request info
66 * @return a new connection
67 * @throws ResourceException if a connection cannot be established
68 */
69 ManagedConnection createManagedConnection(Principal principal,
70 ConnectionRequestInfo info)
71 throws ResourceException;
72
73 /***
74 * Creates an acceptor for connections
75 *
76 * @param authenticator authenticates incoming connections
77 * @param info the connection request info
78 * @return a new connection acceptor
79 * @throws ResourceException if an acceptor cannot be created
80 */
81 ManagedConnectionAcceptor createManagedConnectionAcceptor(
82 Authenticator authenticator, ConnectionRequestInfo info)
83 throws ResourceException;
84
85 /***
86 * Returns a matched connection from the set of pooled connections.
87 *
88 * @param principal the security principal
89 * @param info the connection request info
90 * @return the first acceptable match, or <code>null</code> if none is
91 * found
92 * @throws ResourceException for any error
93 */
94 ManagedConnection matchManagedConnections(Principal principal,
95 ConnectionRequestInfo info)
96 throws ResourceException;
97
98 /***
99 * Returns a matched acceptor from the set of pooled connections.
100 *
101 * @param info the connection request info
102 * @return the first acceptable match, or <code>null</code> if none is
103 * found
104 * @throws ResourceException for any error
105 */
106 ManagedConnectionAcceptor matchManagedConnectionAcceptors(
107 ConnectionRequestInfo info) throws ResourceException;
108
109 /***
110 * Returns a listener for handling accepted connections.
111 *
112 * @return a listener for handling accepted connections
113 * @throws ResourceException for any error
114 */
115 ManagedConnectionAcceptorListener getManagedConnectionAcceptorListener()
116 throws ResourceException;
117
118 /***
119 * Sets the listener for caller events.
120 *
121 * @param listener the listener
122 */
123 void setCallerListener(CallerListener listener);
124
125 /***
126 * Closes this connection pool, cleaning up any allocated resources.
127 *
128 * @throws ResourceException for any error
129 */
130 void close() throws ResourceException;
131
132 }