-
Language:
English
-
Language:
English
Connection Reference
A reference for all of the options for creating connections to a broker
Red Hat
Copyright © 2011-2014 Red Hat, Inc. and/or its affiliates.
Abstract
Chapter 1. OpenWire over TCP
URI syntax
Example 1.1. Syntax for a vanilla TCP Connection
tcp://Host[:Port]?transportOptions
Example 1.2. Syntax for NIO Connection
nio://Host[:Port]?transportOptions
Setting transport options
- When using a URI to open a connection between a client and a broker, you just specify the name of the option as shown.
Example 1.3. Setting an Option on a Client-Side TCP URI
tcp://fusesource.com:61616?trace=true
- When using a URI to open a broker listener socket, you prefix the option name with
transport.
as shown.Example 1.4. Specifying Transport Options for a Listener Socket
tcp://fusesource.com:61616?transport.trace=true
- When using a URI to open a broker connection socket, you just specify the name of the option as shown.
Example 1.5. Setting an Option on a Client-Side TCP URI
tcp://fusesource.com:61616?trace=true
&
symbol, replacing it with & as shown.
Example 1.6. Transport Options in XML
?option=value&option=value&...
Transport options
Table 1.1. TCP and NIO Transport Options
Option | Default | Description |
---|---|---|
minmumWireFormatVersion | 0 | Specifies the minimum wire format version that is allowed. |
trace | false | Causes all commands sent over the transport to be logged. |
daemon | false | Specifies whether the transport thread runs as a daemon or not. Useful to enable when embedding in a Spring container or in a web container, to allow the container to shut down properly. |
useLocalHost | true | When true , causes the local machine's name to resolve to localhost . |
socketBufferSize | 64*1024 | Sets the socket buffer size in bytes. |
keepAlive | false | When true , enables TCP KeepAlive on the broker connection. Useful to ensure that inactive consumers do not time out. |
soTimeout | 0 | Specifies, in milliseconds, the socket timeout. |
soWriteTimeout | 0 | Specifies, in milliseconds, the timeout for socket write operations. |
connectionTimeout | 30000 | Specifies, in milliseconds, the connection timeout. Zero means wait forever for the connection to be established. |
closeAsync | true | The false value causes all sockets to be closed synchronously. |
soLinger | MIN_INTEGER | When > -1, enables the SoLinger socket option with this value. When equal to -1, disables SoLinger . |
maximumConnections | MAX_VALUE | The maximum number of sockets the broker is allowed to create. |
diffServ | 0 | (Client only) The preferred Differentiated Services traffic class to be set on outgoing packets, as described in RFC 2475. Valid integer values are [0,64) . Valid string values are EF , AF[1-3][1-4] or CS[0-7] . With JDK 6, only works when the Java Runtime uses the IPv4 stack, which can be done by setting the java.net.preferIPv4Stack system property to true . Cannot be used at the same time as the typeOfService option. |
typeOfService | 0 | (Client only) The preferred type of service value to be set on outgoing packets. Valid integer values are [0,256) . With JDK 6, only works when the Java Runtime uses the IPv4 stack, which can be done by setting the java.net.preferIPv4Stack system property to true . Cannot be used at the same time as the diffServ option. |
wireFormat | The name of the wire format to use. | |
wireFormat.* | All the properties with this prefix are used to configure the wireFormat. See Table A.1, “Wire Format Options Supported by OpenWire Protocol” for more information. | |
jms.* | All the properties with this prefix are used to configure client connections to a broker. See Appendix B, Client Connection Options for more information. |
Chapter 2. OpenWire over SSL
URI syntax
Example 2.1. Syntax for a vanilla SSL Connection
ssl://Host[:Port]?transportOptions
Example 2.2. Syntax for NIO Connection
nio+ssl://Host[:Port]?transportOptions
Setting transport options
- When using a URI to open a connection between a client and a broker, you just specify the name of the option as shown.
Example 2.3. Setting an Option on a Client-Side TCP URI
tcp://fusesource.com:61616?trace=true
- When using a URI to open a broker listener socket, you prefix the option name with
transport.
as shown.Example 2.4. Specifying Transport Options for a Listener Socket
tcp://fusesource.com:61616?transport.trace=true
- When using a URI to open a broker connection socket, you just specify the name of the option as shown.
Example 2.5. Setting an Option on a Client-Side TCP URI
tcp://fusesource.com:61616?trace=true
&
symbol, replacing it with & as shown.
Example 2.6. Transport Options in XML
?option=value&option=value&...
SSL transport options
SSLServerSocket
created for the connection. These options are listed in Table 2.1, “SSL Transport Options”.
Table 2.1. SSL Transport Options
Option | Default | Description |
---|---|---|
enabledCipherSuites | Specifies the cipher suites accepted by this endpoint, in the form of a comma-separated list. | |
enabledProtocols | Specifies the secure socket protocols accepted by this endpoint, in the form of a comma-separated list. If using Oracle's JSSE provider, possible values are: TLSv1 , TLSv1.1 , or TLSv1.2 (do not use SSLv2Hello or SSLv3 , because of the POODLE security vulnerability, which affects SSLv3). | |
wantClientAuth | (broker only) If true , the server requests (but does not require) the client to send a certificate. | |
needClientAuth | false | (broker only) If true , the server requires the client to send its certificate. If the client fails to send a certificate, the server will throw an error and close the session. |
enableSessionCreation | true | (broker only) If true , the server socket creates a new SSL session every time it accepts a connection and spawns a new socket. If false , an existing SSL session must be resumed when the server socket accepts a connection. |
Configuring broker SSL options
transport.OptionName
. For example, to enable an OpenWire SSL port on a broker, you would add the following transport element:
<transportConnector name="ssl" uri="ssl:localhost:61617?transport.enabledProtocols=TLSv1,TLSv1.1,TLSv1.2" />
&
, between options as &
.
Configuring client SSL options
socket.OptionName
. For example, to connect to an OpenWire SSL port, you would use a URL like the following:
ssl:localhost:61617?socket.enabledProtocols=TLSv1,TLSv1.1,TLSv1.2
Chapter 3. OpenWire over HTTP(S)
URI syntax
Example 3.1. Syntax for an HTTP Connection
tcp://Host[:Port]
Example 3.2. Syntax for an HTTPS Connection
https://Host[:Port]
Dependencies
lib/optional
folder are included on the classpath:
activemq-http-x.x.x.jar
xstream-x.x.x.jar
commons-logging-x.x.x.jar
commons-codec-x.x.x.jar
httpcore-x.x.x.jar
httpclient-x.x.x.jar
Chapter 4. OpenWire over UDP/IP
URI syntax
Example 4.1. Syntax for a UDP Connection
udp://Host[:Port]?transportOptions
Setting transport options
- When using a URI to open a connection between a client and a broker, you just specify the name of the option as shown.
Example 4.2. Setting an Option on a Client-Side TCP URI
tcp://fusesource.com:61616?trace=true
- When using a URI to open a broker listener socket, you prefix the option name with
transport.
as shown.Example 4.3. Specifying Transport Options for a Listener Socket
tcp://fusesource.com:61616?transport.trace=true
- When using a URI to open a broker connection socket, you just specify the name of the option as shown.
Example 4.4. Setting an Option on a Client-Side TCP URI
tcp://fusesource.com:61616?trace=true
&
symbol, replacing it with & as shown.
Example 4.5. Transport Options in XML
?option=value&option=value&...
Transport options
Table 4.1. UDP Transport Options
Option | Default | Description |
---|---|---|
minmumWireFormatVersion | 0 | The minimum version wire format that is allowed. |
trace | false | Causes all commands sent over the transport to be logged. |
useLocalHost | true | When true , causes the local machine's name to resolve to localhost . |
datagramSize | 4*1024 | Specifies the size of a datagram. |
wireFormat | The name of the wire format to use. | |
wireFormat.* | All options with this prefix are used to configure the wire format. See Table A.1, “Wire Format Options Supported by OpenWire Protocol” for more information. | |
jms.* | All the properties with this prefix are used to configure client connections to a broker. See Appendix B, Client Connection Options for more information. |
Chapter 5. Stomp Protocol
Abstract
Overview
URI syntax
Example 5.1. Vanilla Stop URI
stomp://Host:[Port]?transportOptions
Example 5.2. Syntax for Stomp+NIO Connection
stomp+nio://Host[:Port]?transportOptions
Example 5.3. Syntax for a Stomp SSL Connection
stomp+ssl://Host[:Port]?transportOptions
Example 5.4. Syntax for a Stomp+NIO SSL Connection
stomp+nio+ssl://Host[:Port]?transportOptions
Transport options
Table 5.1. Transport Options Supported by Stomp Protocol
Property | Default | Description |
---|---|---|
transport.defaultHeartBeat | 0,0 |
Specifies how the broker simulates the heartbeat policy when working with legacy Stomp 1.0 clients. The first value in the pair specifies, in milliseconds, the server will wait between messages before timing out the connection. The second value specifies, in milliseconds, the the client will wait between messages received from the server. Because Stomp 1.0 clients do not understand heartbeat messages, the second value should always be 0. This option is set in the
uri attribute of a broker's transportConnector element to enable backward compatibility with Stomp 1.0 clients.
|
jms.* | All the properties with this prefix are used to configure client connections to a broker. See Appendix B, Client Connection Options for more information. |
SSL transport options
SSLServerSocket
created for the connection. These options are listed in Table 2.1, “SSL Transport Options”.
Configuring broker SSL options
transport.OptionName
. For example, to enable a Stomp SSL port on a broker, you would add the following transport element:
<transportConnector name="stompssl" uri="stomp+ssl://localhost:61617?transport.enabledProtocols=TLSv1,TLSv1.1,TLSv1.2" />
&
, between options as &
.
Configuring client SSL options
socket.OptionName
. For example, to connect to a Stomp SSL port, you would use a URL like the following:
stomp+ssl://localhost:61617?socket.enabledProtocols=TLSv1,TLSv1.1,TLSv1.2
Chapter 6. Multicast Protocol
Abstract
URI syntax
Example 6.1. Multicast URI
multicast://Host:[Port]?transportOptions
Transport options
Table 6.1. Transport Options Supported by Multicast Protocol
Property | Default | Description |
---|---|---|
group | default | Specifies a unique group name that can segregate multicast traffic. |
minmumWireFormatVersion | 0 | Specifies the minimum wire format version that is allowed. |
trace | false | Causes all commands sent over the transport to be logged. |
useLocalHost | true | When true , causes the local machine's name to resolve to localhost . |
datagramSize | 4 * 1024 | Specifies the size of a datagram. |
timeToLive | -1 | Specifies the time to live of datagrams. Set greater than 1 to send packets beyond the local network. [a] |
loopBackMode | false | Specifies whether loopback mode is used. |
wireFormat | The name of the wire format to use. | |
wireFormat.* | All the properties with this prefix are used to configure the wireFormat. See Table A.1, “Wire Format Options Supported by OpenWire Protocol” for more information. | |
jms.* | All the properties with this prefix are used to configure client connections to a broker. See Appendix B, Client Connection Options for more information. | |
[a]
This won't work for IPv4 addresses without setting the property java.net.preferIPv4Stack=true .
|
Chapter 7. MQ Telemetry Transport(MQTT) Protocol
Abstract
URI syntax
Example 7.1. MQTT URI
mqtt://Host:[Port]?transportOptions
Example 7.2. Syntax for MQTT+NIO Connection
mqtt+nio://Host[:Port]?transportOptions
Example 7.3. Syntax for an MQTT SSL Connection
mqtt+ssl://Host[:Port]?transportOptions
Example 7.4. Syntax for a MQTT+NIO SSL Connection
mqtt+nio+ssl://Host[:Port]?transportOptions
Transport options
Table 7.1. MQTT Transport Options
Property | Default | Description |
---|---|---|
transport.defaultKeepAlive | 0 |
Specifies, in milliseconds, the broker will allow a connection to be silent before it is closed. If a client specifies a keep-alive duration, this setting is ignored. This option is set in the
uri attribute of a broker's transportConnector element.
|
jms.* | All the properties with this prefix are used to configure client connections to a broker. See Appendix B, Client Connection Options for more information. |
SSL transport options
SSLServerSocket
created for the connection. These options are listed in Table 2.1, “SSL Transport Options”.
Configuring broker SSL options
transport.OptionName
. For example, to enable an MQTT SSL port on a broker, you would add the following transport element:
<transportConnector name="mqttssl" uri="mqtt+ssl://localhost:61617?transport.enabledProtocols=TLSv1,TLSv1.1,TLSv1.2" />
&
, between options as &
.
Configuring client SSL options
socket.OptionName
. For example, to connect to a MQTT SSL port, you would use a URL like the following:
mqtt+ssl://localhost:61617?socket.enabledProtocols=TLSv1,TLSv1.1,TLSv1.2
Chapter 8. Advanced Message Queuing Protocol (AMQP)
Abstract
URI syntax
amqp://Host:[Port]?transportOptions
amqp+nio://Host:[Port]?transportOptions
amqp+ssl://Host:[Port]?transportOptions
Security
sslContext
element in the XML configuration and use the secure AMQP scheme, amqp+ssl
, to define the AMQP URI in the broker's transportConnector
element. For more details about SSL security, see the "Security Guide".
SSL transport options
SSLServerSocket
created for the connection. These options are listed in Table 2.1, “SSL Transport Options”.
Configuring broker SSL options
transport.OptionName
. For example, to enable an AMQP SSL port on a broker, you would add the following transport element:
<transportConnector name="amqpssl" uri="amqp+ssl://localhost:61617?transport.enabledProtocols=TLSv1,TLSv1.1,TLSv1.2" />
&
, between options as &
.
Configuring client SSL options
socket.OptionName
. For example, to connect to an AMQP SSL port, you would use a URL like the following:
amqp+ssl://localhost:61617?socket.enabledProtocols=TLSv1,TLSv1.1,TLSv1.2
Mapping from AMQP to JMS
transport.transformer
option on the AMQP endpoint.
jms
transformer type:
<transportConnector name="amqp" uri="amqp://localhost:5672?transport.transformer=jms"/>
AMQP-to-JMS transformers
Table 8.1. AMQP-to-JMS Transformer Types
Transformer | Description |
---|---|
native | (Default) Wraps the bytes of the AMQP message into a JMS BytesMessage , and maps the AMQP message headers to JMS message headers. |
raw | Wraps the bytes of the AMQP message into a JMS BytesMessage . |
jms | Maps the body of the AMQP message to JMS body, and maps the AMQP message headers to JMS message headers. |
Header mapping—all transformers
AMQP Header | JMS Header |
---|---|
JMS_AMQP_NATIVE | |
message-format | JMS_AMQP_MESSAGE_FORMAT |
JMS_AMQP_NATIVE
header is a boolean
type, which indicates whether or not the JMS message body is a direct copy of the raw AMQP message body. It is set to true
for the native
and jms
transformer types and false
for the jms
transformer type.
Header mapping—native or jms transformers
native
or jms
transformer type is selected.
AMQP Header | JMS Header |
---|---|
header.durable | JMSDeliveryMode |
header.priority | JMSPriority |
header.ttl | JMSExpiration |
header.first-acquirer | JMS_AMQP_FirstAcquirer |
header.deliveryCount | JMSXDeliveryCount |
delivery-annotations.name | JMS_AMQP_DA_name |
message-annotations.x-opt-jms-type | JMSType |
message-annotations.x-opt-to-type | Type of the JMSDestination |
message-annotations.x-opt-reply-type | Type of the JMSReplyTo |
message-annotations.name | JMS_AMQP_MA_name |
application-properties.JMSXGroupID | JMSXGroupID |
application-properties.JMSXGroupSequence | JMSXGroupSequence |
application-properties.JMSXUserID | JMSXUserID |
application-properties.name | name |
properties.message-id | JMSMessageID |
properties.user-id | JMSXUserID |
properties.to | JMSDestination |
properties.subject | JMS_AMQP_Subject |
properties.reply-to | JMSReplyTo |
properties.correlation-id | JMSCorrelationID |
properties.content-type | JMS_AMQP_ContentType |
properties.content-encoding | JMS_AMQP_ContentEncoding |
properties.creation-time | JMSTimestamp |
properties.group-sequence | JMSXGroupSequence |
properties.reply-to-group-id | JMS_AMQP_ReplyToGroupID |
footer.name | JMS_AMQP_FT_name |
properties.user-id
property is decoded as a UTF-8 String
.
Default header values
JMS_AMQP_NATIVE
- Defaults to
true
, if the transformer isnative
orraw
, otherwisefalse
. JMSDeliveryMode
- Defaults to
javax.jms.Message.DEFAULT_DELIVERY_MODE
. JMSPriority
- Defaults to
javax.jms.Message.DEFAULT_PRIORITY
. JMSExpiration
- Defaults to
javax.jms.Message.DEFAULT_TIME_TO_LIVE
. JMSDestination
type- Defaults to
queue
. JMSReplyTo
type- Defaults to
queue
. JMSMessageID
- Auto-generated, if not set.
Property type mapping
AMQP Type | Java Type | Notes |
---|---|---|
bool | Boolean | |
byte | Byte | |
short | Short | |
int | Integer | |
long | Long | |
ubyte | Byte or Short | Short is used, if value > Byte.MAX_VALUE |
ushort | Short or Integer | Integer is used if value > Short.MAX_VALUE |
uint | Integer or Long | Long is used, if value > Integer.MAX_VALUE |
ulong | Long | |
double | Double | |
float | Float | |
symbol | String | |
binary | String | Hex encoding of the binary value |
Message body mapping
jms
transformer type is selected, the AMQP message body is mapped to a JMS message type, as shown in the following table:
AMQP Body Type | JMS Message Type |
---|---|
null | Message |
Data | BytesMessage |
AmqpSequence | StreamMessage |
AmqpValue holding a null | Message |
AmqpValue holding a String | TextMessage |
AmqpValue holding a binary | BytesMessage |
AmqpValue holding a list | StreamMessage |
AmqpValue | ObjectMessage |
Chapter 9. VM Transport
Abstract
- simple—specifies the name of the embedded broker to which the client connects and allows for some basic broker configuration
- advanced—uses a broker URI to configure the embedded broker
9.1. Simple VM URI Syntax
URI syntax
Example 9.1. Simple VM URI Syntax
vm://BrokerName?TransportOptions
- BrokerName specifies the name of the embedded broker to which the client connects.
- TransportOptions specifies the configuration for the transport. They are specified in the form of a query list. Table 9.2, “VM Transport Options” lists the available options.
Broker options
Table 9.1. VM Transport Broker Configuration Options
Example
broker1
.
Example 9.2. Basic VM URI
vm://broker1
Example 9.3. Simple URI with broker options
vm://broker1?broker.persistent=false
9.2. Advanced VM URI Syntax
URI syntax
Example 9.4. Advanced VM URI Syntax
vm://(BrokerConfigURI)?TransportOptions
- BrokerConfigURI is a broker configuration URI.
- TransportOptions specifies the configuration for the transport. They are specified in the form of a query list. Table 9.2, “VM Transport Options” lists the available options.
Transport options
Table 9.2. VM Transport Options
Option | Description |
---|---|
marshal | If true , forces each command sent over the transport to be marshalled and unmarshalled using the specified wire format. Default is false . |
wireFormat | The name of the wire format to use. |
wireFormat.* | All options with this prefix are used to configure the wire format. See Table A.1, “Wire Format Options Supported by OpenWire Protocol” for more information. |
jms.* | All the properties with this prefix are used to configure client connections to a broker. See Appendix B, Client Connection Options for more information. |
create | Specifies if the VM transport will create an embedded broker if one does not exist. The default is true . |
waitForStart | Specifies the time, in milliseconds, the VM transport will wait for an embedded broker to start before creating one. The default is -1 which specifies that the transport will not wait. |
Example
Example 9.5. Advanced VM URI
vm:(broker:(tcp://localhost:6000)?persistent=false)?marshal=false
Chapter 10. Dynamic Discovery Protocol
Abstract
URI syntax
Example 10.1. Dynamic Discovery URI
discovery:(DiscoveryAgentUri)?Options
?Options
, are specified in the form of a query list. The discovery options are described in Table 10.1, “Dynamic Discovery Protocol Options”. You can also inject transport options into the discovered transports by adding their properties to the list.
Transport options
Table 10.1. Dynamic Discovery Protocol Options
Chapter 11. Fanout Protocol
Abstract
URI syntax
Example 11.1. Fanout URI Syntax
fanout://(DiscoveryAgentUri)?Options
?Options
, are specified in the form of a query list. The discovery options are described in Table 11.1, “Fanout Protocol Options”. You can also inject transport options into the discovered transports by adding their properties to the list.
Transport options
Table 11.1. Fanout Protocol Options
Chapter 12. Discovery Agents
Abstract
Fabric agent
Example 12.1. Fuse Fabric Discovery Agent URI Format
fabric://GID
Static agent
Example 12.2. Static Discovery Agent URI Format
static://(URI1,URI2,URI3,...)
Multicast agent
Example 12.3. Multicast Discovery Agent URI Format
multicast://GroupID
Zeroconf agent
Example 12.4. Zeroconf Discovery Agent URI Format
zeroconf://GroupID
Chapter 13. Peer Protocol
Abstract
URI syntax
peer
URI must conform to the following syntax:
peer://PeerGroup/BrokerName?BrokerOptions
?persistent=true
).
Broker options
Table 13.1. Broker Options
Option | Description |
---|---|
useJmx | If true , enables JMX. Default is true . |
persistent | If true , the broker uses persistent storage. Default is true . |
populateJMSXUserID | If true , the broker populates the JMSXUserID message property with the sender’s authenticated username. Default is false . |
useShutdownHook | If true , the broker installs a shutdown hook, so that it can shut down properly when it receives a JVM kill. Default is true . |
brokerName | Specifies the broker name. Default is localhost . |
deleteAllMessagesOnStartup | If true , deletes all the messages in the persistent store as the broker starts up. Default is false . |
enableStatistics | If true , enables statistics gathering in the broker. Default is true . |
Dependencies
Appendix A. OpenWire Format Options
Table A.1. Wire Format Options Supported by OpenWire Protocol
Option | Default | Description | Negotiation Policy |
---|---|---|---|
wireformat.stackTraceEnabled | true | Specifies if the stack trace of an exception occurring on the broker is sent to the client. | false if either side is false . |
wireformat.tcpNoDelayEnabled | false | Specifies if a hint is provided to the peer that TCP nodelay should be enabled on the communications socket. | false if either side is false . |
wireformat.cacheEnabled | true | Specifies that commonly repeated values are cached so that less marshalling occurs. | false if either side is false . |
wireformat.cacheSize | 1024 | Specifies the maximum number of values to cache. | Use the smaller of the two values. |
wireformat.tightEncodingEnabled | true | Specifies if wire size be optimized over CPU usage. | false if either side is false . |
wireformat.prefixPacketSize | true | Specifies if the size of the packet be prefixed before each packet is marshalled. | true if both sides are true . |
wireformat.maxInactivityDuration | 30000 | Specifies the maximum inactivity duration, in milliseconds, before the broker considers the connection dead and kills it. <= 0 disables inactivity monitoring. | Use the smaller of the two values. |
wireformat.maxInactivityDurationInitalDelay | 10000 | Specifies the initial delay in starting inactivity checks. |
Appendix B. Client Connection Options
Overview
Example B.1. Client Connection Options Syntax
URI?jms.option?jms.option...
jms.
Options
Table B.1. Client Connection Options
Option | Default | Description |
---|---|---|
alwaysSessionAsync | true | Specifies if a separate thread is used for dispatching messages for each Session in the Connection . However, a separate thread is always used if there is more than one session, or the session isn't in auto acknowledge or dups ok mode. |
clientID | Specifies the JMS clientID to use for the connection. | |
closeTimeout | 15000 | Specifies the timeout, in milliseconds, before a connection close is considered complete. Normally a close() on a connection waits for confirmation from the broker; this allows that operation to timeout and save the client from hanging if there is no broker. |
copyMessageOnSend | true | Specifies if a JMS message should be copied to a new JMS Message object as part of the send() method in JMS. This is enabled by default to be compliant with the JMS specification. Disabling this can give you a performance, however you must not mutate JMS messages after they are sent. |
disableTimeStampsByDefault | false | Specifies whether or not timestamps on messages should be disabled or not. Disabling them it adds a small performance boost. |
dispatchAsync | false | Specifies if the broker dispatches messages to the consumer asynchronously. |
nestedMapAndListEnabled | true | Enables/disables whether or not structured message properties and MapMessages are supported so that Message properties and MapMessage entries can contain nested Map and List objects. |
objectMessageSerializationDefered | false | Specifies that the serialization of objects when they are set on an ObjectMessage is deferred. The object may subsequently get serialized if the message needs to be sent over a socket or stored to disk. |
optimizeAcknowledge | false | Specifies if messages are acknowledged in batches rather than individually. Enabling this could cause some issues with auto-acknowledgement on reconnection. |
optimizeAcknowledgeTimeOut | 300 | Specifies the maximum time, in milliseconds, between batch acknowledgements when optimizeAcknowledge is enabled. |
optimizedMessageDispatch | true | Specifies if a larger prefetch limit is used for durable topic subscribers. |
useAsyncSend | false | Specifies in sends are performed asynchronously. Asynchronous sends provide a significant performance boost. The tradeoff is that the send() method will return immediately whether the message has been sent or not which could lead to message loss. |
useCompression | false | Specifies if message bodies are compressed. |
useRetroactiveConsumer | false | Specifies whether or not retroactive consumers are enabled. Retroactive consumers allow non-durable topic subscribers to receive messages that were published before the non-durable subscriber started. |
warnAboutUnstartedConnectionTimeout | 500 | Specifies the timeout, in milliseconds, from connection creation to when a warning is generated if the connection is not properly started and a message is received by a consumer. -1 disables the warnings. |
auditDepth | 2048 | Specifies the size of the message window that will be audited for duplicates and out of order messages. |
auditMaximumProducerNumber | 64 | Specifies the maximum number of producers that will be audited. |
alwaysSyncSend | false | Specifies if a message producer will always use synchronous sends when sending a message. |
blobTransferPolicy.* | Used to configure how the client handles blob messages. See the section called “Blob handling”. | |
prefetchPolicy.* | Used to configure the prefect limits. See the section called “Prefetch limits”. | |
redeliveryPolicy.* | Used to configure the redelivery policy. See the section called “Redelivery policy”. |
Blob handling
jms.blobTransferPolicy.
Table B.2. Blob Message Properties
Option | Description |
---|---|
bufferSize | Specifies the size of the buffer used when uploading or downloading blobs. |
uploadUrl | Specifies the URL to which blob messages are stored for transfer. This value overrides the upload URI configured by the broker. |
Prefetch limits
jms.prefetchPolicy.
Table B.3. Connection URI Prefect Limit Options
Option | Description |
---|---|
queuePrefetch | Specifies the prefect limit for all consumers using queues. |
queueBrowserPrefetch | Specifies the prefect limit for all queue browsers. |
topicPrefetch | Specifies the prefect limit for non-durable topic consumers. |
durableTopicPrefetch | Specifies the prefect limit for durable topic consumers. |
all | Specifies the prefect limit for all types of message consumers. |
Redelivery policy
jms.redeliveryPolicy.
Table B.4. Redelivery Policy Options
Option | Default | Description |
---|---|---|
collisionAvoidanceFactor | 0.15 | Specifies the percentage of range of collision avoidance. |
maximumRedeliveries | 6 | Specifies the maximum number of times a message will be redelivered before it is considered a poisoned pill and returned to the broker so it can go to a dead letter queue. -1 specifies an infinite number of redeliveries. |
maximumRedeliveryDelay | -1 | Specifies the maximum delivery delay that will be applied if the useExponentialBackOff option is set. -1 specifies that no maximum be applied. |
initialRedeliveryDelay | 1000 | Specifies the initial redelivery delay in milliseconds. |
redeliveryDelay | 1000 | Specifies the delivery delay, in milliseconds, if initialRedeliveryDelay is 0. |
useCollisionAvoidance | false | Specifies if the redelivery policy uses collision avoidance. |
useExponentialBackOff | false | Specifies if the redelivery time out should be increased exponentially. |
backOffMultiplier | 5 | Specifies the back-off multiplier. |
Index
C
- connection socket, Setting transport options, Setting transport options, Setting transport options
D
- discovery agent
- Fuse Fabric, Fabric agent
- multicast, Multicast agent
- static, Static agent
- zeroconf, Zeroconf agent
- discovery protocol
- backOffMultiplier, Transport options
- initialReconnectDelay, Transport options
- maxReconnectAttempts, Transport options
- maxReconnectDelay, Transport options
- URI, URI syntax
- useExponentialBackOff, Transport options
- discovery URI, URI syntax
- discovery:, URI syntax
E
- embedded broker
- brokerName, Broker options
- deleteAllMessagesOnStartup, Broker options
- enableStatistics, Broker options
- persistent, Broker options
- populateJMSXUserID, Broker options
- useJmx, Broker options
- useShutdownHook, Broker options
F
- fabric://, Fabric agent
- fanout protocol
- backOffMultiplier, Transport options
- fanOutQueues, Transport options
- initialReconnectDelay, Transport options
- maxReconnectAttempts, Transport options
- maxReconnectDelay, Transport options
- minAckCount, Transport options
- URI, URI syntax
- useExponentialBackOff, Transport options
- fanout URI, URI syntax
- fanout://, URI syntax
- Fuse Fabric discovery agent
- URI, Fabric agent
H
- HTTP
- URI, URI syntax
- HTTPS
- URI, URI syntax
L
- listener socket, Setting transport options, Setting transport options, Setting transport options
M
- MQTT, URI syntax
- MQTT+NIO, URI syntax
- MQTT+SSL, URI syntax
- Multicast, URI syntax
- multicast discovery agent
- URI, Multicast agent
- multicast://, Multicast agent
N
- NIO
- URI, URI syntax
- NIO+SSL
- URI, URI syntax
O
- OpenWire
- HTTP, URI syntax
- HTTPS, URI syntax
- NIO, URI syntax
- NIO+SSL, URI syntax
- SSL, URI syntax
- TCP, URI syntax
- transport options, Setting transport options, Setting transport options, Setting transport options
- UDP, URI syntax
S
- SSL
- URI, URI syntax
- static discovery agent
- URI, Static agent
- static://, Static agent
- STOMP, URI syntax
- STOMP+NIO, URI syntax
- STOMP+SSL, URI syntax
T
- TCP
- URI, URI syntax
- transport connector, Setting transport options, Setting transport options, Setting transport options
U
- UDP
- URI, URI syntax
- URI
- HTTP, URI syntax
- HTTPS, URI syntax
- MQTT, URI syntax
- MQTT+NIO, URI syntax
- MQTT+SSL, URI syntax
- Multicast, URI syntax
- NIO, URI syntax
- NIO+SSL, URI syntax
- SSL, URI syntax
- STOMP, URI syntax
- STOMP+NIO, URI syntax
- STOMP+SSL, URI syntax
- TCP, URI syntax
- UDP, URI syntax
V
- VM
- advanced URI, URI syntax
- broker configuration, Broker options
- broker name, URI syntax
- brokerConfig, Broker options
- create, Transport options
- marshal, Transport options
- simple URI, Simple VM URI Syntax
- waitForStart, Transport options
- wireFormat, Transport options
- VM URI
- advanced, URI syntax
- simple, Simple VM URI Syntax
Z
- zeroconf discovery agent
- URI, Zeroconf agent
- zeroconf://, Zeroconf agent
Legal Notice
Trademark Disclaimer
Legal Notice
Third Party Acknowledgements
- JLine (http://jline.sourceforge.net) jline:jline:jar:1.0License: BSD (LICENSE.txt) - Copyright (c) 2002-2006, Marc Prud'hommeaux
mwp1@cornell.edu
All rights reserved.Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of JLine nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - Stax2 API (http://woodstox.codehaus.org/StAX2) org.codehaus.woodstox:stax2-api:jar:3.1.1License: The BSD License (http://www.opensource.org/licenses/bsd-license.php)Copyright (c) <YEAR>, <OWNER> All rights reserved.Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - jibx-run - JiBX runtime (http://www.jibx.org/main-reactor/jibx-run) org.jibx:jibx-run:bundle:1.2.3License: BSD (http://jibx.sourceforge.net/jibx-license.html) Copyright (c) 2003-2010, Dennis M. Sosnoski.All rights reserved.Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - JavaAssist (http://www.jboss.org/javassist) org.jboss.javassist:com.springsource.javassist:jar:3.9.0.GA:compileLicense: MPL (http://www.mozilla.org/MPL/MPL-1.1.html)
- HAPI-OSGI-Base Module (http://hl7api.sourceforge.net/hapi-osgi-base/) ca.uhn.hapi:hapi-osgi-base:bundle:1.2License: Mozilla Public License 1.1 (http://www.mozilla.org/MPL/MPL-1.1.txt)