element connectionFactory in namespace http://activemq.apache.org/schema/core

Overview

Namespace

Component

Index

Help

FUSE ESB 4.4 XML Configuration Reference

SUMMARY: DOCUMENTATION | ELEMENTS | ATTRIBUTES

FRAMES | NO FRAMES

http://activemq.apache.org/schema/core
element connectionFactory

Model: <connectionFactory alwaysSessionAsync = boolean alwaysSyncSend = boolean auditDepth = integer auditMaximumProducerNumber = integer beanName = string blobTransferPolicy = string brokerURL = string checkForDuplicates = boolean clientID = string clientIdGenerator = string clientIDPrefix = string clientInternalExceptionListener = string closeTimeout = integer connectionIdGenerator = string connectionIDPrefix = string consumerFailoverRedeliveryWaitPeriod = long copyMessageOnSend = boolean disableTimeStampsByDefault = boolean dispatchAsync = boolean exceptionListener = string exclusiveConsumer = boolean id = ID messagePrioritySupported = boolean nestedMapAndListEnabled = boolean objectMessageSerializationDefered = boolean optimizeAcknowledge = boolean optimizeAcknowledgeTimeOut = long optimizedMessageDispatch = boolean password = string prefetchPolicy = string producerWindowSize = integer properties = string redeliveryPolicy = string sendAcksAsync = boolean sendTimeout = integer statsEnabled = boolean transformer = string transportListener = string useAsyncSend = boolean useBeanNameAsClientIdPrefix = boolean useCompression = boolean useDedicatedTaskRunner = boolean useRetroactiveConsumer = boolean userName = string warnAboutUnstartedConnectionTimeout = long watchTopicAdvisories = boolean (any attribute from any namespace other than http://activemq.apache.org/schema/core)> blobTransferPolicy?, clientIdGenerator?, clientInternalExceptionListener?, connectionIdGenerator?, exceptionListener?, prefetchPolicy?, properties?, redeliveryPolicy?, transformer?, transportListener?, (any element from any namespace other than http://activemq.apache.org/schema/core) </connectionFactory>

Disallowed substitutions (block): none (extensions, restrictions and substitutions are allowed)

Substitution group exclusion (final): none (extensions and restrictions are allowed)

Content Type: element-only content, not nillable.

Usage: This element can be the root element of XML instance documents.
This element can be a child of the following elements: jmsTopicConnector/localTopicConnectionFactory, jmsTopicConnector/outboundTopicConnectionFactory, jmsQueueConnector/localQueueConnectionFactory, jmsQueueConnector/outboundQueueConnectionFactory, commandAgent/connectionFactory.

Documentation

        A <a href="http://www.springframework.org/">Spring</a> enhanced connection
factory which will automatically use the Spring bean name as the clientIDPrefix property
so that connections created have client IDs related to your Spring.xml file for
easier comprehension from <a href="http://activemq.apache.org/jmx.html">JMX</a>.

Nested Element Summary

sequence

`anonymous type derived from anyType`	`blobTransferPolicy` optional Sets the policy used to describe how out-of-band BLOBs (Binary Large OBjects) are transferred from producers to brokers to consumers
`anonymous type derived from anyType`	`clientIdGenerator` optional
`anonymous type derived from anyType`	`clientInternalExceptionListener` optional Allows an {@link ClientInternalExceptionListener} to be configured on the ConnectionFactory so that when this factory is used by frameworks which don't expose the Connection such as Spring JmsTemplate, you can register an exception listener.
`anonymous type derived from anyType`	`connectionIdGenerator` optional
`anonymous type derived from anyType`	`exceptionListener` optional Allows an {@link ExceptionListener} to be configured on the ConnectionFactory so that when this factory is used by frameworks which don't expose the Connection such as Spring JmsTemplate, you can register an exception listener.
`anonymous type derived from anyType`	`prefetchPolicy` optional Sets the <a href="http://activemq.apache.org/what-is-the-prefetch-limit-for.html">prefetch policy</a> for consumers created by this connection.
`anonymous type derived from anyType`	`properties` optional Get the properties from this instance for storing in JNDI
`anonymous type derived from anyType`	`redeliveryPolicy` optional Sets the global redelivery policy to be used when a message is delivered but the session is rolled back
`anonymous type derived from anyType`	`transformer` optional Sets the transformer used to transform messages before they are sent on to the JMS bus or when they are received from the bus but before they are delivered to the JMS client
`anonymous type derived from anyType`	`transportListener` optional Allows a listener to be configured on the ConnectionFactory so that when this factory is used with frameworks which don't expose the Connection such as Spring JmsTemplate, you can still register a transport listener.

Attribute Summary
`boolean`	`alwaysSessionAsync` If this flag is set then a separate thread is not used for dispatching messages for each Session in the Connection.
`boolean`	`alwaysSyncSend` Set true if always require messages to be sync sent
`integer`	`auditDepth`
`integer`	`auditMaximumProducerNumber`
`string`	`beanName`
`string`	`blobTransferPolicy` Sets the policy used to describe how out-of-band BLOBs (Binary Large OBjects) are transferred from producers to brokers to consumers
`string`	`brokerURL` Sets the <a href="http://activemq.apache.org/configuring-transports.html">connection URL</a> used to connect to the ActiveMQ broker.
`boolean`	`checkForDuplicates`
`string`	`clientID` Sets the JMS clientID to use for the created connection.
`string`	`clientIdGenerator`
`string`	`clientIDPrefix` Sets the prefix used by autogenerated JMS Client ID values which are used if the JMS client does not explicitly specify on.
`string`	`clientInternalExceptionListener` Allows an {@link ClientInternalExceptionListener} to be configured on the ConnectionFactory so that when this factory is used by frameworks which don't expose the Connection such as Spring JmsTemplate, you can register an exception listener.
`integer`	`closeTimeout` Sets the timeout before a close is considered complete.
`string`	`connectionIdGenerator`
`string`	`connectionIDPrefix` Sets the prefix used by connection id generator
`long`	`consumerFailoverRedeliveryWaitPeriod`
`boolean`	`copyMessageOnSend` Should a JMS message be copied to a new JMS Message object as part of the send() method in JMS.
`boolean`	`disableTimeStampsByDefault` Sets whether or not timestamps on messages should be disabled or not.
`boolean`	`dispatchAsync` Enables or disables the default setting of whether or not consumers have their messages <a href="http://activemq.apache.org/consumer-dispatch-async.html">dispatched synchronously or asynchronously by the broker</a>.
`string`	`exceptionListener` Allows an {@link ExceptionListener} to be configured on the ConnectionFactory so that when this factory is used by frameworks which don't expose the Connection such as Spring JmsTemplate, you can register an exception listener.
`boolean`	`exclusiveConsumer` Enables or disables whether or not queue consumers should be exclusive or not for example to preserve ordering when not using <a href="http://activemq.apache.org/message-groups.html">Message Groups</a>
`ID`	`id`
`boolean`	`messagePrioritySupported`
`boolean`	`nestedMapAndListEnabled` Enables/disables whether or not Message properties and MapMessage entries support <a href="http://activemq.apache.org/structured-message-properties-and-mapmessages.html">Nested Structures</a> of Map and List objects
`boolean`	`objectMessageSerializationDefered` When an object is set on an ObjectMessage, the JMS spec requires the object to be serialized by that set method.
`boolean`	`optimizeAcknowledge`
`long`	`optimizeAcknowledgeTimeOut` The max time in milliseconds between optimized ack batches
`boolean`	`optimizedMessageDispatch` If this flag is set then an larger prefetch limit is used - only applicable for durable topic subscribers.
`string`	`password` Sets the JMS password used for connections created from this factory
`string`	`prefetchPolicy` Sets the <a href="http://activemq.apache.org/what-is-the-prefetch-limit-for.html">prefetch policy</a> for consumers created by this connection.
`integer`	`producerWindowSize`
`string`	`properties` Get the properties from this instance for storing in JNDI
`string`	`redeliveryPolicy` Sets the global redelivery policy to be used when a message is delivered but the session is rolled back
`boolean`	`sendAcksAsync`
`integer`	`sendTimeout`
`boolean`	`statsEnabled`
`string`	`transformer` Sets the transformer used to transform messages before they are sent on to the JMS bus or when they are received from the bus but before they are delivered to the JMS client
`string`	`transportListener` Allows a listener to be configured on the ConnectionFactory so that when this factory is used with frameworks which don't expose the Connection such as Spring JmsTemplate, you can still register a transport listener.
`boolean`	`useAsyncSend` Forces the use of <a href="http://activemq.apache.org/async-sends.html">Async Sends</a> which adds a massive performance boost; but means that the send() method will return immediately whether the message has been sent or not which could lead to message loss.
`boolean`	`useBeanNameAsClientIdPrefix`
`boolean`	`useCompression` Enables the use of compression of the message bodies
`boolean`	`useDedicatedTaskRunner`
`boolean`	`useRetroactiveConsumer` Sets whether or not retroactive consumers are enabled.
`string`	`userName` Sets the JMS userName used by connections created by this factory
`long`	`warnAboutUnstartedConnectionTimeout` Enables the timeout from a connection creation to when a warning is generated if the connection is not properly started via {@link Connection#start()} and a message is received by a consumer.
`boolean`	`watchTopicAdvisories`

Attribute Detail

alwaysSessionAsync

Documentation

            If this flag is set then a separate thread is not 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 duplicates ok mode

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

alwaysSyncSend

Documentation

            Set true if always require messages to be sync sent

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

auditDepth

Definition: Defined with global type integer

Model: integer

Attribute Usage: optional

Fundamental Facets: equality, numeric, unbounded, totaly ordered, countable infinite value space

White Space Processing: collapse

auditMaximumProducerNumber

Definition: Defined with global type integer

Model: integer

Attribute Usage: optional

Fundamental Facets: equality, numeric, unbounded, totaly ordered, countable infinite value space

White Space Processing: collapse

beanName

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

blobTransferPolicy

Documentation

            Sets the policy used to describe how out-of-band BLOBs (Binary Large
OBjects) are transferred from producers to brokers to consumers

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

brokerURL

Documentation

            Sets the <a
href="http://activemq.apache.org/configuring-transports.html">connection
URL</a> used to connect to the ActiveMQ broker.

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

checkForDuplicates

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

clientID

Documentation

            Sets the JMS clientID to use for the created connection. Note that this
can only be used by one connection at once so generally its a better idea
to set the clientID on a Connection

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

clientIdGenerator

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

clientIDPrefix

Documentation

            Sets the prefix used by autogenerated JMS Client ID values which are used
if the JMS client does not explicitly specify on.

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

clientInternalExceptionListener

Documentation

            Allows an {@link ClientInternalExceptionListener} to be configured on the ConnectionFactory so that when this factory
is used by frameworks which don't expose the Connection such as Spring JmsTemplate, you can register
an exception listener.
<p> Note: access to this clientInternalExceptionListener will <b>not</b> be serialized if it is associated with more than
on connection (as it will be if more than one connection is subsequently created by this connection factory)

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

closeTimeout

Documentation

            Sets the timeout before a close is considered complete. Normally a
close() on a connection waits for confirmation from the broker; this
allows that operation to timeout to save the client hanging if there is
no broker

Definition: Defined with global type integer

Model: integer

Attribute Usage: optional

Fundamental Facets: equality, numeric, unbounded, totaly ordered, countable infinite value space

White Space Processing: collapse

connectionIdGenerator

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

connectionIDPrefix

Documentation

            Sets the prefix used by connection id generator

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

consumerFailoverRedeliveryWaitPeriod

Definition: Defined with global type long

Model: long

Attribute Usage: optional

Fundamental Facets: equality, numeric, bounded, totaly ordered, countable infinite value space

White Space Processing: collapse

copyMessageOnSend

Documentation

            Should a JMS message 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. You can disable it if you do not mutate JMS messages
after they are sent for a performance boost

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

disableTimeStampsByDefault

Documentation

            Sets whether or not timestamps on messages should be disabled or not. If
you disable them it adds a small performance boost.

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

dispatchAsync

Documentation

            Enables or disables the default setting of whether or not consumers have
their messages <a
href="http://activemq.apache.org/consumer-dispatch-async.html">dispatched
synchronously or asynchronously by the broker</a>. For non-durable
topics for example we typically dispatch synchronously by default to
minimize context switches which boost performance. However sometimes its
better to go slower to ensure that a single blocked consumer socket does
not block delivery to other consumers.

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

exceptionListener

Documentation

            Allows an {@link ExceptionListener} to be configured on the ConnectionFactory so that when this factory
is used by frameworks which don't expose the Connection such as Spring JmsTemplate, you can register
an exception listener.
<p> Note: access to this exceptionLinstener will <b>not</b> be serialized if it is associated with more than
on connection (as it will be if more than one connection is subsequently created by this connection factory)

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

exclusiveConsumer

Documentation

            Enables or disables whether or not queue consumers should be exclusive or
not for example to preserve ordering when not using <a
href="http://activemq.apache.org/message-groups.html">Message Groups</a>

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

id

Definition: Defined with global type ID

Model: ID

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

messagePrioritySupported

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

nestedMapAndListEnabled

Documentation

            Enables/disables whether or not Message properties and MapMessage entries
support <a
href="http://activemq.apache.org/structured-message-properties-and-mapmessages.html">Nested
Structures</a> of Map and List objects

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

objectMessageSerializationDefered

Documentation

            When an object is set on an ObjectMessage, the JMS spec requires the
object to be serialized by that set method. Enabling this flag causes the
object to not get serialized. The object may subsequently get serialized
if the message needs to be sent over a socket or stored to disk.

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

optimizeAcknowledge

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

optimizeAcknowledgeTimeOut

Documentation

            The max time in milliseconds between optimized ack batches

Definition: Defined with global type long

Model: long

Attribute Usage: optional

Fundamental Facets: equality, numeric, bounded, totaly ordered, countable infinite value space

White Space Processing: collapse

optimizedMessageDispatch

Documentation

            If this flag is set then an larger prefetch limit is used - only
applicable for durable topic subscribers.

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

password

Documentation

            Sets the JMS password used for connections created from this factory

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

prefetchPolicy

Documentation

            Sets the <a
href="http://activemq.apache.org/what-is-the-prefetch-limit-for.html">prefetch
policy</a> for consumers created by this connection.

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

producerWindowSize

Definition: Defined with global type integer

Model: integer

Attribute Usage: optional

Fundamental Facets: equality, numeric, unbounded, totaly ordered, countable infinite value space

White Space Processing: collapse

properties

Documentation

            Get the properties from this instance for storing in JNDI

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

redeliveryPolicy

Documentation

            Sets the global redelivery policy to be used when a message is delivered
but the session is rolled back

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

sendAcksAsync

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

sendTimeout

Definition: Defined with global type integer

Model: integer

Attribute Usage: optional

Fundamental Facets: equality, numeric, unbounded, totaly ordered, countable infinite value space

White Space Processing: collapse

statsEnabled

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

transformer

Documentation

            Sets the transformer used to transform messages before they are sent on
to the JMS bus or when they are received from the bus but before they are
delivered to the JMS client

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

transportListener

Documentation

            Allows a listener to be configured on the ConnectionFactory so that when this factory is used
with frameworks which don't expose the Connection such as Spring JmsTemplate, you can still register
a transport listener.

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

useAsyncSend

Documentation

            Forces the use of <a
href="http://activemq.apache.org/async-sends.html">Async Sends</a> which
adds a massive performance boost; but means that the send() method will
return immediately whether the message has been sent or not which could
lead to message loss.

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

useBeanNameAsClientIdPrefix

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

useCompression

Documentation

            Enables the use of compression of the message bodies

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

useDedicatedTaskRunner

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

useRetroactiveConsumer

Documentation

            Sets whether or not retroactive consumers are enabled. Retroactive
consumers allow non-durable topic subscribers to receive old messages
that were published before the non-durable subscriber started.

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

userName

Documentation

            Sets the JMS userName used by connections created by this factory

Definition: Defined with global type string

Model: string

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, countable infinite value space

White Space Processing: collapse

warnAboutUnstartedConnectionTimeout

Documentation

            Enables the timeout from a connection creation to when a warning is
generated if the connection is not properly started via
{@link Connection#start()} and a message is received by a consumer. It is
a very common gotcha to forget to <a
href="http://activemq.apache.org/i-am-not-receiving-any-messages-what-is-wrong.html">start
the connection</a> so this option makes the default case to create a
warning if the user forgets. To disable the warning just set the value to <
0 (say -1).

Definition: Defined with global type long

Model: long

Attribute Usage: optional

Fundamental Facets: equality, numeric, bounded, totaly ordered, countable infinite value space

White Space Processing: collapse

watchTopicAdvisories

Definition: Defined with global type boolean

Model: boolean

Attribute Usage: optional

Fundamental Facets: equality, non-numeric, unbounded, unordered, finit value space

White Space Processing: collapse

Overview

Namespace

Component

Index

Help

FUSE ESB 4.4 XML Configuration Reference

SUMMARY: DOCUMENTATION | ELEMENTS | ATTRIBUTES

FRAMES | NO FRAMES

FUSE ESB 4.4 XML Configuration Reference

http://activemq.apache.org/schema/core element connectionFactory

alwaysSessionAsync

alwaysSyncSend

auditDepth

auditMaximumProducerNumber

beanName

blobTransferPolicy

brokerURL

checkForDuplicates

clientID

clientIdGenerator

clientIDPrefix

clientInternalExceptionListener

closeTimeout

connectionIdGenerator

connectionIDPrefix

consumerFailoverRedeliveryWaitPeriod

copyMessageOnSend

disableTimeStampsByDefault

dispatchAsync

exceptionListener

exclusiveConsumer

id

messagePrioritySupported

nestedMapAndListEnabled

objectMessageSerializationDefered

optimizeAcknowledge

optimizeAcknowledgeTimeOut

optimizedMessageDispatch

password

prefetchPolicy

producerWindowSize

properties

redeliveryPolicy

sendAcksAsync

sendTimeout

statsEnabled

transformer

transportListener

useAsyncSend

useBeanNameAsClientIdPrefix

useCompression

useDedicatedTaskRunner

useRetroactiveConsumer

userName

warnAboutUnstartedConnectionTimeout

watchTopicAdvisories

http://activemq.apache.org/schema/core
element connectionFactory