MessageRef


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.1 2005/03/18 03:58:39 tanderson Exp $
44   */
45  package org.exolab.jms.messagemgr;
46  
47  import java.sql.Connection  ;
48  import javax.jms.JMSException  ;
49  
50  import org.exolab.jms.message.MessageImpl;
51  
52  
53  /**
54   * A <code>MessageRef</code> is used to indirectly reference a message by
55   * {@link MessageHandle} instances. When there are no MessageHandles referencing
56   * the message, the message can be destroyed
57   *
58   * @author <a HREF="mailto:tma@netspace.net.au">Tim Anderson</a>
59   * @version $Revision: 1.1 $ $Date: 2005/03/18 03:58:39 $
60   */
61  public interface MessageRef {
62  
63      /**
64       * Returns the message identifier.
65       *
66       * @return the message identifier
67       */
68      String   getMessageId();
69  
70      /**
71       * Returns the message associated with this reference.
72       *
73       * @return the associated message, or <code>null</code> if the reference
74       * is no longer valide
75       * @throws JMSException for any error
76       */
77      MessageImpl getMessage() throws JMSException  ;
78  
79      /**
80       * Determines if the underlying message is persistent.
81       *
82       * @return <code>true</code> if the message is persistent; otherwise
83       * <code>false</code>
84       */
85      boolean isPersistent();
86  
87      /**
88       * Increment the reference.
89       *
90       * @throws JMSException if the handle has been destroyed
91       */
92      void reference() throws JMSException  ;
93  
94      /**
95       * Decrement the reference. If there are no references to the message,
96       * it will be destroyed.
97       *
98       * @throws JMSException for any error
99       */
100     void dereference() throws JMSException  ;
101 
102     /**
103      * Destroy the message, irrespective of the number of current references.
104      *
105      * @throws JMSException for any error
106      */
107     void destroy() throws JMSException  ;
108 
109     /**
110      * Destroy the message, irrespective of the number of current references.
111      *
112      * @param connection the database connection to use
113      * @throws JMSException for any error
114      */
115     void destroy(Connection   connection) throws JMSException  ;
116 
117 }
118
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags