Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

The SJMS Component supports the following configuration options:

Div
classconfluenceTableSmall

Option

Required

Default Value

Description

connectionCount

 

1

The maximum number of connections available to endpoints started under this component

connectionFactory

(tick)

null

A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource.

connectionResource

 

null

A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details.

headerFilterStrategy

 

DefaultJmsKeyFormatStrategy

 

keyFormatStrategy

 

DefaultJmsKeyFormatStrategy

 

transactionCommitStrategy

 

null

 

Wiki Markup
{div:class=confluenceTableSmall} || Option || Required || Default Value || Description || | {{connectionCount}} | | {{1}} | The maximum number of connections available to endpoints started under this component | | {{connectionFactory}} | (/) | {{null}} | A [ConnectionFactory|http://docs.oracle.com/javaee/5/api/javax/jms/ConnectionFactory.html] is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource. | | {{connectionResource}} | | {{null}} | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See [Plugable Connection Resource Management|#connectionresource] for further details. | | {{headerFilterStrategy}} | | {{DefaultJmsKeyFormatStrategy}} | | | {{keyFormatStrategy}} | | {{DefaultJmsKeyFormatStrategy}} | | | {{transactionCommitStrategy}} | | {{null}} | | {div}

Below is an example of how to configure the SjmsComponent with its required ConnectionFactory provider. It will create a single connection by default and store it using the components internal pooling APIs to ensure that it is able to service Session creation requests in a thread safe manner.

...

The SjmsProducer Endpoint supports the following properties:

Div
classconfluenceTableSmall
Wiki Markup
{div:class=confluenceTableSmall} || Option || Default Value || Description || | {{acknowledgementMode}} | {{AUTO_ACKNOWLEDGE}} | The JMS acknowledgement name, which is one of: {{SESSION_TRANSACTED}}, {{AUTO_ACKNOWLEDGE}} or {{

Option

Default Value

Description

acknowledgementMode

AUTO_ACKNOWLEDGE

The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, AUTO_ACKNOWLEDGE or

DUPS_OK_ACKNOWLEDGE

}}

.

{{

CLIENT_ACKNOWLEDGE

}}

is

not

supported

at

this

time.

| | {{consumerCount}} | {{1}} | *InOut only.* Defines the number of [MessageListener|http://docs.oracle.com/javaee/5/api/javax/jms/MessageListener.html] instances that for response consumers. | | {{exchangePattern}} | {{InOnly}} | Sets the Producers message exchange pattern. | | {{namedReplyTo}} | {{null}} | *InOut only.* Specifies a named reply to destination for responses. | | {{persistent}} | {{true}} | Whether a message should be delivered with persistence enabled. | | {{producerCount}} | {{1}} | Defines the number of [MessageProducer|http://docs.oracle.com/javaee/5/api/javax/jms/MessageProducer.html] instances. | | {{responseTimeOut}} | {{5000}} | *InOut only.* Specifies the amount of time an InOut Producer will wait for its response. | | {{synchronous}} | {{true}} | Sets whether the Endpoint will use synchronous or asynchronous processing. | | {{transacted}} | {{false}} | If the endpoint should use a JMS Session transaction. | | {{ttl}} | {{\-1}} | Disabled by default. Sets the Message time to live header. | {div}

consumerCount

1

InOut only. Defines the number of MessageListener instances that for response consumers.

exchangePattern

InOnly

Sets the Producers message exchange pattern.

namedReplyTo

null

InOut only. Specifies a named reply to destination for responses.

persistent

true

Whether a message should be delivered with persistence enabled.

producerCount

1

Defines the number of MessageProducer instances.

responseTimeOut

5000

InOut only. Specifies the amount of time an InOut Producer will wait for its response.

synchronous

true

Sets whether the Endpoint will use synchronous or asynchronous processing.

transacted

false

If the endpoint should use a JMS Session transaction.

ttl

-1

Disabled by default. Sets the Message time to live header.

Producer Usage

InOnly Producer - (Default)

...

The SjmsConsumer Endpoint supports the following properties:

Div
classconfluenceTableSmall
Wiki Markup
{div:class=confluenceTableSmall} || Option || Default Value || Description || | {{acknowledgementMode}} | {{AUTO_ACKNOWLEDGE}} | The JMS acknowledgement name, which is one of: {{TRANSACTED}}, {{AUTO_ACKNOWLEDGE}} or {{

Option

Default Value

Description

acknowledgementMode

AUTO_ACKNOWLEDGE

The JMS acknowledgement name, which is one of: TRANSACTED, AUTO_ACKNOWLEDGE or

DUPS_OK_ACKNOWLEDGE

}}

.

{{

CLIENT_ACKNOWLEDGE

}}

is

not

supported

at

this

time.

| | {{consumerCount}} | {{1}} | Defines the number of [MessageListener|http://docs.oracle.com/javaee/5/api/javax/jms/MessageListener.html] instances. | | {{durableSubscriptionId}} | {{null}} | Required for a durable subscriptions. | | {{exchangePattern}} | {{InOnly}} | Sets the Consumers message exchange pattern. | | {{messageSelector}} | {{null}} | Sets the message selector. | | {{synchronous}} | {{true}} | Sets whether the Endpoint will use synchronous or asynchronous processing. | | {{transacted}} | {{false}} | If the endpoint should use a JMS Session transaction. | | {{transactionBatchCount}} | {{1}} | The number of exchanges to process before committing a local JMS transaction. The {{transacted}} property must also be set to true or this property will be ignored. | | {{transactionBatchTimeout}} | {{5000}} | The amount of time a the transaction will stay open between messages before committing what has already been consumed. Minimum value is 1000ms. | | {{ttl}} | {{\-1}} | Disabled by default. Sets the Message time to live header. | {div}

consumerCount

1

Defines the number of MessageListener instances.

durableSubscriptionId

null

Required for a durable subscriptions.

exchangePattern

InOnly

Sets the Consumers message exchange pattern.

messageSelector

null

Sets the message selector.

synchronous

true

Sets whether the Endpoint will use synchronous or asynchronous processing.

transacted

false

If the endpoint should use a JMS Session transaction.

transactionBatchCount

1

The number of exchanges to process before committing a local JMS transaction. The transacted property must also be set to true or this property will be ignored.

transactionBatchTimeout

5000

The amount of time a the transaction will stay open between messages before committing what has already been consumed. Minimum value is 1000ms.

ttl

-1

Disabled by default. Sets the Message time to live header.

Consumer Usage

InOnly Consumer - (Default)

...