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 2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: SocketConnectorCfg.java,v 1.3 2005/12/01 13:53:23 tanderson Exp $
44   */
45  package org.exolab.jms.server.net;
46  
47  import org.exolab.jms.config.Configuration;
48  import org.exolab.jms.config.SocketConfigurationType;
49  import org.exolab.jms.config.types.SchemeType;
50  import org.exolab.jms.net.socket.SocketRequestInfo;
51  import org.exolab.jms.net.uri.URI;
52  import org.exolab.jms.net.util.Properties;
53  import org.exolab.jms.net.connector.ResourceException;
54  
55  
56  /***
57   * Configuration for socket-based connectors.
58   *
59   * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
60   * @version $Revision: 1.3 $ $Date: 2005/12/01 13:53:23 $
61   */
62  abstract class SocketConnectorCfg extends AbstractConnectorCfg {
63  
64      /***
65       * The socket configuration.
66       */
67      private SocketConfigurationType _config;
68  
69  
70      /***
71       * Construct a new <code>SocketConnectorCfg</code>.
72       *
73       * @param scheme       the connector scheme
74       * @param config       the configuration to use
75       * @param socketConfig the socket configuration
76       */
77      public SocketConnectorCfg(SchemeType scheme, Configuration config,
78                                SocketConfigurationType socketConfig) {
79          super(scheme, config);
80          if (socketConfig == null) {
81              throw new IllegalArgumentException(
82                      "Argument 'socketConfig' is null");
83          }
84          _config = socketConfig;
85      }
86  
87      /***
88       * Populates the supplied properties with connection accept properties.
89       *
90       * @param properties the properties to populate
91       */
92      protected void populateAcceptProperties(Properties properties) {
93          URI uri = getURI(getExportURI());
94          SocketRequestInfo info;
95          try {
96              info = new SocketRequestInfo(uri);
97          } catch (ResourceException exception) {
98              // should never happen
99              throw new IllegalStateException(exception.getMessage());
100         }
101         populateRequestInfo(info);
102         info.export(properties);
103     }
104 
105     /***
106      * Populates the connection request info with data from the configuration.
107      *
108      * @param info the connection request info to populate
109      */
110     protected void populateRequestInfo(SocketRequestInfo info) {
111         info.setBindAll(_config.getBindAll());
112     }
113 
114     /***
115      * Returns the socket configuration.
116      *
117      * @return the socket configuration
118      */
119     protected SocketConfigurationType getSocketConfiguration() {
120         return _config;
121     }
122 
123 }