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-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: JmsTopicPublisher.java,v 1.12 2004/01/20 14:14:21 tanderson Exp $
44 */
45 package org.exolab.jms.client;
46
47 import javax.jms.JMSException;
48 import javax.jms.Message;
49 import javax.jms.Topic;
50 import javax.jms.TopicPublisher;
51
52
53 /***
54 * Client implementation of the <code>javax.jms.TopicPublisher</code> interface
55 *
56 * @version $Revision: 1.12 $ $Date: 2004/01/20 14:14:21 $
57 * @author <a href="mailto:jima@exoffice.com">Jim Alateras</a>
58 */
59 class JmsTopicPublisher
60 extends JmsMessageProducer
61 implements TopicPublisher {
62
63 /***
64 * The destination that messages are delivered to, or <code>null</code>
65 * if this is an unidentified producer
66 */
67 private JmsTopic _topic = null;
68
69
70 /***
71 * Construct a new <code>JmsTopicPublisher</code>
72 *
73 * @param session the session constructing this object
74 * @param topic the publisher's destination. May be <code>null</code>.
75 */
76 public JmsTopicPublisher(JmsSession session, JmsTopic topic) {
77 super(session);
78 _topic = topic;
79 }
80
81 /***
82 * Returns the topic associated with this publisher
83 *
84 * @return the topic associated with this publisher, or <code>null</code>
85 * if this is an unidentified producer
86 */
87 public Topic getTopic() {
88 return _topic;
89 }
90
91 /***
92 * Publish a message, using the default delivery mode, priority and time to
93 * live.
94 *
95 * @param message the message to send
96 * @throws JMSException if the message can't be sent
97 */
98 public void publish(Message message) throws JMSException {
99 publish(getTopic(), message, getDeliveryMode(), getPriority(),
100 getTimeToLive());
101 }
102
103 /***
104 * Publish a message to a topic for an unidentified message producer, using
105 * the default delivery mode, priority and time to live
106 *
107 * @param topic the topic to publish the message to
108 * @param message the message to send
109 * @throws JMSException if the message can't be sent
110 */
111 public void publish(Topic topic, Message message) throws JMSException {
112 publish(topic, message, getDeliveryMode(), getPriority(),
113 getTimeToLive());
114 }
115
116 /***
117 * Publish a message, specifying the delivery mode, priority and time to
118 * live
119 *
120 * @param message the message to send
121 * @param deliveryMode the delivery mode to use
122 * @param priority the message priority
123 * @param timeToLive the message's lifetime (in milliseconds).
124 * @throws JMSException if the message can't be sent
125 */
126 public void publish(Message message, int deliveryMode, int priority,
127 long timeToLive) throws JMSException {
128 publish(getTopic(), message, deliveryMode, priority, timeToLive);
129 }
130
131 /***
132 * Publish a message to a topic for an unidentified message producer,
133 * specifying the delivery mode, priority and time to live
134 *
135 * @param topic the topic to publish the message to
136 * @param message the message to send
137 * @param deliveryMode the delivery mode to use
138 * @param priority the message priority
139 * @param timeToLive the message's lifetime (in milliseconds).
140 * @throws JMSException if the message can't be sent
141 */
142 public void publish(Topic topic, Message message, int deliveryMode,
143 int priority, long timeToLive) throws JMSException {
144 sendMessage(topic, message, deliveryMode, priority, timeToLive);
145 }
146
147 /***
148 * Close the publisher
149 *
150 * @throws JMSException if the publisher can't be closed
151 */
152 public synchronized void close() throws JMSException {
153 if (!isClosed()) {
154
155
156 JmsTopicSession session = (JmsTopicSession) getSession();
157 session.removePublisher(this);
158 super.close();
159 }
160 }
161
162 /***
163 * Destroy the publisher
164 */
165 public void destroy() {
166 super.destroy();
167 _topic = null;
168 }
169
170 }