View Javadoc

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: ManagedConnectionListener.java,v 1.3 2006/12/16 12:37:17 tanderson Exp $
44   */
45  package org.exolab.jms.net.connector;
46  
47  
48  /***
49   * A listener for {@link ManagedConnection} events.
50   *
51   * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
52   * @version $Revision: 1.3 $ $Date: 2006/12/16 12:37:17 $
53   */
54  public interface ManagedConnectionListener {
55  
56      /***
57       * Notifies closure of a connection. The <code>ManagedConnection</code>
58       * instance invokes this to notify its registered listeners when
59       * the peer closes the connection.
60       *
61       * @param source the managed connection that is the source of the event
62       */
63      void closed(ManagedConnection source);
64  
65      /***
66       * Notifies a connection related error. The <code>ManagedConnection</code>
67       * instance invokes this to notify its registered listeners of the
68       * occurrence of a physical connection-related error.
69       *
70       * @param source    the managed connection that is the source of the event
71       * @param throwable the error
72       */
73      void error(ManagedConnection source, Throwable throwable);
74  
75      /***
76       * Notifies of a successful ping.
77       *
78       * @param source the managed connection that is the source of the event
79       */
80      void pinged(ManagedConnection source);
81  
82  }