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 2000,2003 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: JmsTemporaryDestination.java,v 1.4 2003/08/17 01:32:21 tanderson Exp $
44   *
45   * Date         Author  Changes
46   * 06/14/2000  jima    Created
47   */
48  package org.exolab.jms.client;
49  
50  
51  /***
52   * This is an interface for all temporary destinations. All temporary
53   * destinations are scoped by the connection
54   *
55   * @version     $Revision: 1.4 $ $Date: 2003/08/17 01:32:21 $
56   * @author      <a href="mailto:jima@exoffice.com">Jim Alateras</a>
57   * @see         JmsTemporaryTopic
58   * @see         JmsTemporaryQueue
59   */
60  public interface JmsTemporaryDestination {
61  
62      /***
63       * Set the connection that owns this temp destination. This destination is
64       * scoped by this connection and cannot be used outside of this scope
65       *
66       * @param       connection
67       */
68      public void setOwningConnection(JmsConnection connection);
69  
70      /***
71       * Return the connection that owns this temporary destination.
72       *
73       * @return      JmsConnection
74       */
75      public JmsConnection getOwningConnection();
76  
77      /***
78       * Return the identity of the owning connection as a string
79       *
80       * @return      String
81       */
82      public String getConnectionId();
83  
84      /***
85       * Checks whether the temporary destination is valid for the specified
86       * connection
87       *
88       * @param connection - the connection to test against
89       * @return boolean - true if it can be used.
90       */
91      public boolean validForConnection(JmsConnection connection);
92  }