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: TCPSRequestInfo.java,v 1.2 2005/12/01 13:44:38 tanderson Exp $
44 */
45 package org.exolab.jms.net.tcp;
46
47 import org.exolab.jms.net.socket.SocketRequestInfo;
48 import org.exolab.jms.net.util.SSLProperties;
49 import org.exolab.jms.net.util.Properties;
50 import org.exolab.jms.net.connector.ResourceException;
51 import org.exolab.jms.net.uri.URI;
52
53
54 /***
55 * Implementation of the {@link org.exolab.jms.net.connector.ConnectionRequestInfo}
56 * interface that enables the TCPS connector to pass data across the
57 * connection request flow.
58 *
59 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
60 * @version $Revision: 1.2 $ $Date: 2005/12/01 13:44:38 $
61 */
62 public class TCPSRequestInfo extends SocketRequestInfo {
63
64 /***
65 * Properties to configure the secure socket layer. May be
66 * <code>null</code>.
67 */
68 private SSLProperties _sslProperties = null;
69
70 /***
71 * Determines if connections which are accepted must include client
72 * authentication. By default, clients do not need to provide
73 * authentication information.
74 */
75 private boolean _needCientAuth = false;
76
77 /***
78 * Connection property to indicate if clients must authentication
79 * themselves on connection.
80 */
81 private static final String NEED_CLIENT_AUTH = "needClientAuth";
82
83
84 /***
85 * Construct a new <code>TCPSRequestInfo</code>.
86 *
87 * @param uri the URI
88 * @throws ResourceException if <code>uri</code> has an invalid query string
89 */
90 public TCPSRequestInfo(URI uri) throws ResourceException {
91 super(uri);
92 }
93
94 /***
95 * Construct a new <code>TCPSRequestInfo</code>.
96 *
97 * @param uri the URI
98 * @param properties the properties to populate this from
99 * @throws ResourceException if any of the properties are invalid
100 */
101 public TCPSRequestInfo(URI uri, Properties properties)
102 throws ResourceException {
103 super(uri, properties);
104 SSLProperties ssl = new SSLProperties(properties);
105 if (!ssl.isEmpty()) {
106 setSSLProperties(ssl);
107 }
108 setNeedClientAuth(
109 properties.getBoolean(NEED_CLIENT_AUTH, _needCientAuth));
110 }
111
112 /***
113 * Returns the properties used to configure the secure socket layer (SSL).
114 *
115 * @return the SSL configuration properties, or <code>null</code> if unset
116 */
117 public SSLProperties getSSLProperties() {
118 return _sslProperties;
119 }
120
121 /***
122 * Sets the properties used to configure the secure socket layer (SSL).
123 *
124 * @param properties the SSL configuration properties
125 */
126 public void setSSLProperties(SSLProperties properties) {
127 _sslProperties = properties;
128 }
129
130 /***
131 * Sets if clients must authenticate themselves on connection.
132 *
133 * @param required if <code>true</code>, the clients must authenticate
134 * themselves.
135 */
136 public void setNeedClientAuth(boolean required) {
137 _needCientAuth = required;
138 }
139
140 /***
141 * Determines if clients must authenticate themselves on connection.
142 *
143 * @return <code>true</code> if clients must authenticate themselves.
144 */
145 public boolean getNeedClientAuth() {
146 return _needCientAuth;
147 }
148
149 /***
150 * Helper to export this to a {@link Properties} instance.
151 *
152 * @param properties the properties to export to.
153 */
154 public void export(Properties properties) {
155 super.export(properties);
156 SSLProperties ssl = getSSLProperties();
157 if (ssl != null) {
158 ssl.export(properties);
159 }
160 properties.set(NEED_CLIENT_AUTH, getNeedClientAuth());
161 }
162
163 /***
164 * Checks whether this instance is equal to another.
165 *
166 * @param other the object to compare
167 * @return <code>true</code> if the two instances are equal; otherwise
168 * <code>false</code>
169 */
170 public boolean equals(Object other) {
171 boolean equal = false;
172 if (other instanceof TCPSRequestInfo && super.equals(other)) {
173 TCPSRequestInfo info = (TCPSRequestInfo) other;
174 if (_needCientAuth == info._needCientAuth
175 && equals(_sslProperties, info._sslProperties)) {
176 equal = true;
177 }
178 }
179 return equal;
180 }
181
182 }