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: DestinationCacheEventListener.java,v 1.4 2003/08/17 01:32:24 tanderson Exp $
44 *
45 * Date Author Changes
46 * 3/1/2001 jima Created
47 */
48 package org.exolab.jms.messagemgr;
49
50 import java.sql.Connection;
51
52 import org.exolab.jms.message.MessageImpl;
53 import org.exolab.jms.persistence.PersistenceException;
54
55
56 /***
57 * A DestinationCacheEventListener responds to events generated by a
58 * {@link DestinationCache}.
59 * It gets notified when a message is added or removed for a particular
60 * destination.
61 *
62 * @version $Revision: 1.4 $ $Date: 2003/08/17 01:32:24 $
63 * @author <a href="mailto:jima@exoffice.com">Jim Alateras</a>
64 */
65 public interface DestinationCacheEventListener {
66
67 /***
68 * This event is called when a non-persistent message is added to the
69 * DestinationCache.
70 *
71 * @param message - message added to cache
72 */
73 public boolean messageAdded(MessageImpl message);
74
75 /***
76 * This event is called when a message is removed from the DestinationCache.
77 *
78 * @param message - message removed from cache
79 */
80 public boolean messageRemoved(MessageImpl message);
81
82 /***
83 * This event is called when a persistent message is added to the
84 * DestinationCache.
85 *
86 * @param connection - the database connection
87 * @param message - message added to cache
88 * @throws PersistenceException - if there is a persistence related problem
89 */
90 public boolean persistentMessageAdded(Connection connection,
91 MessageImpl message)
92 throws PersistenceException;
93
94 /***
95 * This event is called when a message is removed from the
96 * DestinationCache.
97 *
98 * @param connection - the database connection
99 * @param message - message to remove from cache
100 * @throws PersistenceException - if there is a persistence related problem
101 */
102 public boolean persistentMessageRemoved(Connection connection,
103 MessageImpl message)
104 throws PersistenceException;
105 }
106