View Javadoc

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: MessageState.java,v 1.1 2005/09/04 07:07:12 tanderson Exp $
44   */
45  package org.exolab.jms.tools.migration.proxy;
46  
47  
48  /***
49   * Manages the delivery state of a message for a particular consumer.
50   *
51   * @author <a href="mailto:tma@nespace.net.au">Tim Anderson</a>
52   * @version $Revision: 1.1 $ $Date: 2005/09/04 07:07:12 $
53   * @see Subscription
54   */
55  public class MessageState {
56  
57      /***
58       * The message identifier.
59       */
60      private String _messageId;
61  
62      /***
63       * Determines if the message has been delivered to the consumer.
64       */
65      private boolean _delivered;
66  
67      /***
68       * Construct a new <code>MessageState</code>.
69       *
70       * @param messageId the message identifier
71       * @param delivered <code>true</code> if the message has been delivered,
72       *                  otherwise <code>false</code>
73       */
74      public MessageState(String messageId, boolean delivered) {
75          _messageId = messageId;
76          _delivered = delivered;
77      }
78  
79      /***
80       * Returns the message identifier.
81       *
82       * @return the message identifier
83       */
84      public String getMessageId() {
85          return _messageId;
86      }
87  
88      /***
89       * Returns the message delivery status.
90       *
91       * @return <code>true</code> if the message has been delivered to the
92       *         consumer, otherwise <code>false</code>
93       */
94      public boolean getDelivered() {
95          return _delivered;
96      }
97  
98  }
99