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-2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: JmsTemporaryQueue.java,v 1.2 2005/12/20 20:36:43 tanderson Exp $
44   */
45  package org.exolab.jms.client;
46  
47  import java.io.IOException;
48  import java.io.ObjectInput;
49  import java.io.ObjectOutput;
50  
51  import javax.jms.JMSException;
52  import javax.jms.TemporaryQueue;
53  import javax.jms.TemporaryTopic;
54  import javax.naming.Reference;
55  
56  import org.exolab.jms.common.uuid.UUID;
57  
58  
59  /***
60   * A temporary queue is created by a client through a session and has
61   * a lifetime of the session's connection.
62   *
63   * @version     $Revision: 1.2 $ $Date: 2005/12/20 20:36:43 $
64   * @author      <a href="mailto:jima@exoffice.com">Jim Alateras</a>
65   */
66  public class JmsTemporaryQueue
67      extends JmsQueue
68      implements TemporaryQueue, JmsTemporaryDestination {
69  
70      /***
71       * Used for serialization
72       */
73      static final long serialVersionUID = 2;
74  
75      /***
76       * The identifier of the connection that created this temporary
77       * destination.
78       */
79      private long _connectionId;
80  
81      /***
82       * Reference to the connection that owns this deztination.
83       */
84      private transient JmsConnection _connection = null;
85  
86      /***
87       * Constructor provided for serialization.
88       */
89      public JmsTemporaryQueue() {
90      }
91  
92      /***
93       * Construct a new <code>JmsTemporaryTopic</code>.
94       *
95       * @param connection the owning connection
96       */
97      private JmsTemporaryQueue(JmsConnection connection) {
98          super(TEMP_QUEUE_PREFIX + UUID.next());
99          _connection = connection;
100         _connectionId = connection.getConnectionId();
101     }
102 
103     // implementation of TemporaryTopic.delete
104     public void delete()
105         throws JMSException {
106         // unregister the temporary topic from the owning destination
107         _connection.deleteTemporaryDestination(this);
108     }
109 
110     // implementation of JmsTemporaryDestination.getOwningConnection
111     public JmsConnection getOwningConnection() {
112         return _connection;
113     }
114 
115     // implementation of JmsTemporaryDestination.getConnectionId
116     public long getConnectionId() {
117         return _connectionId;
118     }
119 
120     // implementation of Referenceable.getReference
121     public Reference getReference() {
122         // should never be called for temp destination
123         return null;
124     }
125 
126     // implementation of JmsTemporaryDestination.validForConnection
127     public boolean validForConnection(JmsConnection connection) {
128         boolean result = false;
129 
130         if (connection != null
131             && connection.getConnectionId() == _connectionId) {
132             result = true;
133         }
134 
135         return result;
136     }
137 
138     // implementation of Externalizable.writeExternal
139     public void writeExternal(ObjectOutput stream)
140         throws IOException {
141         stream.writeLong(serialVersionUID);
142         stream.writeLong(_connectionId);
143         super.writeExternal(stream);
144     }
145 
146     // implementation of Externalizable.writeExternal
147     public void readExternal(ObjectInput stream)
148         throws IOException, ClassNotFoundException {
149         long version = stream.readLong();
150         if (version == serialVersionUID) {
151             _connectionId = stream.readLong();
152             super.readExternal(stream);
153         } else {
154             throw new IOException("JmsTemporaryQueue with version "
155                                   + version + " is not supported.");
156         }
157     }
158 
159     /***
160      * Construct a new temporary queue.
161      *
162      * @param connection the connection owns that the queue
163      * @return a new temporary queue
164      */
165     public static TemporaryQueue create(JmsConnection connection) {
166         return new JmsTemporaryQueue(connection);
167     }
168 }