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: HTTPSManagedConnectionFactory.java,v 1.2 2005/03/23 12:34:07 tanderson Exp $
44 */
45 package org.exolab.jms.net.http;
46
47 import java.security.Principal;
48
49 import org.apache.commons.logging.LogFactory;
50 import org.apache.commons.logging.Log;
51
52 import org.exolab.jms.net.connector.Authenticator;
53 import org.exolab.jms.net.connector.ConnectionFactory;
54 import org.exolab.jms.net.connector.ConnectionManager;
55 import org.exolab.jms.net.connector.ConnectionRequestInfo;
56 import org.exolab.jms.net.connector.ManagedConnection;
57 import org.exolab.jms.net.connector.ManagedConnectionAcceptor;
58 import org.exolab.jms.net.connector.ResourceException;
59 import org.exolab.jms.net.socket.SocketRequestInfo;
60
61
62 /***
63 * A factory for {@link HTTPSConnectionFactory} and
64 * {@link HTTPSManagedConnection} instances.
65 *
66 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
67 * @version $Revision: 1.2 $ $Date: 2005/03/23 12:34:07 $
68 */
69 public class HTTPSManagedConnectionFactory
70 extends AbstractHTTPManagedConnectionFactory {
71
72 /***
73 * Initicates if SSL has been initialised.
74 */
75 private static boolean _sslInit = false;
76
77 /***
78 * Protocol handler packages system property name
79 */
80 private static final String PROTOCOL_HANDLER_PKGS
81 = "java.protocol.handler.pkgs";
82
83 /***
84 * Package of Sun SSL implementation.
85 */
86 private static final String SUN_PACKAGE
87 = "com.sun.net.ssl.internal.www.protocol";
88
89 /***
90 * The logger.
91 */
92 private static final Log _log =
93 LogFactory.getLog(HTTPSManagedConnectionFactory.class);
94
95 /***
96 * Creates a new connection factory.
97 *
98 * @param manager the connection manager
99 * @return a new connection factory
100 * @throws ResourceException if the factory cannot be created
101 */
102 public ConnectionFactory createConnectionFactory(ConnectionManager manager)
103 throws ResourceException {
104 return new HTTPSConnectionFactory(this, manager);
105 }
106
107 /***
108 * Creates a new connection.
109 *
110 * @param principal the security principal
111 * @param info the connection request info
112 * @return a new connection
113 * @throws ResourceException if a connection cannot be established
114 */
115 public ManagedConnection createManagedConnection(Principal principal,
116 ConnectionRequestInfo info)
117 throws ResourceException {
118 if (!(info instanceof HTTPRequestInfo)) {
119 throw new ResourceException("Argument 'info' must be of type "
120 + HTTPRequestInfo.class.getName());
121 }
122 initSSL();
123
124 return new HTTPSManagedConnection(principal, (HTTPRequestInfo) info);
125 }
126
127 /***
128 * Creates an acceptor for connections.
129 *
130 * @param authenticator authenticates incoming connections
131 * @param info the connection request info
132 * @return a new connection acceptor
133 * @throws ResourceException if an acceptor cannot be created
134 */
135 public ManagedConnectionAcceptor createManagedConnectionAcceptor(
136 Authenticator authenticator, ConnectionRequestInfo info)
137 throws ResourceException {
138
139 if (!(info instanceof SocketRequestInfo)) {
140 throw new ResourceException("Argument 'info' must be of type "
141 + SocketRequestInfo.class.getName());
142 }
143
144 return new HTTPSManagedConnectionAcceptor(authenticator,
145 (SocketRequestInfo) info);
146 }
147
148 /***
149 * Initialise SSL. This is only applicable for Sun JDK 1.2 and 1.3,
150 * which need to have the <code>java.protocol.handler.pkgs</code>
151 * system property set in order for the <code>java.net.URL</code>
152 * class to support https.
153 * If the property can't be set due to security permissions, creation of
154 * HTTPSManagedConnection instances will fail.
155 * <p>
156 * When running Non-Sun JREs, clients must set the
157 * java.protocol.handler.pkgs property themselves
158 */
159 private static synchronized void initSSL() {
160 if (!_sslInit) {
161 try {
162 String value = System.getProperty(PROTOCOL_HANDLER_PKGS);
163 if (value == null) {
164 value = SUN_PACKAGE;
165 } else if (value.indexOf(SUN_PACKAGE) == -1) {
166 if (value.length() > 0) {
167 value += "|";
168 }
169 value += SUN_PACKAGE;
170 }
171 System.setProperty(PROTOCOL_HANDLER_PKGS, SUN_PACKAGE);
172 _sslInit = true;
173 } catch (SecurityException exception) {
174 if (_log.isDebugEnabled()) {
175 _log.debug("Failed to set property="
176 + PROTOCOL_HANDLER_PKGS, exception);
177 }
178 }
179 }
180 }
181
182
183 }