KickJava   Java API By Example, From Geeks To Geeks.

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


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.2 2005/03/18 03:58:39 tanderson Exp $
44  */
45
46 package org.exolab.jms.messagemgr;
47
48 import javax.jms.JMSException JavaDoc;
49
50 import org.exolab.jms.client.JmsDestination;
51 import org.exolab.jms.gc.GarbageCollectable;
52 import org.exolab.jms.message.MessageImpl;
53
54
55 /**
56  * A DestinationCache is used to cache messages for a particular destination.
57  * <p/>
58  * It implements {@link MessageManagerEventListener} in order to be notified of
59  * messages being added to the {@link MessageMgr}.
60  * <p/>
61  * A {@link ConsumerEndpoint} registers with a {@link DestinationCache} to
62  * receive messages for a particular destination.
63  *
64  * @author <a HREF="mailto:jima@comware.com.au">Jim Alateras</a>
65  * @author <a HREF="mailto:tma@netspace.net.au">Tim Anderson</a>
66  * @version $Revision: 1.2 $ $Date: 2005/03/18 03:58:39 $
67  */
68 public interface DestinationCache extends MessageManagerEventListener,
69         GarbageCollectable {
70
71     /**
72      * Returns the destination that messages are being cached for
73      *
74      * @return the destination that messages are being cached for
75      */
76     JmsDestination getDestination();
77
78     /**
79      * Register a consumer with this cache
80      *
81      * @param consumer the message consumer for this destination
82      * @return <code>true</code> if registered; otherwise <code>false</code>
83      */
84     boolean addConsumer(ConsumerEndpoint consumer);
85
86     /**
87      * Remove the consumer for the list of registered consumers
88      *
89      * @param consumer the consumer to remove
90      */
91     void removeConsumer(ConsumerEndpoint consumer);
92
93     /**
94      * Return a message handle back to the cache, to recover unsent
95      * or unacknowledged messages
96      *
97      * @param handle the message handle to return
98      */
99     void returnMessageHandle(MessageHandle handle);
100
101     /**
102      * Returns the number of messages in the cache
103      *
104      * @return the number of messages in the cache
105      */
106     int getMessageCount();
107
108     /**
109      * Determines if this cache can be destroyed
110      *
111      * @return <code>true</code> if the cache can be destroyed, otherwise
112      * <code>false</code>
113      */
114     boolean canDestroy();
115
116     /**
117      * Destroy this cache
118      */
119     void destroy();
120
121 }
122
Popular Tags