KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > exolab > jms > net > connector > ConnectionFactory


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: ConnectionFactory.java,v 1.3 2005/05/03 13:45:58 tanderson Exp $
44  */
45 package org.exolab.jms.net.connector;
46
47 import java.security.Principal JavaDoc;
48 import java.util.Map JavaDoc;
49
50 import org.exolab.jms.net.uri.URI;
51
52
53 /**
54  * A factory for establishing connections, and accepting them.
55  *
56  * @author <a HREF="mailto:tma@netspace.net.au">Tim Anderson</a>
57  * @version $Revision: 1.3 $ $Date: 2005/05/03 13:45:58 $
58  */
59 public interface ConnectionFactory {
60
61     /**
62      * Determines if this factory supports connections to the specified URI.
63      *
64      * @param uri the connection address
65      * @return <code>true</code> if this factory supports the URI;
66      * <code>false</code> otherwise
67      */
68     boolean canConnect(URI uri);
69
70     /**
71      * Returns a connection to the specified URI, using the default connection
72      * properties.
73      *
74      * @param principal the security principal. May be <code>null</code>
75      * @param uri the connection address
76      * @return a connection to <code>uri</code>
77      * @throws ResourceException if a connection cannot be established
78      */
79     Connection getConnection(Principal JavaDoc principal, URI uri)
80             throws ResourceException;
81
82     /**
83      * Returns a connection to the specified URI, using the specified connection
84      * properties.
85      *
86      * @param principal the security principal. May be <code>null</code>
87      * @param uri the connection address
88      * @param properties connection properties. If <code>null</code>, use the
89      * default connection properties
90      * @return a connection to <code>uri</code>
91      * @throws ResourceException if a connection cannot be established
92      */
93     Connection getConnection(Principal JavaDoc principal, URI uri,
94                              Map JavaDoc properties)
95             throws ResourceException;
96
97     /**
98      * Determines if this factory supports listening for new connections on the
99      * specified URI.
100      *
101      * @param uri the connection address
102      * @return <code>true</code> if this factory supports the URI;
103      * <code>false</code> otherwise
104      */
105     boolean canAccept(URI uri);
106
107     /**
108      * Listen for new connections on the specified URI, using the default
109      * connection acceptor properties.
110      *
111      * @param uri the connection address
112      * @throws ResourceException if connections can't be accepted on the
113      * specified URI
114      */
115     void accept(URI uri) throws ResourceException;
116
117     /**
118      * Listen for new connections on the specified URI, using the specified
119      * acceptor properties
120      *
121      * @param uri the connection address
122      * @param properties acceptor properties. May be <code>null</code>
123      * @throws ResourceException if connections can't be accepted on the
124      * specified URI
125      */
126     void accept(URI uri, Map JavaDoc properties) throws ResourceException;
127
128 }
129
Popular Tags