KickJava   Java API By Example, From Geeks To Geeks.

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


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: JmsTopicPublisher.java,v 1.2 2005/03/18 03:36:37 tanderson Exp $
44  */
45 package org.exolab.jms.client;
46
47 import javax.jms.JMSException JavaDoc;
48 import javax.jms.Message JavaDoc;
49 import javax.jms.Topic JavaDoc;
50 import javax.jms.TopicPublisher JavaDoc;
51
52
53 /**
54  * Client implementation of the <code>javax.jms.TopicPublisher</code> interface.
55  *
56  * @author <a HREF="mailto:jima@comware.com.au">Jim Alateras</a>
57  * @author <a HREF="mailto:tma@netspace.net.au">Tim Anderson</a>
58  * @version $Revision: 1.2 $ $Date: 2005/03/18 03:36:37 $
59  */
60 class JmsTopicPublisher
61         extends JmsMessageProducer
62         implements TopicPublisher JavaDoc {
63
64     /**
65      * Construct a new <code>JmsTopicPublisher</code>.
66      *
67      * @param session the session constructing this object
68      * @param topic the publisher's destination. May be <code>null</code>.
69      */
70     public JmsTopicPublisher(JmsSession session, JmsTopic topic) {
71         super(session, topic);
72     }
73
74     /**
75      * Returns the topic associated with this publisher.
76      *
77      * @return the topic associated with this publisher, or <code>null</code> if
78      * this is an unidentified producer
79      */
80     public Topic JavaDoc getTopic() {
81         return (Topic JavaDoc) getDestination();
82     }
83
84     /**
85      * Publish a message, using the default delivery mode, priority and time to
86      * live.
87      *
88      * @param message the message to send
89      * @throws JMSException if the message can't be sent
90      */
91     public void publish(Message JavaDoc message) throws JMSException JavaDoc {
92         publish(getTopic(), message, getDeliveryMode(), getPriority(),
93                 getTimeToLive());
94     }
95
96     /**
97      * Publish a message to a topic for an unidentified message producer, using
98      * the default delivery mode, priority and time to live.
99      *
100      * @param topic the topic to publish the message to
101      * @param message the message to send
102      * @throws JMSException if the message can't be sent
103      */
104     public void publish(Topic JavaDoc topic, Message JavaDoc message) throws JMSException JavaDoc {
105         publish(topic, message, getDeliveryMode(), getPriority(),
106                 getTimeToLive());
107     }
108
109     /**
110      * Publish a message, specifying the delivery mode, priority and time to
111      * live.
112      *
113      * @param message the message to send
114      * @param deliveryMode the delivery mode to use
115      * @param priority the message priority
116      * @param timeToLive the message's lifetime (in milliseconds).
117      * @throws JMSException if the message can't be sent
118      */
119     public void publish(Message JavaDoc message, int deliveryMode, int priority,
120                         long timeToLive) throws JMSException JavaDoc {
121         publish(getTopic(), message, deliveryMode, priority, timeToLive);
122     }
123
124     /**
125      * Publish a message to a topic for an unidentified message producer,
126      * specifying the delivery mode, priority and time to live.
127      *
128      * @param topic the topic to publish the message to
129      * @param message the message to send
130      * @param deliveryMode the delivery mode to use
131      * @param priority the message priority
132      * @param timeToLive the message's lifetime (in milliseconds).
133      * @throws JMSException if the message can't be sent
134      */
135     public void publish(Topic JavaDoc topic, Message JavaDoc message, int deliveryMode,
136                         int priority, long timeToLive) throws JMSException JavaDoc {
137         send(topic, message, deliveryMode, priority, timeToLive);
138     }
139
140 }
141
Popular Tags