KickJava   Java API By Example, From Geeks To Geeks.

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


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: CachedMessageRef.java,v 1.1 2005/03/18 03:58:39 tanderson Exp $
44  */
45 package org.exolab.jms.messagemgr;
46
47 import java.sql.Connection JavaDoc;
48 import javax.jms.JMSException JavaDoc;
49
50 import org.exolab.jms.message.MessageImpl;
51
52
53 /**
54  * An {@link MessageRef} which references messages located in an {@link
55  * DefaultMessageCache}
56  *
57  * @author <a HREF="mailto:tma@netspace.net.au">Tim Anderson</a>
58  * @version $Revision: 1.1 $ $Date: 2005/03/18 03:58:39 $
59  */
60 class CachedMessageRef extends AbstractMessageRef {
61
62     /**
63      * The cache that holds the message.
64      */
65     private final MessageCache _cache;
66
67
68     /**
69      * Construct a new <code>CachedMessageRef</code>.
70      *
71      * @param message the message to reference
72      * @param persistent if <code>true</code> the message is persistent
73      * @param cache the cache which manages the message
74      */
75     public CachedMessageRef(MessageImpl message, boolean persistent,
76                             MessageCache cache) {
77         super(message.getMessageId().getId(), persistent);
78
79         if (cache == null) {
80             throw new IllegalArgumentException JavaDoc("Argument 'cache' is null");
81         }
82         _cache = cache;
83     }
84
85     /**
86      * Construct a new <code>CachedMessageRef</code>.
87      *
88      * @param messageId the message to reference
89      * @param persistent if <code>true</code> the message is persistent
90      * @param cache the cache which manages the message
91      */
92     public CachedMessageRef(String JavaDoc messageId, boolean persistent,
93                             MessageCache cache) {
94         super(messageId, persistent);
95
96         if (cache == null) {
97             throw new IllegalArgumentException JavaDoc("Argument 'cache' is null");
98         }
99         _cache = cache;
100     }
101
102     /**
103      * Returns the message associated with this reference.
104      *
105      * @return the associated message, or <code>null</code> if the reference is
106      * no longer valide
107      * @throws JMSException for any error
108      */
109     public MessageImpl getMessage() throws JMSException JavaDoc {
110         return _cache.getMessage(this);
111     }
112
113     /**
114      * Destroy the message, irrespective of the number of current references.
115      *
116      * @throws JMSException for any error
117      */
118     public void destroy() throws JMSException JavaDoc {
119         if (!isDestroyed()) {
120             _cache.destroy(this);
121             setDestroyed();
122         }
123     }
124
125     /**
126      * Destroy the message, irrespective of the number of current references.
127      *
128      * @param connection the database connection to use
129      * @throws JMSException for any error
130      */
131     public void destroy(Connection JavaDoc connection) throws JMSException JavaDoc {
132         if (!isDestroyed()) {
133             _cache.destroy(this, connection);
134             setDestroyed();
135         }
136     }
137
138 }
139
Popular Tags