-
Notifications
You must be signed in to change notification settings - Fork 150
/
JmsConnectionFactory.java
1110 lines (965 loc) · 40.1 KB
/
JmsConnectionFactory.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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.qpid.jms;
import java.net.URI;
import java.net.URISyntaxException;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.EnumMap;
import java.util.Map;
import java.util.function.BiFunction;
import javax.jms.Connection;
import javax.jms.ConnectionFactory;
import javax.jms.ExceptionListener;
import javax.jms.JMSContext;
import javax.jms.JMSException;
import javax.jms.MessageListener;
import javax.jms.QueueConnection;
import javax.jms.QueueConnectionFactory;
import javax.jms.TopicConnection;
import javax.jms.TopicConnectionFactory;
import javax.net.ssl.SSLContext;
import org.apache.qpid.jms.exceptions.JmsExceptionSupport;
import org.apache.qpid.jms.jndi.JNDIStorable;
import org.apache.qpid.jms.meta.JmsConnectionId;
import org.apache.qpid.jms.meta.JmsConnectionInfo;
import org.apache.qpid.jms.policy.JmsDefaultDeserializationPolicy;
import org.apache.qpid.jms.policy.JmsDefaultMessageIDPolicy;
import org.apache.qpid.jms.policy.JmsDefaultPrefetchPolicy;
import org.apache.qpid.jms.policy.JmsDefaultPresettlePolicy;
import org.apache.qpid.jms.policy.JmsDefaultRedeliveryPolicy;
import org.apache.qpid.jms.policy.JmsDeserializationPolicy;
import org.apache.qpid.jms.policy.JmsMessageIDPolicy;
import org.apache.qpid.jms.policy.JmsPrefetchPolicy;
import org.apache.qpid.jms.policy.JmsPresettlePolicy;
import org.apache.qpid.jms.policy.JmsRedeliveryPolicy;
import org.apache.qpid.jms.provider.Provider;
import org.apache.qpid.jms.provider.ProviderFactory;
import org.apache.qpid.jms.tracing.JmsNoOpTracer;
import org.apache.qpid.jms.tracing.JmsTracer;
import org.apache.qpid.jms.tracing.JmsTracerFactory;
import org.apache.qpid.jms.util.IdGenerator;
import org.apache.qpid.jms.util.PropertyUtil;
import org.apache.qpid.jms.util.URISupport;
import org.apache.qpid.jms.util.URISupport.CompositeData;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* JMS ConnectionFactory Implementation.
*/
public class JmsConnectionFactory extends JNDIStorable implements ConnectionFactory, QueueConnectionFactory, TopicConnectionFactory {
private static final Logger LOG = LoggerFactory.getLogger(JmsConnectionFactory.class);
private static final String CLIENT_ID_PROP = "clientID";
private static final String DEFAULT_REMOTE_HOST = "localhost";
private static final String DEFAULT_REMOTE_PORT = "5672";
public static final String REMOTE_URI_PROP = "remoteURI";
private static String DEFAULT_REMOTE_URI;
private final EnumMap<JmsConnectionExtensions, BiFunction<Connection, URI, Object>> extensionMap = new EnumMap<>(JmsConnectionExtensions.class);
private URI remoteURI;
private String username;
private String password;
private String clientID;
private boolean forceAsyncSend;
private boolean forceSyncSend;
private boolean forceAsyncAcks;
private boolean localMessagePriority;
private boolean localMessageExpiry = true;
private boolean receiveLocalOnly;
private boolean receiveNoWaitLocalOnly;
private boolean populateJMSXUserID;
private boolean closeLinksThatFailOnReconnect;
private String queuePrefix = null;
private String topicPrefix = null;
private boolean validatePropertyNames = true;
private boolean validateSelector = true;
private boolean awaitClientID = true;
private boolean useDaemonThread = false;
private long sendTimeout = JmsConnectionInfo.DEFAULT_SEND_TIMEOUT;
private long requestTimeout = JmsConnectionInfo.DEFAULT_REQUEST_TIMEOUT;
private long closeTimeout = JmsConnectionInfo.DEFAULT_CLOSE_TIMEOUT;
private long connectTimeout = JmsConnectionInfo.DEFAULT_CONNECT_TIMEOUT;
private IdGenerator clientIdGenerator;
private String clientIDPrefix;
private IdGenerator connectionIdGenerator;
private String connectionIDPrefix;
private ExceptionListener exceptionListener;
private String tracing;
private JmsTracer tracer;
private JmsPrefetchPolicy prefetchPolicy = new JmsDefaultPrefetchPolicy();
private JmsRedeliveryPolicy redeliveryPolicy = new JmsDefaultRedeliveryPolicy();
private JmsPresettlePolicy presettlePolicy = new JmsDefaultPresettlePolicy();
private JmsMessageIDPolicy messageIDPolicy = new JmsDefaultMessageIDPolicy();
private JmsDeserializationPolicy deserializationPolicy = new JmsDefaultDeserializationPolicy();
public JmsConnectionFactory() {
}
public JmsConnectionFactory(String username, String password) {
setUsername(username);
setPassword(password);
}
public JmsConnectionFactory(String remoteURI) {
setRemoteURI(remoteURI);
}
public JmsConnectionFactory(String userName, String password, String remoteURI) {
setUsername(userName);
setPassword(password);
setRemoteURI(remoteURI);
}
public JmsConnectionFactory(URI remoteURI) {
setRemoteURI(remoteURI == null ? null : remoteURI.toString());
}
public JmsConnectionFactory(String userName, String password, URI remoteURI) {
setUsername(userName);
setPassword(password);
setRemoteURI(remoteURI == null ? null : remoteURI.toString());
}
@Override
protected Map<String, String> buildFromProperties(Map<String, String> props) {
// Apply the remoteURI in a consistent order before
// any other properties, since as it may contain
// some options within it.
String remoteURI = props.remove(REMOTE_URI_PROP);
if (remoteURI != null) {
setRemoteURI(remoteURI);
}
return PropertyUtil.setProperties(this, props);
}
@Override
protected void populateProperties(Map<String, String> props) {
try {
Map<String, String> result = PropertyUtil.getProperties(this);
props.putAll(result);
} catch (Exception e) {
e.printStackTrace();
}
}
@Override
public TopicConnection createTopicConnection() throws JMSException {
return createTopicConnection(getUsername(), getPassword());
}
@Override
public TopicConnection createTopicConnection(String username, String password) throws JMSException {
JmsTopicConnection connection = null;
try {
JmsConnectionInfo connectionInfo = configureConnectionInfo(username, password);
Provider provider = createProvider(remoteURI);
connection = new JmsTopicConnection(connectionInfo, provider);
connection.setExceptionListener(exceptionListener);
connection.connect();
} catch (Exception e) {
if (connection != null) {
try {
connection.close();
} catch (Throwable ignored) {}
}
throw JmsExceptionSupport.create(e);
}
return connection;
}
@Override
public Connection createConnection() throws JMSException {
return createConnection(getUsername(), getPassword());
}
@Override
public Connection createConnection(String username, String password) throws JMSException {
JmsConnection connection = null;
try {
JmsConnectionInfo connectionInfo = configureConnectionInfo(username, password);
Provider provider = createProvider(remoteURI);
connection = new JmsConnection(connectionInfo, provider);
connection.setExceptionListener(exceptionListener);
connection.connect();
} catch (Exception e) {
if (connection != null) {
try {
connection.close();
} catch (Throwable ignored) {}
}
throw JmsExceptionSupport.create(e);
}
return connection;
}
@Override
public QueueConnection createQueueConnection() throws JMSException {
return createQueueConnection(getUsername(), getPassword());
}
@Override
public QueueConnection createQueueConnection(String username, String password) throws JMSException {
JmsQueueConnection connection = null;
try {
JmsConnectionInfo connectionInfo = configureConnectionInfo(username, password);
Provider provider = createProvider(remoteURI);
connection = new JmsQueueConnection(connectionInfo, provider);
connection.setExceptionListener(exceptionListener);
connection.connect();
} catch (Exception e) {
if (connection != null) {
try {
connection.close();
} catch (Throwable ignored) {}
}
throw JmsExceptionSupport.create(e);
}
return connection;
}
protected JmsConnectionInfo configureConnectionInfo(String username, String password) throws JMSException {
JmsTracer implicitTracer = JmsNoOpTracer.INSTANCE;
try {
Map<String, String> properties = PropertyUtil.getProperties(this);
// Pull out the clientID prop, we need to act differently according to
// whether it was set in the URI or not.
boolean userSpecifiedClientId = false;
if (properties.containsKey(CLIENT_ID_PROP)) {
userSpecifiedClientId = true;
properties.remove(CLIENT_ID_PROP);
}
String connectionId = getConnectionIdGenerator().generateId();
// Copy the configured policies before applying URI options that
// might make additional configuration changes.
JmsConnectionInfo connectionInfo = new JmsConnectionInfo(new JmsConnectionId(connectionId));
connectionInfo.setMessageIDPolicy(messageIDPolicy.copy());
connectionInfo.setPrefetchPolicy(prefetchPolicy.copy());
connectionInfo.setPresettlePolicy(presettlePolicy.copy());
connectionInfo.setRedeliveryPolicy(redeliveryPolicy.copy());
connectionInfo.setDeserializationPolicy(deserializationPolicy.copy());
connectionInfo.getExtensionMap().putAll(extensionMap);
if(tracer != null) {
connectionInfo.setTracer(tracer);
} else if(tracing != null) {
implicitTracer = JmsTracerFactory.create(remoteURI, tracing);
connectionInfo.setTracer(implicitTracer);
}
// Set properties to make additional configuration changes
PropertyUtil.setProperties(connectionInfo, properties);
// Ensure we use the user and pass provided for this particular connection
connectionInfo.setUsername(username);
connectionInfo.setPassword(password);
connectionInfo.setConfiguredURI(remoteURI);
// Set the ClientID/container-id details
if (userSpecifiedClientId) {
connectionInfo.setClientId(clientID, true);
} else {
connectionInfo.setClientId(getClientIdGenerator().generateId(), false);
}
return connectionInfo;
} catch (Exception e) {
try {
implicitTracer.close();
} catch (Throwable ignored) {}
throw JmsExceptionSupport.create(e);
}
}
//----- JMSContext Creation methods --------------------------------------//
@Override
public JMSContext createContext() {
return createContext(getUsername(), getPassword(), JMSContext.AUTO_ACKNOWLEDGE);
}
@Override
public JMSContext createContext(int sessionMode) {
return createContext(getUsername(), getPassword(), sessionMode);
}
@Override
public JMSContext createContext(String username, String password) {
return createContext(username, password, JMSContext.AUTO_ACKNOWLEDGE);
}
@Override
public JMSContext createContext(String username, String password, int sessionMode) {
JmsSession.validateSessionMode(sessionMode);
try {
JmsConnection connection = (JmsConnection) createConnection(username, password);
return new JmsContext(connection, sessionMode);
} catch (JMSException jmse) {
throw JmsExceptionSupport.createRuntimeException(jmse);
}
}
//----- Internal Support Methods -----------------------------------------//
protected Provider createProvider(URI remoteURI) throws Exception {
if (remoteURI == null) {
remoteURI = new URI(getDefaultRemoteAddress());
}
Provider result = null;
try {
result = ProviderFactory.create(remoteURI);
} catch (Exception ex) {
LOG.error("Failed to create JMS Provider instance for: {}", remoteURI.getScheme());
LOG.trace("Error: ", ex);
throw ex;
}
return result;
}
protected static URI createURI(String name) {
if (name != null && name.trim().isEmpty() == false) {
try {
return new URI(name);
} catch (URISyntaxException e) {
throw (IllegalArgumentException) new IllegalArgumentException("Invalid remote URI: " + name).initCause(e);
}
}
return null;
}
protected synchronized IdGenerator getConnectionIdGenerator() {
if (connectionIdGenerator == null) {
if (connectionIDPrefix != null) {
connectionIdGenerator = new IdGenerator(connectionIDPrefix);
} else {
connectionIdGenerator = new IdGenerator();
}
}
return connectionIdGenerator;
}
protected synchronized void setConnectionIdGenerator(IdGenerator connectionIdGenerator) {
this.connectionIdGenerator = connectionIdGenerator;
}
//----- Property Access Methods ------------------------------------------//
/**
* @return the remoteURI
*/
public String getRemoteURI() {
return this.remoteURI != null ? this.remoteURI.toString() : getDefaultRemoteAddress();
}
/**
* @param remoteURI
* the remoteURI to set
*/
public void setRemoteURI(String remoteURI) {
if (remoteURI == null || remoteURI.isEmpty()) {
throw new IllegalArgumentException("Invalid URI: cannot be null or empty");
}
this.remoteURI = createURI(remoteURI);
if (this.remoteURI.getRawUserInfo() != null) {
throw new IllegalArgumentException("The supplied URI cannot contain a User-Info section");
}
try {
if (URISupport.isCompositeURI(this.remoteURI)) {
CompositeData data = URISupport.parseComposite(this.remoteURI);
applyURIOptions(data.getParameters());
this.remoteURI = data.toURI();
} else if (this.remoteURI.getRawQuery() != null) {
Map<String, String> map = PropertyUtil.parseQuery(this.remoteURI);
applyURIOptions(map);
this.remoteURI = PropertyUtil.replaceQuery(this.remoteURI, map);
}
} catch (Exception e) {
throw new IllegalArgumentException(e.getMessage());
}
}
private void applyURIOptions(Map<String, String> options) throws IllegalArgumentException {
Map<String, String> jmsOptionsMap = PropertyUtil.filterProperties(options, "jms.");
Map<String, String> unused = PropertyUtil.setProperties(this, jmsOptionsMap);
if (!unused.isEmpty()) {
String msg = ""
+ " Not all jms options could be set on the ConnectionFactory."
+ " Check the options are spelled correctly."
+ " Unused parameters=[" + unused + "]."
+ " This connection factory cannot be started.";
throw new IllegalArgumentException(msg);
}
}
/**
* @return the user name used for connection authentication.
*/
public String getUsername() {
return this.username;
}
/**
* @param username
* the user name to set
*/
public void setUsername(String username) {
this.username = username;
}
/**
* @return the password set for connection authentication.
*/
public String getPassword() {
return this.password;
}
/**
* @param password
* the password to set
*/
public void setPassword(String password) {
this.password = password;
}
/**
* Returns true if the client should always send messages using a synchronous
* send operation regardless of persistence mode, or inside a transaction.
*
* @return true if sends should always be done synchronously.
*/
public boolean isForceSyncSend() {
return forceSyncSend;
}
/**
* Configures whether or not the client will always send messages synchronously or not
* regardless of other factors that might result in an asynchronous send.
*
* @param forceSyncSend
* if true sends are always done synchronously.
*/
public void setForceSyncSend(boolean forceSyncSend) {
this.forceSyncSend = forceSyncSend;
}
public boolean isForceAsyncSend() {
return forceAsyncSend;
}
public void setForceAsyncSend(boolean forceAsyncSend) {
this.forceAsyncSend = forceAsyncSend;
}
/**
* @return the localMessagePriority configuration option.
*/
public boolean isLocalMessagePriority() {
return this.localMessagePriority;
}
/**
* Enables client-side message priority support in MessageConsumer instances.
* This results in all prefetched messages being dispatched in priority order.
*
* @param localMessagePriority the messagePrioritySupported to set
*/
public void setLocalMessagePriority(boolean localMessagePriority) {
this.localMessagePriority = localMessagePriority;
}
/**
* Returns the prefix applied to Queues that are created by the client.
*
* @return the currently configured Queue prefix.
*/
public String getQueuePrefix() {
return queuePrefix;
}
public void setQueuePrefix(String queuePrefix) {
this.queuePrefix = queuePrefix;
}
/**
* Returns the prefix applied to Topics that are created by the client.
*
* @return the currently configured Topic prefix.
*/
public String getTopicPrefix() {
return topicPrefix;
}
public void setTopicPrefix(String topicPrefix) {
this.topicPrefix = topicPrefix;
}
public boolean isValidatePropertyNames() {
return validatePropertyNames;
}
public void setValidatePropertyNames(boolean validatePropertyNames) {
this.validatePropertyNames = validatePropertyNames;
}
public boolean isValidateSelector() {
return validateSelector;
}
/**
* Sets whether local validation is performed of a consumers message selector string
* conforming to the JMS selector syntax. Default is true.
*
* @param validateSelector whether to validate consumer message selector strings
*/
public void setValidateSelector(boolean validateSelector) {
this.validateSelector = validateSelector;
}
/**
* Gets the currently set close timeout.
*
* @return the currently set close timeout.
*/
public long getCloseTimeout() {
return closeTimeout;
}
/**
* Sets the close timeout used to control how long a Connection close will wait for
* clean shutdown of the connection before giving up. A negative value means wait
* forever.
*
* Care should be taken in that a very short close timeout can cause the client to
* not cleanly shutdown the connection and it's resources.
*
* @param closeTimeout
* time in milliseconds to wait for a clean connection close.
*/
public void setCloseTimeout(long closeTimeout) {
this.closeTimeout = closeTimeout;
}
/**
* Returns the currently configured wire level connect timeout.
*
* @return the currently configured wire level connect timeout.
*/
public long getConnectTimeout() {
return this.connectTimeout;
}
/**
* Sets the timeout value used to control how long a client will wait for a successful
* connection to the remote peer to be established before considering the attempt to
* have failed. This value does not control socket level connection timeout but rather
* connection handshake at the wire level, to control the socket level timeouts use the
* standard socket options configuration values.
*
* @param connectTimeout
* the time in milliseconds to wait for the protocol connection handshake to complete.
*/
public void setConnectTimeout(long connectTimeout) {
this.connectTimeout = connectTimeout;
}
public long getSendTimeout() {
return sendTimeout;
}
public void setSendTimeout(long sendTimeout) {
this.sendTimeout = sendTimeout;
}
public long getRequestTimeout() {
return requestTimeout;
}
public void setRequestTimeout(long requestTimeout) {
this.requestTimeout = requestTimeout;
}
public JmsPrefetchPolicy getPrefetchPolicy() {
return prefetchPolicy;
}
public void setPrefetchPolicy(JmsPrefetchPolicy prefetchPolicy) {
if (prefetchPolicy == null) {
prefetchPolicy = new JmsDefaultPrefetchPolicy();
}
this.prefetchPolicy = prefetchPolicy;
}
/**
* Returns the JmsRedeliveryPolicy that is applied when a new connection is created.
*
* @return the redeliveryPolicy that is currently configured for this factory.
*/
public JmsRedeliveryPolicy getRedeliveryPolicy() {
return redeliveryPolicy;
}
/**
* Sets the JmsRedeliveryPolicy that is applied when a new connection is created.
*
* @param redeliveryPolicy
* The new redeliveryPolicy to set
*/
public void setRedeliveryPolicy(JmsRedeliveryPolicy redeliveryPolicy) {
if (redeliveryPolicy == null) {
redeliveryPolicy = new JmsDefaultRedeliveryPolicy();
}
this.redeliveryPolicy = redeliveryPolicy;
}
/**
* @return the presettlePolicy that is currently configured.
*/
public JmsPresettlePolicy getPresettlePolicy() {
return presettlePolicy;
}
/**
* Sets the JmsPresettlePolicy that is applied to MessageProducers.
*
* @param presettlePolicy
* the presettlePolicy to use by connections created from this factory.
*/
public void setPresettlePolicy(JmsPresettlePolicy presettlePolicy) {
if (presettlePolicy == null) {
presettlePolicy = new JmsDefaultPresettlePolicy();
}
this.presettlePolicy = presettlePolicy;
}
/**
* @return the messageIDPolicy that is currently configured.
*/
public JmsMessageIDPolicy getMessageIDPolicy() {
return messageIDPolicy;
}
/**
* Sets the JmsMessageIDPolicy that is use to configure the JmsMessageIDBuilder
* that is assigned to any new MessageProducer created from Connection instances
* that this factory has created.
*
* @param messageIDPolicy
* the messageIDPolicy to use by connections created from this factory.
*/
public void setMessageIDPolicy(JmsMessageIDPolicy messageIDPolicy) {
if (messageIDPolicy == null) {
messageIDPolicy = new JmsDefaultMessageIDPolicy();
}
this.messageIDPolicy = messageIDPolicy;
}
/**
* @return the deserializationPolicy that is currently configured.
*/
public JmsDeserializationPolicy getDeserializationPolicy() {
return deserializationPolicy;
}
/**
* Sets the JmsDeserializationPolicy that is applied when a new connection is created.
*
* @param deserializationPolicy
* the deserializationPolicy that will be applied to new connections.
*/
public void setDeserializationPolicy(JmsDeserializationPolicy deserializationPolicy) {
if (deserializationPolicy == null) {
deserializationPolicy = new JmsDefaultDeserializationPolicy();
}
this.deserializationPolicy = deserializationPolicy;
}
/**
* @return the currently configured client ID prefix for auto-generated client IDs.
*/
public synchronized String getClientIDPrefix() {
return clientIDPrefix;
}
/**
* Sets the prefix used by auto-generated JMS Client ID values which are used if the JMS
* client does not explicitly specify one.
*
* @param clientIDPrefix
* the value to use as a prefix on auto-generated client IDs.
*/
public synchronized void setClientIDPrefix(String clientIDPrefix) {
this.clientIDPrefix = clientIDPrefix;
}
protected synchronized IdGenerator getClientIdGenerator() {
if (clientIdGenerator == null) {
if (clientIDPrefix != null) {
clientIdGenerator = new IdGenerator(clientIDPrefix);
} else {
clientIdGenerator = new IdGenerator();
}
}
return clientIdGenerator;
}
protected synchronized void setClientIdGenerator(IdGenerator clientIdGenerator) {
this.clientIdGenerator = clientIdGenerator;
}
public String getClientID() {
return clientID;
}
/**
* Sets the JMS clientID to use for connections created by this factory.
*
* NOTE: A clientID can only be used by one Connection at a time, so setting it here
* will restrict the ConnectionFactory to creating a single open Connection at a time.
* It is possible to set the clientID on the Connection itself immediately after
* creation if no value has been set via the factory that created it, which will
* allow the factory to create multiple open connections at a time.
*
* @param clientID
* The clientID to assign when creating a new connection.
*/
public void setClientID(String clientID) {
this.clientID = clientID;
}
/**
* Sets the prefix used by connection id generator.
*
* @param connectionIDPrefix
* The string prefix used on all connection Id's created by this factory.
*/
public synchronized void setConnectionIDPrefix(String connectionIDPrefix) {
this.connectionIDPrefix = connectionIDPrefix;
}
/**
* Gets the currently configured JMS ExceptionListener that will be set on all
* new Connection objects created from this factory.
*
* NOTE: the listener object is not saved when serializing the factory.
*
* @return the currently configured JMS ExceptionListener.
*/
public ExceptionListener getExceptionListener() {
return exceptionListener;
}
/**
* Sets the JMS ExceptionListener that will be set on all new Connection objects
* created from this factory.
*
* @param exceptionListener
* the JMS ExceptionListener to apply to new Connection's or null to clear.
*/
public void setExceptionListener(ExceptionListener exceptionListener) {
this.exceptionListener = exceptionListener;
}
/**
* @return true if consumer acknowledgments are sent asynchronously or not.
*/
public boolean isForceAsyncAcks() {
return forceAsyncAcks;
}
/**
* Should the message acknowledgments from a consumer be sent synchronously or
* asynchronously. Sending the acknowledgments asynchronously can increase the
* performance of a consumer but opens up the possibility of a missed message
* acknowledge should the connection be unstable.
*
* @param forceAsyncAcks
* true to have the client send all message acknowledgments asynchronously.
*/
public void setForceAsyncAcks(boolean forceAsyncAcks) {
this.forceAsyncAcks = forceAsyncAcks;
}
/**
* @return true if MessageConsumer instance will check for expired messages locally before dispatch.
*/
public boolean isLocalMessageExpiry() {
return localMessageExpiry;
}
/**
* Controls whether message expiration checking is done locally (in addition to any broker
* side checks) in each MessageConsumer prior to dispatching a message. Disabling this check
* can lead to consumption of expired messages.
*
* @param localMessageExpiry
* controls whether expiration checking is done prior to dispatch.
*/
public void setLocalMessageExpiry(boolean localMessageExpiry) {
this.localMessageExpiry = localMessageExpiry;
}
public boolean isReceiveLocalOnly() {
return receiveLocalOnly;
}
/**
* Controls whether the client only checks its local message buffer when using
* receive calls with a timeout, or will instead drain remaining credit from the
* remote peer to ensure there are really no messages available if the
* timeout expires before a message arrives in the consumers local buffer.
*
* @param receiveLocalOnly
* true if receive calls with a timeout should only check the local message buffer.
*/
public void setReceiveLocalOnly(boolean receiveLocalOnly) {
this.receiveLocalOnly = receiveLocalOnly;
}
public boolean isReceiveNoWaitLocalOnly() {
return receiveNoWaitLocalOnly;
}
/**
* Controls whether the client only checks its local message buffer when using
* receiveNoWait calls, or will instead drain remaining credit from the
* remote peer synchronously to ensure there are really no messages available
* that have yet to arrive in the consumers local buffer.
*
* @param receiveNoWaitLocalOnly
* true if receiveNoWait calls should only check the local message buffer.
*/
public void setReceiveNoWaitLocalOnly(boolean receiveNoWaitLocalOnly) {
this.receiveNoWaitLocalOnly = receiveNoWaitLocalOnly;
}
public boolean isPopulateJMSXUserID() {
return populateJMSXUserID;
}
/**
* Controls whether message sent from the Connection will have the JMSXUserID message
* property populated with the authenticated user ID of the Connection. When false all
* messages sent from the Connection will not carry any value in the JMSXUserID property
* regardless of it being manually set on the Message to prevent a client spoofing the
* JMSXUserID value.
*
* @param populateJMSXUserID
* true if message sent from this connection should have the JMSXUserID value populated.
*/
public void setPopulateJMSXUserID(boolean populateJMSXUserID) {
this.populateJMSXUserID = populateJMSXUserID;
}
/**
* Sets an SSLContext to use when creating an SSL/TLS secured connection with this factory.
* The URI must still be configured to indicate a secure connection should be created.
* Using this method overrides the effect of URI/System property configuration relating
* to the location/credentials/type of SSL key/trust stores and whether to trust all
* certificates or use a particular keyAlias.
*
* @param sslContext
* the sslContext to use, or null to respect the URI/System property configuration again.
*/
public void setSslContext(SSLContext sslContext) {
this.extensionMap.put(JmsConnectionExtensions.SSL_CONTEXT, (connection, remoteURI) -> sslContext);
}
public boolean isAwaitClientID() {
return awaitClientID;
}
/**
* Controls whether the client will wait for a ClientID value to be set or the Connection
* to be used before it will attempt to complete the AMQP connection Open process.
* <p>
* By default a newly created Connection that does not have a ClientID configured in the URI
* will wait until a call to setClientID or some other interaction with the Connection API
* occurs before finishing the AMQP connection Open process with the remote peer. In some
* cases if this takes too long the remote can disconnect as a way of defending against
* denial of service attacks. If the user does not plan on setting a ClientID then this
* option allows for immediate AMQP connection Open completion and avoids the case where
* the remote peer might drop the Connection if it isn't used promptly.
* <p>
* This value defaults to true.
*
* @param awaitClientID
* the whether to wait for the client ID to be set before activating the connection.
*/
public void setAwaitClientID(boolean awaitClientID) {
this.awaitClientID = awaitClientID;
}
public boolean isUseDaemonThread() {
return useDaemonThread;
}
/**
* Sets whether the Connection created will ensure that there is at least one non-daemon
* thread running at all times.
*
* @param useDaemonThread
* controls whether the Connection maintains a non-daemon thread.
*/
public void setUseDaemonThread(boolean useDaemonThread) {
this.useDaemonThread = useDaemonThread;
}
/**
* @return whether links that fail to be created during failover reconnect are closed or not.
*/
public boolean isCloseLinksThatFailOnReconnect() {
return closeLinksThatFailOnReconnect;
}
/**
* Controls how the client manages errors on recreation of a link (producer / consumer) during
* a failover reconnect attempt (defaults to false).
* <p>
* When false the failure of a link recreation operation while reestablishing a failed connection
* results in the client failing that reconnect attempt and retrying the entire connection process
* again. This can be disabled by setting this option to true in which case the client will close
* the producer or consumer associated with the failed link create attempt and continue rebuilding
* the client resources for the newly reestablished connection. When failing a consumer link the
* client will trigger the {@link ExceptionListener} assigned to the Connection if the link that failed
* was a consumer and that consumer had an associated JMS {@link MessageListener}.
*
* @param closeLinksThatFailOnReconnect
* whether to close links that fail to establish on failover reconnect.
*/
public void setCloseLinksThatFailOnReconnect(boolean closeLinksThatFailOnReconnect) {
this.closeLinksThatFailOnReconnect = closeLinksThatFailOnReconnect;
}
/**
* Provides an entry point for extensions to be configured on this {@link ConnectionFactory}.
* <p>
* If a previous extension with the same name is present it is replaced with the new value or
* cleared if the value is null.
*
* @param extensionName
* The name of the extension point being added.
* @param extension
* The Function that implements the extension.
*
* @see JmsConnectionExtensions
*/
public void setExtension(String extensionName, BiFunction<Connection, URI, Object> extension) {
JmsConnectionExtensions extensionKey = JmsConnectionExtensions.fromString(extensionName);
if (extension == null) {
extensionMap.remove(extensionKey);
} else {
extensionMap.put(extensionKey, extension);
}
}
/**
* Sets the type name for a tracing provider to use for the connection(s) created using the factory.