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: ServerConnection.java,v 1.2 2005/08/30 05:47:03 tanderson Exp $
44 */
45 package org.exolab.jms.server;
46
47 import javax.jms.InvalidClientIDException;
48 import javax.jms.JMSException;
49
50
51 /***
52 * Indicates the methods clients can call on the server-side implementation of
53 * the {@link javax.jms.Connection} interface
54 *
55 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
56 * @version $Revision: 1.2 $ $Date: 2005/08/30 05:47:03 $
57 */
58 public interface ServerConnection {
59
60 /***
61 * Returns the connection identifier
62 *
63 * @return the connection identifier
64 * @throws JMSException for any JMS error
65 */
66 long getConnectionId() throws JMSException;
67
68 /***
69 * Returns the client identifier
70 *
71 * @return the client identifier
72 * @throws JMSException for any JMS error
73 */
74 String getClientID() throws JMSException;
75
76 /***
77 * Sets the client identifier for this connection.
78 *
79 * @param clientID the unique client identifier
80 * @throws JMSException if the JMS provider fails to set the
81 * client ID for this connection due to
82 * some internal error.
83 * @throws InvalidClientIDException if the JMS client specifies an invalid
84 * or duplicate client ID.
85 * @throws IllegalStateException if the JMS client attempts to set a
86 * connection's client ID at the wrong time
87 * or when it has been administratively
88 * configured.
89 */
90 void setClientID(String clientID) throws JMSException;
91
92 /***
93 * Create a new session.
94 *
95 * @param acknowledgeMode indicates whether the consumer or the client will
96 * acknowledge any messages it receives; ignored if
97 * the session is transacted. Legal values are
98 * <code>Session.AUTO_ACKNOWLEDGE</code>,
99 * <code>Session.CLIENT_ACKNOWLEDGE</code>, and
100 * <code>Session.DUPS_OK_ACKNOWLEDGE</code>.
101 * @param transacted indicates whether the session is transacted
102 * @return a newly created session
103 * @throws JMSException for any JMS error
104 */
105 ServerSession createSession(int acknowledgeMode, boolean transacted)
106 throws JMSException;
107
108 /***
109 * Closes the connection.
110 *
111 * @throws JMSException for any JMS error
112 */
113 void close() throws JMSException;
114
115 }