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: ConnectorCfg.java,v 1.2 2005/05/07 14:17:22 tanderson Exp $
44 */
45 package org.exolab.jms.server.net;
46
47 import java.util.Map;
48
49 import org.exolab.jms.config.types.SchemeType;
50 import org.exolab.jms.config.ConnectionFactories;
51
52
53 /***
54 * <code>ConnectorConfig</code> provides configuration information for an
55 * ORB connector.
56 *
57 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
58 * @version $Revision: 1.2 $ $Date: 2005/05/07 14:17:22 $
59 */
60 public interface ConnectorCfg {
61
62 /***
63 * Returns the connector scheme.
64 *
65 * @return the connector scheme
66 */
67 SchemeType getScheme();
68
69 /***
70 * Returns the URI used to establsh connections to remote services.
71 *
72 * @return the URI used to establish connections to remote services
73 */
74 String getConnectURI();
75
76 /***
77 * Returns the URI that services are exported on.
78 *
79 * @return the URI for exporting services
80 */
81 String getExportURI();
82
83 /***
84 * Returns the URI that JNDI service is exported on.
85 * <p/>
86 * Typically, this will be the same as that returned by
87 * {@link #getExportURI}.
88 *
89 * @return the JNDI service URI
90 */
91 String getJNDIExportURI();
92
93 /***
94 * Returns the URI the administration service is exported on.
95 * <p/>
96 * Typically, this will be the same as that returned by
97 * {@link #getExportURI}.
98 *
99 * @return the administration service URI
100 */
101 String getAdminExportURI();
102
103 /***
104 * Returns properties to configure the ORB to enable it to establish
105 * a connection to the remote ORB.
106 *
107 * @return a map of String properties
108 */
109 Map getConnectProperties();
110
111 /***
112 * Returns properties to configure the ORB to enable it to accept
113 * connections from remote ORBs.
114 *
115 * @return a map of String properties
116 */
117 Map getAcceptProperties();
118
119 /***
120 * Returns connection factories associated with this configuration.
121 *
122 * @return associated connection factories.
123 */
124 ConnectionFactories getConnectionFactories();
125
126 }