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 2003-2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: RMIManagedConnectionFactory.java,v 1.3 2005/05/27 13:58:02 tanderson Exp $
44   */
45  package org.exolab.jms.net.rmi;
46  
47  import java.security.Principal;
48  import java.util.Iterator;
49  import java.util.List;
50  
51  import org.exolab.jms.net.connector.Authenticator;
52  import org.exolab.jms.net.connector.ConnectionFactory;
53  import org.exolab.jms.net.connector.ConnectionManager;
54  import org.exolab.jms.net.connector.ConnectionRequestInfo;
55  import org.exolab.jms.net.connector.ManagedConnection;
56  import org.exolab.jms.net.connector.ManagedConnectionAcceptor;
57  import org.exolab.jms.net.connector.ManagedConnectionFactory;
58  import org.exolab.jms.net.connector.ResourceException;
59  import org.exolab.jms.net.uri.URI;
60  import org.exolab.jms.net.uri.URIHelper;
61  
62  
63  /***
64   * A factory for {@link RMIConnectionFactory}, {@link RMIManagedConnection} and
65   * {@link RMIManagedConnectionAcceptor} instances.
66   *
67   * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
68   * @version $Revision: 1.3 $ $Date: 2005/05/27 13:58:02 $
69   */
70  public class RMIManagedConnectionFactory implements ManagedConnectionFactory {
71  
72      /***
73       * Creates a new connection factory
74       *
75       * @param manager the connection manager
76       * @return a new connection factory
77       * @throws ResourceException if the factory cannot be created
78       */
79      public ConnectionFactory createConnectionFactory(ConnectionManager manager)
80              throws ResourceException {
81          return new RMIConnectionFactory(this, manager);
82      }
83  
84      /***
85       * Creates a new connection.
86       *
87       * @param principal the security principal
88       * @param info      the connection request info
89       * @return a new connection
90       * @throws ResourceException if a connection cannot be established
91       */
92      public ManagedConnection createManagedConnection(Principal principal,
93                                                       ConnectionRequestInfo info)
94              throws ResourceException {
95          if (!(info instanceof RMIRequestInfo)) {
96              throw new ResourceException("Argument 'info' must be of type "
97                                          + RMIRequestInfo.class.getName());
98          }
99          return new RMIManagedConnection(principal, (RMIRequestInfo) info);
100     }
101 
102     /***
103      * Creates an acceptor for connections.
104      *
105      * @param authenticator authenticates incoming connections
106      * @param info          the connection request info
107      * @return a new connection acceptor
108      * @throws ResourceException if an acceptor cannot be created
109      */
110     public ManagedConnectionAcceptor createManagedConnectionAcceptor(
111             Authenticator authenticator, ConnectionRequestInfo info)
112             throws ResourceException {
113 
114         if (!(info instanceof RMIRequestInfo)) {
115             throw new ResourceException("Argument 'info' must be of type "
116                                         + RMIRequestInfo.class.getName());
117         }
118         RMIRequestInfo rmiInfo = (RMIRequestInfo) info;
119         return new RMIManagedConnectionAcceptor(authenticator, rmiInfo);
120     }
121 
122     /***
123      * Returns a matched connection from the candidate set of connections.
124      *
125      * @param connections the candidate connections
126      * @param principal   the security principal
127      * @param info        the connection request info
128      * @return the first acceptable match, or <code>null</code> if none is
129      *         found
130      * @throws ResourceException for any error
131      */
132     public ManagedConnection matchManagedConnections(List connections,
133                                                      Principal principal,
134                                                      ConnectionRequestInfo info)
135             throws ResourceException {
136         ManagedConnection result = null;
137 
138         if (info instanceof RMIRequestInfo) {
139             RMIRequestInfo requestInfo = (RMIRequestInfo) info;
140             URI uri = URIHelper.convertHostToAddress(requestInfo.getURI());
141 
142             Iterator iterator = connections.iterator();
143             while (iterator.hasNext()) {
144                 RMIManagedConnection connection =
145                         (RMIManagedConnection) iterator.next();
146                 if (connection.hasPrincipal(principal)
147                         && uri.equals(connection.getRemoteURI())) {
148                     result = connection;
149                     break;
150                 }
151             }
152         }
153         return result;
154     }
155 
156     /***
157      * Returns a matched connection acceptor from the candidate set of
158      * acceptors.
159      *
160      * @param acceptors the candidate connection acceptors
161      * @param info      the connection request info
162      * @return the first acceptable match, or <code>null</code> if none is
163      *         found
164      * @throws ResourceException for any error
165      */
166     public ManagedConnectionAcceptor matchManagedConnectionAcceptors(
167             List acceptors, ConnectionRequestInfo info)
168             throws ResourceException {
169         ManagedConnectionAcceptor result = null;
170 
171         if (info instanceof RMIRequestInfo) {
172             RMIRequestInfo requestInfo = (RMIRequestInfo) info;
173             URI uri = URIHelper.convertHostToAddress(requestInfo.getURI());
174             Iterator iterator = acceptors.iterator();
175             while (iterator.hasNext()) {
176                 RMIManagedConnectionAcceptor acceptor =
177                         (RMIManagedConnectionAcceptor) iterator.next();
178                 if (uri.equals(acceptor.getURI())) {
179                     result = acceptor;
180                     break;
181                 }
182             }
183         }
184         return result;
185     }
186 
187 }