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 1999 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: JmsQueueConnectionFactory.java,v 1.12 2003/08/07 13:32:50 tanderson Exp $
44   *
45   * Date         Author  Changes
46   * 3/21/2000    jima    Created
47   */
48  package org.exolab.jms.client;
49  
50  import java.io.Externalizable;
51  import java.io.IOException;
52  import java.io.ObjectInput;
53  import java.io.ObjectOutput;
54  import java.util.Hashtable;
55  
56  import javax.jms.JMSException;
57  import javax.jms.QueueConnection;
58  import javax.jms.QueueConnectionFactory;
59  import javax.naming.Referenceable;
60  
61  import org.exolab.jms.util.UUID;
62  
63  
64  /***
65   * This class extends JmsConnectionFactory and is responsible for creating
66   * QueueConnections with other JMS PTP providers
67   *
68   * @version     $Revision: 1.12 $ $Date: 2003/08/07 13:32:50 $
69   * @author      <a href="mailto:jima@exoffice.com">Jim Alateras</a>
70   **/
71  public class JmsQueueConnectionFactory
72      extends JmsConnectionFactory
73      implements QueueConnectionFactory, Externalizable, Referenceable {
74  
75      /***
76       * Used for serialization
77       */
78      static final long serialVersionUID = 1;
79  
80  
81      /***
82       * Need a default constructor so that it can be support externalization
83       */
84      public JmsQueueConnectionFactory() {
85      }
86  
87      /***
88       * Instantiate an instance of the queue connection factory with the name
89       * of the class that will facilitate communication with the JmsServer
90       *
91       * @param       name            name of the class
92       * @param       env             environment for constructing the connection
93       *                              to the server
94       */
95      public JmsQueueConnectionFactory(String name, Hashtable env) {
96          super(name, env);
97      }
98  
99      // implementation of QueueConnectionFactory.createQueueConnection
100     public QueueConnection createQueueConnection()
101         throws JMSException {
102         return this.createQueueConnection(null, null);
103     }
104 
105 
106     // implementation of QueueConnectionFactory.createQueueConnection
107     public QueueConnection createQueueConnection(String userName, String password)
108         throws JMSException {
109         JmsQueueConnection connection = null;
110 
111         // generate an id and then create a connection with the specified id.
112         // Once the connection has been created register it with the factory.
113         String id = UUID.next();
114         connection = new JmsQueueConnection(this, id, userName, password);
115         this.addConnection(connection);
116 
117         return connection;
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.readExternal
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("JmsQueueConnectionFactory with version " +
135                 version + " is not supported.");
136         }
137     }
138 }