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: ManagedConnection.java,v 1.4 2006/12/16 12:37:17 tanderson Exp $
44 */
45 package org.exolab.jms.net.connector;
46
47 import org.exolab.jms.net.uri.URI;
48
49 import java.security.Principal;
50
51
52 /***
53 * A <code>ManagedConnection</code> represents a physical connection. <br/> It
54 * is responsible for managing multiple {@link Connection} instances, which
55 * perform method invocations over the physical connection.
56 *
57 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
58 * @version $Revision: 1.4 $ $Date: 2006/12/16 12:37:17 $
59 * @see Connection
60 */
61 public interface ManagedConnection {
62
63 /***
64 * Registers a handler for handling invocations on objects exported via this
65 * connection. Once a handler is registered, it cannot be de-registered.
66 *
67 * @param handler the invocation handler
68 * @throws IllegalStateException if a handler is already registered
69 * @throws ResourceException for any error
70 */
71 void setInvocationHandler(InvocationHandler handler)
72 throws ResourceException;
73
74 /***
75 * Registers a connection event listener.
76 *
77 * @param listener the connection event listener
78 * @throws ResourceException for any error
79 */
80 void setConnectionEventListener(ManagedConnectionListener listener)
81 throws ResourceException;
82
83 /***
84 * Creates a new connection handle for the underlying physical connection.
85 *
86 * @return a new connection handle
87 * @throws IllegalStateException if an <code>InvocationHandler</code> hasn't
88 * been registered
89 * @throws ResourceException for any error
90 */
91 Connection getConnection() throws ResourceException;
92
93 /***
94 * Ping the connection. The connection event listener will be notified
95 * if the ping succeeds.
96 * NOTE: the notification may occur prior to this call returning.
97 *
98 * @throws IllegalStateException if no invocation handler has been
99 * registered, or if the connection has been
100 * destroyed
101 * @throws ResourceException for any error
102 */
103 void ping() throws ResourceException;
104
105 /***
106 * Returns the remote address to which this is connected.
107 *
108 * @return the remote address to which this is connected
109 * @throws ResourceException for any error
110 */
111 URI getRemoteURI() throws ResourceException;
112
113 /***
114 * Returns the local address that this connection is bound to.
115 *
116 * @return the local address that this connection is bound to
117 * @throws ResourceException for any error
118 */
119 URI getLocalURI() throws ResourceException;
120
121 /***
122 * Returns the principal associated with this connection.
123 *
124 * @return the principal associated with this connection,
125 * or <code>null<code> if none is set
126 * @throws ResourceException for any error
127 */
128 Principal getPrincipal() throws ResourceException;
129
130 /***
131 * Destroys the physical connection.
132 *
133 * @throws ResourceException for any error
134 */
135 void destroy() throws ResourceException;
136
137 }