-
Notifications
You must be signed in to change notification settings - Fork 33
/
Consumer.java
386 lines (303 loc) · 11.5 KB
/
Consumer.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
/*
* Copyright (c) 2000, 2020 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2021, 2022 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package com.sun.messaging.jmq.jmsclient;
import jakarta.jms.*;
import java.io.PrintStream;
import java.util.Hashtable;
import com.sun.messaging.AdministeredObject;
/**
* A Consumer is an internal abstraction of common attributes and operations for MessageConsumerImpl and
* ConnectionConsumerImpl
*/
abstract class Consumer {
private static final String DMQ = "mq.sys.dmq";
protected String messageSelector = null;
protected ConnectionImpl connection = null;
// XXX PROTOCOL2.1
protected Long interestId = null;
protected Integer destType = null;
// protected boolean isTopic = true;
protected boolean durable = false;
protected boolean noLocal = false;
protected Destination destination = null;
private String destName = null; // for logging/error reporting only
protected String durableName = null;
protected String sharedSubscriptionName = null; // JMS2.0 non-durable
protected boolean shared = false; // JMS 2.0, Topic only
protected boolean debug = Debug.debug;
private boolean isRegistered = false;
protected boolean isClosed = false;
// XXX PROTOCOL3.5
protected int prefetchMaxMsgCount = 100;
protected int prefetchThresholdPercent = 50;
protected boolean noprefetch = false;
/**
* This is used when adding a consumer to the broker. Broker wants to know what ack mode we are. For transacted sessions
* and connection consumers, this value is not changed (-1).
*/
protected int acknowledgeMode = -1;
protected boolean isDMQConsumer = false;
Consumer(ConnectionImpl connection, Destination dest, String messageSelector,
// boolean isTopic,
boolean noLocal) throws JMSException {
if (dest == null) {
String errorString = AdministeredObject.cr.getKString(AdministeredObject.cr.X_INVALID_DESTINATION_NAME, "null");
JMSException jmse = new InvalidDestinationException(errorString, AdministeredObject.cr.X_INVALID_DESTINATION_NAME);
ExceptionHandler.throwJMSException(jmse);
}
this.messageSelector = messageSelector;
this.connection = connection;
this.destination = dest;
// this.isTopic = isTopic;
this.noLocal = noLocal;
checkConsumerCreation();
// XXX PROTOCOL3.5
this.prefetchMaxMsgCount = connection.prefetchMaxMsgCount;
this.prefetchThresholdPercent = connection.prefetchThresholdPercent;
this.noprefetch = !(connection.consumerFlowLimitPrefetch);
/**
* XXX PROTOCOL2.1 -- InterestId will be assigned in ReadChannel when it receives ADD_CONSUMER_REPLY or BROWSE packet.
*/
// interestId = connection.getNextInterestId();
if (dest instanceof Queue) {
String tmpdn = ((Queue) dest).getQueueName();
if (tmpdn.equals(DMQ)) {
isDMQConsumer = true;
}
destName = "Q:" + tmpdn;
} else if (dest instanceof Topic) {
destName = "T:" + ((Topic) dest).getTopicName();
} else {
destName = dest.toString();
}
}
Consumer(ConnectionImpl connection, Destination dest, String messageSelector) throws JMSException {
this(connection, dest, messageSelector, false);
}
Consumer(ConnectionImpl connection, Destination dest) throws JMSException {
this(connection, dest, null, false);
}
/**
* Subclass should call this method if need register this consumer's interest to broker
*
* @exception JMSException if fails to register
*/
protected void registerInterest() throws JMSException {
// The consumer flow control entry will be created by
// ReadChannel when it receives the ADD_CONSUMER_REPLY.
connection.addInterest(this);
isRegistered = true;
}
/**
* deregister this consumer's interest
*
* @exception JMSException if fails to deregister
*/
protected void deregisterInterest() throws JMSException {
connection.removeInterest(this);
// XXX PROTOCOL3.5
FlowControl fc = connection.getReadChannel().flowControl;
fc.removeConsumerFlowControl(this);
isRegistered = false;
}
/**
* If this is a temporary destination, ONLY the connection that created it can consume messages from it.
*/
protected void checkConsumerCreation() throws JMSException {
TemporaryDestination.checkTemporaryDestinationConsumerAllowed(connection, destination);
}
// protected void checkConsumerCreation() throws JMSException {
// String name = ((com.sun.messaging.Destination) destination).getName();
// String tempProtocol = null;
// if ( isTopic == true ) {
// tempProtocol = TemporaryTopicImpl.protocol;
// } else {
// tempProtocol = TemporaryQueueImpl.protocol;
// }
/**
* Temp destination may ONLY be used by the consumer to consume messages by the same connection that creates it.
*/
// XXX:BUG this really needs to be isolated into TemporaryDestination
// if ( name.startsWith(ClientConstants.TEMPORARY_DESTINATION_URI_PREFIX) ) {
// String tempDestPrefix =
// tempProtocol + connection.getClientIDOrIPAddress() + "/" +
// connection.getProtocolHandler().getLocalPort();
// if ( name.startsWith(tempDestPrefix) == false ) {
// String errorString = AdministeredObject.cr.getKString(
// AdministeredObject.cr.X_TEMP_DESTINATION_INVALID);
// throw new JMSException (errorString, AdministeredObject.cr.X_TEMP_DESTINATION_INVALID);
// }
// }
// }
/**
* consume a message
*
* @param msg the message to be consumed
*/
protected abstract void onMessage(MessageImpl msg) throws JMSException;
/**
* Return the consumer reader Id for this consumer
*
* @return the ReadQueue Id this consumer associated to
*/
// XXX PROTOCOL2.1
protected abstract Long getReadQueueId();
// XXX PROTOCOL2.1
protected Long getInterestId() {
return interestId;
}
// XXX PROTOCOL2.1
protected void setInterestId(Long id) {
interestId = id;
}
// XXX PROTOCOL2.1
protected Integer getDestType() {
return destType;
}
// XXX PROTOCOL2.1
protected void setDestType(Integer destType) {
this.destType = destType;
}
protected boolean getIsRegistered() {
return isRegistered;
}
protected void setDurable(boolean flag) {
durable = flag;
}
protected boolean getDurable() {
return durable;
}
protected void setShared(boolean flag) {
shared = flag;
}
protected boolean getShared() {
return shared;
}
// protected void setIsTopic ( boolean flag ) {
// isTopic = flag;
// }
// protected boolean getIsTopic() {
// return isTopic;
// }
protected void setNoLocal(boolean flag) {
noLocal = flag;
}
protected boolean getNoLocal() throws JMSException {
return noLocal;
}
protected void setMessageSelector(String selector) throws JMSException {
messageSelector = selector;
}
protected Destination getDestination() {
return destination;
}
protected String getDestName() {
return destName;
}
protected void setDurableName(String name) {
durableName = name;
}
protected String getDurableName() {
return durableName;
}
protected void setSharedSubscriptionName(String name) {
sharedSubscriptionName = name;
}
protected String getSharedSubscriptionName() {
return sharedSubscriptionName;
}
protected ConnectionImpl getConnection() {
return connection;
}
/**
* Get this message consumer's message selector expression.
*
* @return this message consumer's message selector
*
* @exception JMSException if JMS fails to get message selector due to some JMS error
*/
public String getMessageSelector() throws JMSException {
checkState();
return messageSelector;
}
protected void checkState() throws JMSException {
if (isClosed) {
String errorString = AdministeredObject.cr.getKString(AdministeredObject.cr.X_CONSUMER_CLOSED);
JMSException jmse = new com.sun.messaging.jms.IllegalStateException(errorString, AdministeredObject.cr.X_CONSUMER_CLOSED);
ExceptionHandler.throwJMSException(jmse);
}
}
// XXX PROTOCOL3.5
public void setPrefetchMaxMsgCount(int prefetchMaxMsgCount) {
this.prefetchMaxMsgCount = prefetchMaxMsgCount;
}
// XXX PROTOCOL3.5
public int getPrefetchMaxMsgCount() {
return prefetchMaxMsgCount;
}
// XXX PROTOCOL3.5
public void setPrefetchThresholdPercent(int prefetchThresholdPercent) {
this.prefetchThresholdPercent = prefetchThresholdPercent;
}
// XXX PROTOCOL3.5
public int getPrefetchThresholdPercent() {
return prefetchThresholdPercent;
}
/*
* protected SessionImpl getSession() throws JMSException { return null; }
*/
protected void dump(PrintStream ps) {
ps.println("Interest ID: " + interestId);
// ps.println ("isTopic: " + isTopic);
ps.println("is durable: " + durable);
if (durable) {
ps.println("durableName: " + durableName);
}
if (sharedSubscriptionName != null) {
ps.println("sharedSubscriptionName: " + sharedSubscriptionName);
}
ps.println("is registered: " + isRegistered);
ps.println("destination: " + destination);
}
protected Hashtable getDebugState(boolean verbose) {
Hashtable ht = new Hashtable();
ht.put("consumerID", String.valueOf(interestId));
ht.put("noLocal", String.valueOf(noLocal));
ht.put("Destination Class", destination.getClass().getName());
if (destination instanceof com.sun.messaging.Destination) {
ht.put("Destination", ((com.sun.messaging.Destination) destination).getName());
}
if (messageSelector != null) {
ht.put("selector", String.valueOf(messageSelector));
}
ht.put("durable", String.valueOf(durable));
if (durable) {
ht.put("durableName", String.valueOf(durableName));
}
if (sharedSubscriptionName != null) {
ht.put("sharedSubscriptionName", String.valueOf(sharedSubscriptionName));
}
ht.put("isRegistered", String.valueOf(isRegistered));
ht.put("isClosed", String.valueOf(isClosed));
ht.put("FlowControl", connection.getReadChannel().flowControl.getDebugState(this));
return ht;
}
@Override
public String toString() {
return "ConsumerID: " + interestId + ", ConnectionID=" + connection.getConnectionID();
}
}