KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > exolab > jms > net > rmi > RMIRequestInfo


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: RMIRequestInfo.java,v 1.2 2005/05/03 13:45:58 tanderson Exp $
44  */

45 package org.exolab.jms.net.rmi;
46
47 import org.exolab.jms.net.connector.ResourceException;
48 import org.exolab.jms.net.connector.URIRequestInfo;
49 import org.exolab.jms.net.uri.URI;
50 import org.exolab.jms.net.util.Properties;
51
52
53 /**
54  * Implementation of the {@link org.exolab.jms.net.connector.ConnectionRequestInfo}
55  * interface that enables the RMI connector to pass data across the connection
56  * request flow.
57  *
58  * @author <a HREF="mailto:tma@netspace.net.au">Tim Anderson</a>
59  * @version $Revision: 1.2 $ $Date: 2005/05/03 13:45:58 $
60  */

61 public class RMIRequestInfo extends URIRequestInfo {
62
63     /**
64      * Determines if the registry is embedded or not.
65      */

66     private boolean _embedRegistry = true;
67
68     /**
69      * Connection property name to indicate the whether the registry is embedded
70      * or not.
71      */

72     protected static final String JavaDoc EMBED_REGISTRY = "embedRegistry";
73
74
75     /**
76      * Construct a new <code>RMIRequestInfo</code>.
77      *
78      * @param uri the URI
79      */

80     public RMIRequestInfo(URI uri) {
81         super(uri);
82     }
83
84     /**
85      * Construct a new <code>RMIRequestInfo</code>.
86      *
87      * @param uri the URI
88      * @param properties the properties to populate this from
89      * @throws ResourceException if any of the properties are invalid
90      */

91     public RMIRequestInfo(URI uri, Properties properties)
92             throws ResourceException {
93         super(uri);
94         setEmbedRegistry(properties.getBoolean(EMBED_REGISTRY, true));
95     }
96
97     /**
98      * Sets if the registry is embedded or external.
99      *
100      * @param embedded if <code>true</code> the registry is embedded, otherwise
101      * its external
102      */

103     public void setEmbedRegistry(boolean embedded) {
104         _embedRegistry = embedded;
105     }
106
107     /**
108      * Determines if the registry is embedded or external.
109      *
110      * @return <code>true</code> the registry is embedded, otherwise its
111      * external
112      */

113     public boolean getEmbedRegistry() {
114         return _embedRegistry;
115     }
116
117     /**
118      * Helper to export this to a {@link Properties} instance.
119      *
120      * @param properties the properties to export to.
121      */

122     public void export(Properties properties) {
123         super.export(properties);
124         properties.set(EMBED_REGISTRY, getEmbedRegistry());
125     }
126
127     /**
128      * Checks whether this instance is equal to another.
129      *
130      * @param other the object to compare
131      * @return <code>true</code> if the two instances are equal; otherwise
132      * <code>false</code>
133      */

134     public boolean equals(Object JavaDoc other) {
135         boolean equal = super.equals(other);
136         if (equal && other instanceof RMIRequestInfo) {
137             RMIRequestInfo info = (RMIRequestInfo) other;
138             if (_embedRegistry == info._embedRegistry) {
139                 equal = true;
140             }
141         } else {
142             equal = false;
143         }
144         return equal;
145     }
146
147 }
148
Popular Tags