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 tma@netspace.net.au.
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 2001, 2003 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: MessageSender.java,v 1.5 2004/02/03 21:52:06 tanderson Exp $
44 */
45 package org.exolab.jmscts.core;
46
47 import javax.jms.Destination;
48 import javax.jms.JMSException;
49 import javax.jms.Message;
50
51
52 /***
53 * Interface for sending messages using a {@link javax.jms.MessageProducer}
54 *
55 * @version $Revision: 1.5 $ $Date: 2004/02/03 21:52:06 $
56 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
57 */
58 public interface MessageSender {
59
60 /***
61 * Send messages to a destination
62 *
63 * @param message the message to send
64 * @param count the number of times to send the message
65 * @throws JMSException if any of the JMS operations fail
66 */
67 void send(Message message, int count) throws JMSException;
68
69 /***
70 * Send messages to a destination
71 *
72 * @param message the message to send
73 * @param count the number of times to send the message
74 * @param timeToLive the message time-to-live
75 * @throws JMSException if any of the JMS operations fail
76 */
77 void send(Message message, int count, long timeToLive) throws JMSException;
78
79 /***
80 * Send messages to a destination, invoking a message populator prior
81 * to each message being sent
82 *
83 * @param message the message to send
84 * @param count the number of times to send the message
85 * @param populator the message populator
86 * @throws JMSException if any of the JMS operations fail
87 */
88 void send(Message message, int count, MessagePopulator populator)
89 throws JMSException;
90
91 /***
92 * Send messages to a destination, invoking a message populator prior
93 * to each message being sent
94 *
95 * @param message the message to send
96 * @param count the number of times to send the message
97 * @param populator the message populator
98 * @param timeToLive the message time-to-live
99 * @throws JMSException if any of the JMS operations fail
100 */
101 void send(Message message, int count, MessagePopulator populator,
102 long timeToLive) throws JMSException;
103
104 /***
105 * Return the destination associated with the MessageProducer
106 *
107 * @return the destination to send messages to
108 * @throws JMSException if the operation fails
109 */
110 Destination getDestination() throws JMSException;
111
112 /***
113 * Close the underlying MessageProducer
114 *
115 * @throws JMSException if the operation fails
116 */
117 void close() throws JMSException;
118
119 } //-- MessageSender
This page was automatically generated by Maven