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: Consumer.java,v 1.2 2005/10/20 14:07:03 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.JmsQueue;
52
53
54 /***
55 * Manages the state of an individual consumer.
56 *
57 * @author <a href="mailto:tma@nespace.net.au">Tim Anderson</a>
58 * @version $Revision: 1.2 $ $Date: 2005/10/20 14:07:03 $
59 */
60 public class Consumer {
61
62 /***
63 * The consumer name.
64 */
65 private final String _name;
66
67 /***
68 * The client identifier.
69 */
70 private final String _clientId;
71
72 /***
73 * Determines if this is a queue consumer.
74 */
75 private final boolean _queueConsumer;
76
77 /***
78 * A list of the consumer's {@link Subscription}s.
79 */
80 private ArrayList _subscriptions = new ArrayList();
81
82
83 /***
84 * Construct a new <code>Consumer</code> for a queue.
85 *
86 * @param queue the queue
87 */
88 public Consumer(JmsQueue queue) {
89 this(queue.getName(), null, true);
90 }
91
92 /***
93 * Construct a new <code>Consumer</code> for one or more topics.
94 *
95 * @param name the name of the consumer
96 * @param clientId the client identifier. May be <code>null</code>
97 */
98 public Consumer(String name, String clientId) {
99 this(name, clientId, false);
100 }
101
102 /***
103 * Construct a new <code>Consumer</code>.
104 *
105 * @param name the name of the consumer
106 * @param clientId the client identifier. May be <code>null</code>
107 * @param queueConsumer determines if this is a queue consumer
108 */
109 private Consumer(String name, String clientId, boolean queueConsumer) {
110 _name = name;
111 _clientId = clientId;
112 _queueConsumer = queueConsumer;
113 }
114
115 /***
116 * Returns the consumer name. If this is a queue consumer, the name is
117 * the same as the queue being consumed.
118 *
119 * @return the name of the consumer
120 */
121 public String getName() {
122 return _name;
123 }
124
125 /***
126 * Returns the client identifier. If the consumer represents a queue,
127 * then the client identifier is always <code>null</code>.
128 *
129 * @return the client identifier. May be <code>null</code>
130 */
131 public String getClientID() {
132 return _clientId;
133 }
134
135 /***
136 * Determines if this is a queue consumer.
137 *
138 * @return <code>true</code> if this is a queue consumer; otherwise
139 * <code>false</code>
140 */
141 public boolean isQueueConsumer() {
142 return _queueConsumer;
143 }
144
145 /***
146 * Add a subscription.
147 *
148 * @param subscription the subscription
149 */
150 public void addSubscription(Subscription subscription) {
151 if (_queueConsumer) {
152 if (!_subscriptions.isEmpty()) {
153 throw new IllegalStateException(
154 "Consumer cannot have multiple subscriptions");
155 }
156 if (!subscription.getDestination().getName().equals(_name)) {
157 throw new IllegalStateException(
158 "Queue consumer subscription mismatch");
159 }
160 }
161 _subscriptions.add(subscription);
162 }
163
164 /***
165 * Returns the subscriptions.
166 *
167 * @return a list of {@link Subscription} instances
168 */
169 public List getSubscriptions() {
170 return _subscriptions;
171 }
172
173 }