KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > exolab > jms > net > connector > ManagedConnection


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: ManagedConnection.java,v 1.2 2005/06/04 14:28:52 tanderson Exp $
44  */
45 package org.exolab.jms.net.connector;
46
47 import org.exolab.jms.net.uri.URI;
48
49
50 /**
51  * A <code>ManagedConnection</code> represents a physical connection. <br/> It
52  * is responsible for managing multiple {@link Connection} instances, which
53  * perform method invocations over the physical connection.
54  *
55  * @author <a HREF="mailto:tma@netspace.net.au">Tim Anderson</a>
56  * @version $Revision: 1.2 $ $Date: 2005/06/04 14:28:52 $
57  * @see Connection
58  */
59 public interface ManagedConnection {
60
61     /**
62      * Registers a handler for handling invocations on objects exported via this
63      * connection. Once a handler is registered, it cannot be de-registered.
64      *
65      * @param handler the invocation handler
66      * @throws IllegalStateException if a handler is already registered
67      * @throws ResourceException for any error
68      */
69     void setInvocationHandler(InvocationHandler handler)
70             throws ResourceException;
71
72     /**
73      * Registers a connection event listener.
74      *
75      * @param listener the connection event listener
76      * @throws ResourceException for any error
77      */
78     void setConnectionEventListener(ManagedConnectionListener listener)
79             throws ResourceException;
80
81     /**
82      * Creates a new connection handle for the underlying physical connection.
83      *
84      * @return a new connection handle
85      * @throws IllegalStateException if an <code>InvocationHandler</code> hasn't
86      * been registered
87      * @throws ResourceException for any error
88      */
89     Connection getConnection() throws ResourceException;
90
91     /**
92      * Determines if the underlying physical connection is alive.
93      *
94      * @return <code>true</code> if the connection is alive
95      */
96     boolean isAlive();
97
98     /**
99      * Returns the remote address to which this is connected.
100      *
101      * @return the remote address to which this is connected
102      * @throws ResourceException for any error
103      */
104     URI getRemoteURI() throws ResourceException;
105
106     /**
107      * Returns the local address that this connection is bound to.
108      *
109      * @return the local address that this connection is bound to
110      * @throws ResourceException for any error
111      */
112     URI getLocalURI() throws ResourceException;
113
114     /**
115      * Destroys the physical connection.
116      *
117      * @throws ResourceException for any error
118      */
119     void destroy() throws ResourceException;
120
121 }
122
Popular Tags