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: MessageRef.java,v 1.2 2005/08/30 07:26:49 tanderson Exp $
44 */
45 package org.exolab.jms.messagemgr;
46
47 import javax.jms.JMSException;
48
49 import org.exolab.jms.message.MessageImpl;
50
51
52 /***
53 * A <code>MessageRef</code> is used to indirectly reference a message by {@link
54 * MessageHandle} instances. When there are no MessageHandles referencing the
55 * message, the message can be destroyed
56 *
57 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
58 * @version $Revision: 1.2 $ $Date: 2005/08/30 07:26:49 $
59 */
60 public interface MessageRef {
61
62 /***
63 * Returns the message identifier.
64 *
65 * @return the message identifier
66 */
67 String getMessageId();
68
69 /***
70 * Returns the message associated with this reference.
71 *
72 * @return the associated message, or <code>null</code> if the reference is
73 * no longer valide
74 * @throws JMSException for any error
75 */
76 MessageImpl getMessage() throws JMSException;
77
78 /***
79 * Determines if the underlying message is persistent.
80 *
81 * @return <code>true</code> if the message is persistent; otherwise
82 * <code>false</code>
83 */
84 boolean isPersistent();
85
86 /***
87 * Increment the reference.
88 *
89 * @throws JMSException if the handle has been destroyed
90 */
91 void reference() throws JMSException;
92
93 /***
94 * Decrement the reference. If there are no references to the message, it
95 * will be destroyed.
96 *
97 * @throws JMSException for any error
98 */
99 void dereference() throws JMSException;
100
101 /***
102 * Destroy the message, irrespective of the number of current references.
103 *
104 * @throws JMSException for any error
105 */
106 void destroy() throws JMSException;
107
108 }