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 2001-2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: JmsConnectionFactoryBuilder.java,v 1.2 2005/03/18 03:36:37 tanderson Exp $
44   */
45  package org.exolab.jms.client;
46  
47  import java.util.Enumeration;
48  import java.util.HashMap;
49  import java.util.Hashtable;
50  import javax.naming.Context;
51  import javax.naming.Name;
52  import javax.naming.Reference;
53  import javax.naming.StringRefAddr;
54  import javax.naming.spi.ObjectFactory;
55  
56  
57  /***
58   * Implementation of the {@link ObjectFactory} interface that creates {@link
59   * JmsConnectionFactory} instances given a corresponding {@link Reference}
60   *
61   * @author <a href="mailto:jima@comware.com.au">Jim Alateras</a>
62   * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
63   * @version $Revision: 1.2 $ $Date: 2005/03/18 03:36:37 $
64   * @see JmsConnectionFactory
65   * @see JmsXAConnectionFactory
66   */
67  public class JmsConnectionFactoryBuilder
68          implements ObjectFactory {
69  
70      /***
71       * Creates an object using the location or reference information specified.
72       * This only constructs
73       *
74       * @param object      the object containing location or reference
75       *                    information that can be used in creating an object.
76       *                    May be <code>null</code>
77       * @param name        the name of this object relative to <code>context</code>,
78       *                    or <code>null</code> if no name is specified.
79       * @param context     the context relative to which the <code>name</code>
80       *                    parameter is specified, or <code>null</code> if
81       *                    <code>name</code> is relative to the default initial
82       *                    context.
83       * @param environment the environment used in creating the object. May be
84       *                    <code>null</code>
85       * @return the object created oird <code>null</code> if an object can't be
86       *         created.
87       * @throws Exception if this object factory encountered an exception while
88       *                   attempting to create an object, and no other object
89       *                   factories are to be tried.
90       */
91      public Object getObjectInstance(Object object, Name name, Context context,
92                                      Hashtable environment) throws Exception {
93          Object result = null;
94  
95          if (object instanceof Reference) {
96              Reference ref = (Reference) object;
97              String clazz = ref.getClassName();
98  
99              if (clazz.equals(JmsConnectionFactory.class.getName())
100                     || clazz.equals(JmsXAConnectionFactory.class.getName())) {
101 
102                 StringRefAddr serverClass =
103                         (StringRefAddr) ref.get("serverClass");
104                 String serverClassName = (String) serverClass.getContent();
105                 
106 
107                 // get a list of string properties and store them in a
108                 // hashtable
109                 HashMap properties = new HashMap();
110                 Enumeration iter = ref.getAll();
111                 while (iter.hasMoreElements()) {
112                     StringRefAddr addr = (StringRefAddr) iter.nextElement();
113                     properties.put(addr.getType(), addr.getContent());
114                 }
115 
116                 // create the factory
117                 if (clazz.equals(JmsConnectionFactory.class.getName())) {
118                     result = new JmsConnectionFactory(serverClassName,
119                                                       properties, environment);
120                 } else {
121                     result = new JmsXAConnectionFactory(serverClassName,
122                                                         properties,
123                                                         environment);
124                 }
125             }
126         }
127         return result;
128     }
129 }
130