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-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: JmsQueue.java,v 1.1 2004/11/26 01:50:40 tanderson Exp $
44   */
45  package org.exolab.jms.client;
46  
47  import java.io.Externalizable;
48  import java.io.IOException;
49  import java.io.ObjectInput;
50  import java.io.ObjectOutput;
51  
52  import javax.jms.JMSException;
53  import javax.jms.Queue;
54  import javax.naming.Reference;
55  import javax.naming.StringRefAddr;
56  
57  
58  /***
59   * This object represents a queue, which is a type of destination. A queue
60   * is identified by name and two queues with the same name refer to the
61   * same object.
62   *
63   * @version     $Revision: 1.1 $ $Date: 2004/11/26 01:50:40 $
64   * @author      <a href="mailto:jima@comware.com.au">Jim Alateras</a>
65   */
66  public class JmsQueue
67      extends JmsDestination
68      implements Queue, Externalizable {
69  
70      /***
71       * Used for serialization
72       */
73      static final long serialVersionUID = 1;
74  
75  
76      /***
77       * Need a default constructor for the serialization
78       */
79      public JmsQueue() {
80      }
81  
82      /***
83       * Instantiate an instance of a queue name
84       *
85       * @param       name        queue name
86       */
87      public JmsQueue(String name) {
88          super(name);
89      }
90  
91      /***
92       * Return the name of the queue
93       *
94       * @return      name        name of  the queue
95       * @exception   JMSException
96       */
97      public String getQueueName()
98          throws JMSException {
99          return getName();
100     }
101 
102 
103     // implementation of Object.equals(Object)
104     public boolean equals(Object object) {
105         boolean result = false;
106 
107         if ((object instanceof JmsQueue)
108             && (((JmsQueue) object).getName().equals(this.getName()))) {
109             result = true;
110         }
111 
112         return result;
113     }
114 
115     // implementation of Object.hashCode
116     public int hashCode() {
117         return getName().hashCode();
118     }
119 
120     // implementation of Externalizable.writeExternal
121     public void writeExternal(ObjectOutput stream)
122         throws IOException {
123         stream.writeLong(serialVersionUID);
124         super.writeExternal(stream);
125     }
126 
127     // implementation of Externalizable.writeExternal
128     public void readExternal(ObjectInput stream)
129         throws IOException, ClassNotFoundException {
130         long version = stream.readLong();
131         if (version == serialVersionUID) {
132             super.readExternal(stream);
133         } else {
134             throw new IOException("JmsQueue with version "
135                                   + version + " is not supported.");
136         }
137     }
138 
139     /***
140      * Retrieves the <code>Reference</code> of this object
141      *
142      * @return the non-null <code>Reference</code> of this object
143      */
144     public Reference getReference() {
145         Reference reference = new Reference(
146             JmsQueue.class.getName(), new StringRefAddr("name", getName()),
147             JmsDestinationFactory.class.getName(), null);
148 
149         // add the persistence attribute
150         reference.add(new StringRefAddr("persistent",
151                                         (getPersistent() ? "true" : "false")));
152 
153         return reference;
154     }
155 }