KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > exolab > jms > client > JmsQueueConnection


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 2000-2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42  *
43  * $Id: JmsQueueConnection.java,v 1.2 2005/03/18 03:36:37 tanderson Exp $
44  */
45 package org.exolab.jms.client;
46
47
48 import javax.jms.ConnectionConsumer JavaDoc;
49 import javax.jms.InvalidSelectorException JavaDoc;
50 import javax.jms.JMSException JavaDoc;
51 import javax.jms.Queue JavaDoc;
52 import javax.jms.QueueConnection JavaDoc;
53 import javax.jms.QueueSession JavaDoc;
54 import javax.jms.ServerSessionPool JavaDoc;
55 import javax.jms.Topic JavaDoc;
56
57
58 /**
59  * Client implementation of the <code>javax.jms.QueueConnection</code>
60  * interface.
61  *
62  * @author <a HREF="mailto:jima@exoffice.com">Jim Alateras</a>
63  * @author <a HREF="mailto:tma@netspace.net.au">Tim Anderson</a>
64  * @version $Revision: 1.2 $ $Date: 2005/03/18 03:36:37 $
65  * @see javax.jms.QueueConnection
66  */
67 class JmsQueueConnection extends JmsConnection implements QueueConnection JavaDoc {
68
69     /**
70      * Construct a new <code>JmsQueueConnection</code>.
71      * <p/>
72      * This attempts to establish a connection to the JMS server
73      *
74      * @param factory the connection factory responsible for creating this
75      * @param clientID the pre-configured client identifier. May be
76      * <code>null</code>
77      * @param username the client username
78      * @param password the client password
79      * @throws JMSException if a connection cannot be established
80      */
81     public JmsQueueConnection(JmsConnectionFactory factory, String JavaDoc clientID,
82                               String JavaDoc username, String JavaDoc password)
83             throws JMSException JavaDoc {
84         super(factory, clientID, username, password);
85     }
86
87     /**
88      * Create a new queue session.
89      *
90      * @param transacted if <code>true</code>, the session is transacted.
91      * @param ackMode indicates whether the consumer or the client will
92      * acknowledge any messages it receives. This parameter
93      * will be ignored if the session is transacted. Legal
94      * values are <code>Session.AUTO_ACKNOWLEDGE</code>,
95      * <code>Session.CLIENT_ACKNOWLEDGE</code> and
96      * <code>Session.DUPS_OK_ACKNOWLEDGE</code>.
97      * @return the new queue session
98      * @throws JMSException if the session cannot be created
99      */
100     public QueueSession JavaDoc createQueueSession(boolean transacted, int ackMode)
101             throws JMSException JavaDoc {
102
103         ensureOpen();
104         setModified();
105
106         JmsQueueSession session = new JmsQueueSession(this, transacted,
107                                                       ackMode);
108
109         // if the connection is started then also start the session
110 if (!isStopped()) {
111             session.start();
112         }
113
114         // add it to the list of managed sessions for this connection
115 addSession(session);
116
117         return session;
118     }
119
120     /**
121      * Create a connection consumer for this connection
122      *
123      * @param queue the queue to access
124      * @param selector the message selector. May be <code>null</code>
125      * @param pool the server session pool to associate with the
126      * consumer
127      * @param maxMessages the maximum number of messages that can be assigned to
128      * a server session at one time
129      * @return the new connection consumer
130      * @throws InvalidSelectorException if the message selector is invalid
131      * @throws JMSException if the connection consumer cannot be
132      * created
133      */
134     public ConnectionConsumer JavaDoc createConnectionConsumer(Queue JavaDoc queue,
135                                                        String JavaDoc selector,
136                                                        ServerSessionPool JavaDoc pool,
137                                                        int maxMessages)
138             throws JMSException JavaDoc {
139         return super.createConnectionConsumer(queue, selector, pool,
140                                               maxMessages);
141     }
142
143     /**
144      * This implementation always throws <code>IllegalStateException</code>,
145      * as per section 4.11 of the JMS specification.
146      *
147      * @throws IllegalStateException if invoked
148      */
149     public ConnectionConsumer JavaDoc createDurableConnectionConsumer(
150             Topic JavaDoc topic, String JavaDoc subscriptionName, String JavaDoc messageSelector,
151             ServerSessionPool JavaDoc sessionPool, int maxMessages)
152             throws JMSException JavaDoc {
153         throw new IllegalStateException JavaDoc("Invalid operation for QueueConnection");
154     }
155
156 }
157
Popular Tags