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-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: URIRequestInfo.java,v 1.3 2005/05/03 13:45:58 tanderson Exp $
44 */
45 package org.exolab.jms.net.connector;
46
47 import java.net.InetAddress;
48 import java.net.UnknownHostException;
49 import java.security.Principal;
50
51 import org.exolab.jms.net.uri.URI;
52 import org.exolab.jms.net.uri.URIHelper;
53 import org.exolab.jms.net.util.Properties;
54 import org.exolab.jms.net.orb.ORB;
55
56
57 /***
58 * Implementation of the {@link ConnectionRequestInfo} interface that enables a
59 * connector to pass URI data across the connection request flow.
60 *
61 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
62 * @version $Revision: 1.3 $ $Date: 2005/05/03 13:45:58 $
63 */
64 public class URIRequestInfo implements ConnectionRequestInfo {
65
66 /***
67 * The URI.
68 */
69 private URI _uri;
70
71 /***
72 * The security principal. May be null.
73 */
74 private Principal _principal;
75
76
77 /***
78 * Construct a new <code>URIRequestInfo</code>.
79 *
80 * @param uri the URI
81 */
82 public URIRequestInfo(URI uri) {
83 _uri = uri;
84 _principal = URIHelper.getPrincipal(uri);
85 }
86
87 /***
88 * Returns the host.
89 *
90 * @return the host, or <code>null</code> if the host was not specified in
91 * the URI.
92 */
93 public String getHost() {
94 return _uri.getHost();
95 }
96
97 /***
98 * Returns the host as an <code>InetAddress</code>.
99 *
100 * @return the host or <code>null</code> if the host was not specified in
101 * the URI.
102 * @throws UnknownHostException if no IP address for the host could be
103 * found.
104 */
105 public InetAddress getHostAddress() throws UnknownHostException {
106 String host = getHost();
107 return (host != null) ? InetAddress.getByName(host) : null;
108 }
109
110 /***
111 * Returns the port.
112 *
113 * @return the port
114 */
115 public int getPort() {
116 return _uri.getPort();
117 }
118
119 /***
120 * Returns the URI.
121 *
122 * @return the URI
123 */
124 public URI getURI() {
125 return _uri;
126 }
127
128 /***
129 * Returns the security principal.
130 *
131 * @return the security principal. May be null.
132 */
133 public Principal getPrincipal() {
134 return _principal;
135 }
136
137 /***
138 * Helper to export this to a {@link Properties} instance.
139 *
140 * @param properties the properties to export to.
141 */
142 public void export(Properties properties) {
143 properties.set(ORB.PROVIDER_URI, _uri);
144 }
145
146 /***
147 * Checks whether this instance is equal to another.
148 *
149 * @param other the object to compare
150 * @return <code>true</code> if the two instances are equal; otherwise
151 * <code>false</code>
152 */
153 public boolean equals(Object other) {
154 boolean equal = (this == other);
155 if (!equal && other instanceof URIRequestInfo) {
156 URIRequestInfo info = (URIRequestInfo) other;
157 equal = _uri.equals(info._uri);
158 }
159 return equal;
160 }
161
162 /***
163 * Returns a hashcode for this request info.
164 *
165 * @return a hashcode for this request info.
166 */
167 public int hashCode() {
168 return _uri.hashCode();
169 }
170
171 }