KickJava   Java API By Example, From Geeks To Geeks.

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


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 2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42  *
43  * $Id: TopicConsumerMessageHandle.java,v 1.2 2005/05/13 12:57:02 tanderson Exp $
44  */
45 package org.exolab.jms.messagemgr;
46
47 import javax.jms.JMSException JavaDoc;
48 import javax.jms.MessageConsumer JavaDoc;
49
50
51 /**
52  * A {@link MessageHandle} used by the {@link TopicDestinationCache}.
53  *
54  * @author <a HREF="mailto:tma@netspace.net.au">Tim Anderson</a>
55  * @version $Revision: 1.2 $ $Date: 2005/05/13 12:57:02 $
56  */
57 class TopicConsumerMessageHandle extends AbstractConsumerMessageHandle {
58
59     /**
60      * If <code>true</code>, indicates that the message associated with the
61      * handle has been delivered, but not acknowledged.
62      * This overrides the delivery status of the underlying handle, which
63      * may be shared between multiple consumers.
64      */
65     private boolean _delivered = false;
66
67
68     /**
69      * Construct a new <code>TopicConsumerMessageHandle</code>.
70      *
71      * @param handle the underlying handle
72      * @param consumer the consumer of the handle
73      * @throws JMSException if the underlying message can't be referenced
74      */
75     public TopicConsumerMessageHandle(MessageHandle handle,
76                                       ConsumerEndpoint consumer)
77             throws JMSException JavaDoc {
78         super(handle, consumer);
79         init(handle);
80     }
81
82     /**
83      * Construct a new <code>TopicConsumerMessageHandle</code>
84      * for a durable consumer.
85      *
86      * @param handle the underlying handle
87      * @param persistentId the persistent identity of the consumer
88      * @throws JMSException if the underlying message can't be referenced
89      */
90     public TopicConsumerMessageHandle(MessageHandle handle, String JavaDoc persistentId)
91             throws JMSException JavaDoc {
92         super(handle, persistentId);
93         init(handle);
94     }
95
96     /**
97      * Indicates if a message has been delivered to a {@link MessageConsumer},
98      * but not acknowledged.
99      *
100      * @param delivered if <code>true</code> indicates that an attempt has been
101      * made to deliver the message
102      */
103     public void setDelivered(boolean delivered) {
104         _delivered = delivered;
105     }
106
107     /**
108      * Returns if an attempt has already been made to deliver the message.
109      *
110      * @return <code>true</code> if delivery has been attempted
111      */
112     public boolean getDelivered() {
113         return _delivered;
114     }
115
116     /**
117      * Initialise this handle.
118      *
119      * @param handle the underlying handle
120      */
121     private void init(MessageHandle handle) {
122         _delivered = handle.getDelivered();
123     }
124
125 }
126
Popular Tags