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 2002 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   * $Id: Subscription.java,v 1.1 2005/09/04 07:07:12 tanderson Exp $
44   */
45  
46  package org.exolab.jms.tools.migration.proxy;
47  
48  import java.util.ArrayList;
49  import java.util.List;
50  
51  import org.exolab.jms.client.JmsDestination;
52  
53  
54  /***
55   * Maintains the state of a consumer's subcription to a single destination.
56   *
57   * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
58   * @version $Revision: 1.1 $ $Date: 2005/09/04 07:07:12 $
59   */
60  public class Subscription {
61  
62      /***
63       * A list of {@link MessageState} instances.
64       */
65      private ArrayList _messages = new ArrayList();
66  
67      /***
68       * The destination that messages are being consumed from.
69       */
70      private JmsDestination _destination;
71  
72  
73      /***
74       * Construct a new <code>Subscription</code>
75       *
76       * @param destination the destination being subscribed to
77       */
78      public Subscription(JmsDestination destination) {
79          _destination = destination;
80      }
81  
82      /***
83       * Returns the destination being subscribed to.
84       *
85       * @return the destination
86       */
87      public JmsDestination getDestination() {
88          return _destination;
89      }
90  
91      /***
92       * Add a reference to a message.
93       *
94       * @param messageId the message identifier
95       * @param delivered determines if the message has been delivered or not
96       */
97      public void addMessage(String messageId, boolean delivered) {
98          _messages.add(new MessageState(messageId, delivered));
99      }
100 
101     /***
102      * Returns the messages that the subscription references.
103      *
104      * @return a list of {@link MessageState} instances
105      */
106     public List getMessages() {
107         return _messages;
108     }
109 
110 }