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: JmsClientStubFactory.java,v 1.3 2003/08/07 13:32:49 tanderson Exp $
44   *
45   * Date         Author  Changes
46   * 3/21/2000    jima    Created
47   */
48  package org.exolab.jms.client;
49  
50  import javax.jms.JMSException;
51  
52  
53  /***
54   * This is a helper clas that is responsible for cresting the various types of
55   * stubs. The client requires three stubs one to talk to the remote jms server
56   * (i.e connection factory) one to talk to the connection and another to talk
57   * to the session.
58   * <p>
59   * This classrelies on configuration information to determine which ORB to
60   * use.
61   *
62   * @version     $Revision: 1.3 $ $Date: 2003/08/07 13:32:49 $
63   * @author      <a href="mailto:jima@exoffice.com">Jim Alateras</a>
64   **/
65  final public class JmsClientStubFactory {
66  
67      /***
68       * This class method creates and returns a stub to the remote server
69       * entity. This entity must support the JmsServerStubIfc interface
70       * <p>
71       * If there is problem creating the stub then throw the JMSException
72       * exception
73       *
74       * @param       id              client identity
75       * @exception   JMSException
76       */
77      public static JmsServerStubIfc createJmsServerStub()
78          throws JMSException {
79          // dynamincally instantiate an instance of this class and then set the
80          // client id. Finally, establish the connection
81          return null;
82      }
83  
84      /***
85       * This class method creates and returns a stub to the remote connection
86       * entity. This entity must support the JmsConnectionStubIfc interface
87       * It uses the client identity to initialise the connection.
88       * <p>
89       * If there is problem creating the stub then throw the JMSException
90       * exception
91       *
92       * @param       id              client identity
93       * @exception   JMSException
94       */
95      public static JmsConnectionStubIfc createJmsConnectionStub(String id)
96          throws JMSException {
97          // will hard code the class name, but once we have sorted out
98          // the type of configuration file we will need to retrieve it from
99          // a property
100         // dynamincally instantiate an instance of this class and then set the
101         // client id. Finally, establish the connection
102         return null;
103     }
104 
105     /***
106      * This class method creates and returns a stub to the rmeote session
107      * entity. The created entity must support the JmsSessionStubIfc interface.
108      * This level of indirection will assist us in supported different ORB
109      * environments
110      * <p>
111      * If there is a problem creating the stub then throw the JMSException
112      * exception
113      *
114      * @param       id              client identity
115      * @exception   JMSException
116      */
117     public static JmsSessionStubIfc createJmsSessionStub(String id)
118         throws JMSException {
119         // dynamincally instantiate an instance of this class and then set the
120         // client id. Finally, establish the connection
121         return null;
122     }
123 
124 
125     /***
126      * This is the name of the server stub. This will be passed in as a
127      * configuraton parameter in the future
128      */
129     final private static String SERVER_CLASS =
130         "org.exolab.jms.server.rmi.RemoteJmsServerIfc";
131 
132     /***
133      * This is the name of the connection stub that will be used to gain access
134      * to the remote connection. This will be passed as a configuration
135      * parameter in future.
136      */
137     final private static String CONNECTION_CLASS =
138         "org.exolab.jms.server.rmi.RemoteJmsServerConnectionIfc";
139 
140     /***
141      * This is the name of the session stub that will be used to gain access to the
142      * remote session. This will be passed in as a configuration paramter in
143      * future
144      */
145     final private static String SESSION_CLASS =
146         "org.exolab.jms.server.rmi.RemoteJmsServerSessionIfc";
147 }