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 1999 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: InternalMessageListener.java,v 1.4 2003/08/07 13:33:03 tanderson Exp $
44 *
45 * Date Author Changes
46 * 09/12/2001 jima Created
47 */
48 package org.exolab.jms.messagemgr;
49
50 import java.util.Vector;
51
52 import org.exolab.jms.message.MessageHandle;
53
54
55 /***
56 * This is the server side implementation of a message listener
57 *
58 * @version $Revision: 1.4 $ $Date: 2003/08/07 13:33:03 $
59 * @author <a href="mailto:jima@exoffice.com">Jim Alateras</a>
60 **/
61 public interface InternalMessageListener {
62
63 /***
64 * Send the specified message to the client. If the ack paramter
65 * is set then comply to the acking policy of the session. If this
66 * parameter is not set then ignore the acking policy. The later
67 * mode is used by the queue browser, when it sends messages
68 *
69 * @param message - message handle
70 * @param ack - false ignores the acking policy
71 * @throws Exception - propagate exceptions to client
72 */
73 public void onMessage(MessageHandle message, boolean ack)
74 throws Exception;
75
76 /***
77 * Send the specified collection of messages to the client
78 *
79 * @param messages - collection of MessageHandle objects
80 * @throws Exception - propagate exceptions to client
81 */
82 public void onMessages(Vector messages)
83 throws Exception;
84
85 /***
86 * Inform the session that there is a message available
87 * for the message consumer with the specified identity
88 *
89 * @param clientId - the identity of the client
90 */
91 public void onMessageAvailable(long clientId)
92 throws Exception;
93 }
94
This page was automatically generated by Maven