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 2001-2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: MessageManagerEventListener.java,v 1.3 2005/08/30 07:26:49 tanderson Exp $
44 */
45 package org.exolab.jms.messagemgr;
46
47 import javax.jms.JMSException;
48
49 import org.exolab.jms.client.JmsDestination;
50 import org.exolab.jms.message.MessageImpl;
51 import org.exolab.jms.persistence.PersistenceException;
52
53
54 /***
55 * A MessageManagerEventListener responds to events generated by the {@link
56 * MessageMgr}.
57 * <p/>
58 * It gets notified when a message is added or removed for a particular
59 * destination.
60 *
61 * @author <a href="mailto:jima@comware.com.au">Jim Alateras</a>
62 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
63 * @version $Revision: 1.3 $ $Date: 2005/08/30 07:26:49 $
64 */
65 public interface MessageManagerEventListener {
66
67 /***
68 * Invoked when the {@link MessageManager} receives a non-persistent
69 * message.
70 *
71 * @param destination the message's destination
72 * @param message the message
73 * @throws JMSException if the listener fails to handle the message
74 */
75 void messageAdded(JmsDestination destination, MessageImpl message)
76 throws JMSException;
77
78 /***
79 * Invoked when the {@link MessageManager} receives a persistent message.
80 *
81 * @param destination the message's destination
82 * @param message the message
83 * @throws JMSException if the listener fails to handle the message
84 * @throws PersistenceException if there is a persistence related problem
85 */
86 void persistentMessageAdded(JmsDestination destination,
87 MessageImpl message)
88 throws JMSException, PersistenceException;
89
90 }