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 2004-2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: SocketConnectionFactory.java,v 1.7 2005/05/03 13:45:59 tanderson Exp $
44   */
45  package org.exolab.jms.net.socket;
46  
47  import java.util.Map;
48  
49  import org.exolab.jms.net.connector.AbstractConnectionFactory;
50  import org.exolab.jms.net.connector.ConnectionManager;
51  import org.exolab.jms.net.connector.ConnectionRequestInfo;
52  import org.exolab.jms.net.connector.ManagedConnectionFactory;
53  import org.exolab.jms.net.connector.ResourceException;
54  import org.exolab.jms.net.uri.URI;
55  
56  
57  /***
58   * A factory for establishing and accepting socket connections.
59   *
60   * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
61   * @version $Revision: 1.7 $ $Date: 2005/05/03 13:45:59 $
62   */
63  public abstract class SocketConnectionFactory
64          extends AbstractConnectionFactory {
65  
66  
67      /***
68       * Construct a new <code>SocketConnectionFactory</code>.
69       *
70       * @param scheme  the scheme that this factory supports, for both connect
71       *                and accept
72       * @param factory the managed connection factory
73       * @param manager the connection manager
74       */
75      public SocketConnectionFactory(String scheme,
76                                     ManagedConnectionFactory factory,
77                                     ConnectionManager manager) {
78          super(scheme, factory, manager);
79      }
80  
81      /***
82       * Construct a new <code>SocketConnectionFactory</code>.
83       *
84       * @param connectScheme the connect scheme that this factory supports
85       * @param acceptScheme  the accept scheme that this factory supports
86       * @param factory       the managed connection factory
87       * @param manager       the connection manager
88       */
89      public SocketConnectionFactory(String connectScheme, String acceptScheme,
90                                     ManagedConnectionFactory factory,
91                                     ConnectionManager manager) {
92          super(connectScheme, acceptScheme, factory, manager);
93      }
94  
95      /***
96       * Returns connection request info for the specified URI and connection
97       * properties.
98       *
99       * @param uri        the connection address
100      * @param properties connection properties. If <code>null</code>, use the
101      *                   default connection properties
102      * @return connection request info corresponding to <code>uri</code> and
103      *         <code>properties</code>
104      * @throws ResourceException for any error
105      */
106     protected ConnectionRequestInfo getConnectionRequestInfo(URI uri,
107                                                              Map properties)
108             throws ResourceException {
109         SocketRequestInfo info;
110         if (properties != null) {
111             info = new SocketRequestInfo(uri, getProperties(properties));
112         } else {
113             info = new SocketRequestInfo(uri);
114         }
115         return info;
116     }
117 
118 }