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: JmsTopicSubscriber.java,v 1.2 2005/03/18 03:36:37 tanderson Exp $
44 */
45 package org.exolab.jms.client;
46
47 import javax.jms.Topic;
48 import javax.jms.TopicSubscriber;
49
50
51 /***
52 * Client implementation of the <code>javax.jms.TopicSubscriber</code>
53 * interface.
54 *
55 * @author <a href="mailto:jima@comware.com.au">Jim Alateras</a>
56 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
57 * @version $Revision: 1.2 $ $Date: 2005/03/18 03:36:37 $
58 */
59 class JmsTopicSubscriber
60 extends JmsMessageConsumer
61 implements TopicSubscriber {
62
63 /***
64 * If <code>true</code>, indicates that locally published messages are
65 * inhibited.
66 */
67 private final boolean _noLocal;
68
69
70 /***
71 * Construct a new <code>JmsTopicSubscriber</code>
72 *
73 * @param session the session responsible for the consumer
74 * @param consumerId the identity of the consumer
75 * @param topic the topic to subscribe to
76 * @param selector the message selector. May be <code>null</code>
77 * @param noLocal if <code>true</code>, indicates that locally published
78 */
79 public JmsTopicSubscriber(JmsSession session, long consumerId,
80 Topic topic, String selector,
81 boolean noLocal) {
82 super(session, consumerId, topic, selector);
83 _noLocal = noLocal;
84 }
85
86 /***
87 * Returns the topic associated with this subscriber.
88 *
89 * @return the topic associated with this subscriber
90 */
91 public Topic getTopic() {
92 return (Topic) getDestination();
93 }
94
95 /***
96 * Returns if locally published messages are being inhibited.
97 *
98 * @return <code>true</code> if locally published messages are being
99 * inhibited.
100 */
101 public boolean getNoLocal() {
102 return _noLocal;
103 }
104
105 }
106