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: DestinationCache.java,v 1.3 2005/08/30 07:26:49 tanderson Exp $
44 */
45
46 package org.exolab.jms.messagemgr;
47
48 import org.exolab.jms.client.JmsDestination;
49 import org.exolab.jms.gc.GarbageCollectable;
50
51
52 /***
53 * A DestinationCache is used to cache messages for a particular destination.
54 * <p/>
55 * It implements {@link MessageManagerEventListener} in order to be notified of
56 * messages being added to the {@link MessageManager}.
57 * <p/>
58 * A {@link ConsumerEndpoint} registers with a {@link DestinationCache} to
59 * receive messages for a particular 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 DestinationCache extends MessageManagerEventListener,
66 GarbageCollectable {
67
68 /***
69 * Returns the destination that messages are being cached for
70 *
71 * @return the destination that messages are being cached for
72 */
73 JmsDestination getDestination();
74
75 /***
76 * Register a consumer with this cache.
77 *
78 * @param consumer the message consumer for this destination
79 * @return <code>true</code> if registered; otherwise <code>false</code>
80 */
81 boolean addConsumer(ConsumerEndpoint consumer);
82
83 /***
84 * Remove the consumer for the list of registered consumers.
85 *
86 * @param consumer the consumer to remove
87 */
88 void removeConsumer(ConsumerEndpoint consumer);
89
90 /***
91 * Determines if the cache has any consumers.
92 *
93 * @return <code>true</code> if the cache has consumers;
94 * otherwise <code>false</code>
95 */
96 boolean hasConsumers();
97
98 /***
99 * Return a message handle back to the cache, to recover unsent
100 * or unacknowledged messages.
101 *
102 * @param handle the message handle to return
103 */
104 void returnMessageHandle(MessageHandle handle);
105
106 /***
107 * Returns the number of messages in the cache.
108 *
109 * @return the number of messages in the cache
110 */
111 int getMessageCount();
112
113 /***
114 * Determines if this cache can be destroyed.
115 *
116 * @return <code>true</code> if the cache can be destroyed, otherwise
117 * <code>false</code>
118 */
119 boolean canDestroy();
120
121 /***
122 * Destroy this cache.
123 */
124 void destroy();
125
126 }