KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > exolab > jms > server > ServerConnectionFactory


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: ServerConnectionFactory.java,v 1.1 2005/03/18 04:07:02 tanderson Exp $
44  */

45 package org.exolab.jms.server;
46
47 import javax.jms.InvalidClientIDException JavaDoc;
48 import javax.jms.JMSException JavaDoc;
49 import javax.jms.JMSSecurityException JavaDoc;
50
51
52 /**
53  * Indicates the methods clients can call on the server-side implementation of
54  * the {@link javax.jms.ConnectionFactory} interface
55  *
56  * @author <a HREF="mailto:tma@netspace.net.au">Tim Anderson</a>
57  * @version $Revision: 1.1 $ $Date: 2005/03/18 04:07:02 $
58  */

59 public interface ServerConnectionFactory {
60
61     /**
62      * Creates a connection with the specified user identity.
63      * <p/>
64      * The connection is created in stopped mode. No messages will be delivered
65      * until the <code>Connection.start</code> method is explicitly called.
66      * <p/>
67      * If <code>clientID</code> is specified, it indicates the pre-configured
68      * client identifier associated with the client <code>ConnectionFactory</code>
69      * object.
70      *
71      * @param clientID the pre-configured client identifier. May be
72      * <code>null</code>
73      * @param userName the caller's user name
74      * @param password the caller's password
75      * @return a newly created connection
76      * @throws InvalidClientIDException if the JMS client specifies an invalid
77      * or duplicate client ID.
78      * @throws JMSException if the JMS provider fails to create the
79      * connection due to some internal error.
80      * @throws JMSSecurityException if client authentication fails due to an
81      * invalid user name or password.
82      */

83     ServerConnection createConnection(String JavaDoc clientID, String JavaDoc userName,
84                                       String JavaDoc password)
85             throws JMSException JavaDoc;
86
87 }
88
Popular Tags