KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > exolab > jms > messagemgr > DestinationCacheEventListener


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: DestinationCacheEventListener.java,v 1.2 2005/03/18 03:58:39 tanderson Exp $
44  */

45
46 package org.exolab.jms.messagemgr;
47
48 import java.sql.Connection JavaDoc;
49 import javax.jms.JMSException JavaDoc;
50
51 import org.exolab.jms.message.MessageImpl;
52 import org.exolab.jms.persistence.PersistenceException;
53
54
55 /**
56  * A DestinationCacheEventListener responds to events generated by a {@link
57  * DestinationCache}. It gets notified when a message is added or removed for a
58  * particular destination.
59  *
60  * @author <a HREF="mailto:jima@comware.com.au">Jim Alateras</a>
61  * @author <a HREF="mailto:tma@netspace.net.au">Tim Anderson</a>
62  * @version $Revision: 1.2 $ $Date: 2005/03/18 03:58:39 $
63  */

64 interface DestinationCacheEventListener {
65
66     /**
67      * This event is called when a non-persistent message is added to a
68      * <code>DestinationCache</code>.
69      *
70      * @param handle a handle to the added message
71      * @param message the added message
72      * @return <code>true</code> if the listener accepted the message; otherwise
73      * <code>false</ode>
74      * @throws JMSException if the listener fails to handle the message
75      */

76     boolean messageAdded(MessageHandle handle, MessageImpl message)
77             throws JMSException JavaDoc;
78
79     /**
80      * This event is called when a message is removed from the
81      * <code>DestinationCache</code>.
82      *
83      * @param messageId the identifier of the removed message
84      * @throws JMSException if the listener fails to handle the message
85      */

86     void messageRemoved(String JavaDoc messageId) throws JMSException JavaDoc;
87
88     /**
89      * This event is called when a persistent message is added to the
90      * <code>DestinationCache</code>.
91      *
92      * @param handle a handle to the added message
93      * @param message the added message
94      * @param connection the database connection
95      * @return <code>true</code> if the listener accepted the message;
96      * @throws JMSException if the listener fails to handle the message
97      * @throws PersistenceException if there is a persistence related problem
98      */

99     boolean persistentMessageAdded(MessageHandle handle, MessageImpl message,
100                                    Connection JavaDoc connection)
101             throws JMSException JavaDoc, PersistenceException;
102
103     /**
104      * This event is called when a message is removed from the
105      * <code>DestinationCache</code>.
106      *
107      * @param messageId the identifier of the removed message
108      * @param connection the database connection
109      * @throws JMSException if the listener fails to handle the message
110      * @throws PersistenceException if there is a persistence related problem
111      */

112     void persistentMessageRemoved(String JavaDoc messageId, Connection JavaDoc connection)
113             throws JMSException JavaDoc, PersistenceException;
114 }
115
116
Popular Tags