Root Element

ElementDescriptionClass
brokerAn ActiveMQ Message Broker. It consists of a number of transport connectors, network connectors and a bunch of properties which can be used to configure the broker as its lazily created.org.apache.activemq.xbean.XBeanBrokerService

Element Summary

ElementDescriptionClass
abortSlowConsumerStrategyAbort slow consumers when they reach the configured threshold of slowness, default is slow for 30 secondsorg.apache.activemq.broker.region.policy.AbortSlowConsumerStrategy
amqPersistenceAdapterAn implementation of {@link PersistenceAdapter} designed for use with a {@link Journal} and then check pointing asynchronously on a timeout with some other long term persistent storage.org.apache.activemq.store.amq.AMQPersistenceAdapter
amqPersistenceAdapterFactoryAn implementation of {@link PersistenceAdapterFactory}org.apache.activemq.store.amq.AMQPersistenceAdapterFactory
authenticationUserA helper object used to configure simple authentiaction pluginorg.apache.activemq.security.AuthenticationUser
authorizationEntryRepresents an entry in a {@link DefaultAuthorizationMap} for assigning different operations (read, write, admin) of user roles to a specific destination or a hierarchical wildcard area of destinations.org.apache.activemq.security.AuthorizationEntry
authorizationMapRepresents a destination based configuration of policies so that individual destinations or wildcard hierarchies of destinations can be configured using different policies. Each entry in the map represents the authorization ACLs for each operation.org.apache.activemq.security.DefaultAuthorizationMap
authorizationPluginAn authorization plugin where each operation on a destination is checked against an authorizationMaporg.apache.activemq.security.AuthorizationPlugin
axionJDBCAdapterAxion specific Adapter. Axion does not seem to support ALTER statements or sub-selects. This means: - We cannot auto upgrade the schema was we roll out new versions of ActiveMQ - We cannot delete durable sub messages that have be acknowledged by all consumers.org.apache.activemq.store.jdbc.adapter.AxionJDBCAdapter
blobJDBCAdapterThis JDBCAdapter inserts and extracts BLOB data using the getBlob()/setBlob() operations. This is a little more involved since to insert a blob you have to: 1: insert empty blob. 2: select the blob 3: finally update the blob with data value. The databases/JDBC drivers that use this adapter are:
org.apache.activemq.store.jdbc.adapter.BlobJDBCAdapter
brokerAn ActiveMQ Message Broker. It consists of a number of transport connectors, network connectors and a bunch of properties which can be used to configure the broker as its lazily created.org.apache.activemq.xbean.XBeanBrokerService
brokerServiceManages the lifecycle of an ActiveMQ Broker. A BrokerService consists of a number of transport connectors, network connectors and a bunch of properties which can be used to configure the broker as its lazily created.org.apache.activemq.broker.BrokerService
bytesJDBCAdapterThis JDBCAdapter inserts and extracts BLOB data using the setBytes()/getBytes() operations. The databases/JDBC drivers that use this adapter are:org.apache.activemq.store.jdbc.adapter.BytesJDBCAdapter
commandAgentAn agent which listens to commands on a JMS destinationorg.apache.activemq.broker.util.CommandAgent
compositeDemandForwardingBridgeA demand forwarding bridge which works with multicast style transports where a single Transport could be communicating with multiple remote brokersorg.apache.activemq.network.CompositeDemandForwardingBridge
compositeQueueRepresents a virtual queue which forwards to a number of other destinations.org.apache.activemq.broker.region.virtual.CompositeQueue
compositeTopicRepresents a virtual topic which forwards to a number of other destinations.org.apache.activemq.broker.region.virtual.CompositeTopic
connectionDotFilePluginA DOT file creator plugin which creates a DOT file showing the current connectionsorg.apache.activemq.broker.view.ConnectionDotFilePlugin
connectionFactoryA Spring 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 JMX.org.apache.activemq.spring.ActiveMQConnectionFactory
constantPendingMessageLimitStrategyThis PendingMessageLimitStrategy is configured to a constant value for all subscriptions.org.apache.activemq.broker.region.policy.ConstantPendingMessageLimitStrategy
database-lockerRepresents an exclusive lock on a database to avoid multiple brokers running against the same logical database.org.apache.activemq.store.jdbc.DefaultDatabaseLocker
db2JDBCAdapterorg.apache.activemq.store.jdbc.adapter.DB2JDBCAdapter
defaultJDBCAdapterImplements all the default JDBC operations that are used by the JDBCPersistenceAdapter.

sub-classing is encouraged to override the default implementation of methods to account for differences in JDBC Driver implementations.

The JDBCAdapter inserts and extracts BLOB data using the getBytes()/setBytes() operations.

The databases/JDBC drivers that use this adapter are:

org.apache.activemq.store.jdbc.adapter.DefaultJDBCAdapter
defaultUsageCapacityIdentify if a limit has been reachedorg.apache.activemq.usage.DefaultUsageCapacity
demandForwardingBridgeForwards messages from the local broker to the remote broker based on demand.org.apache.activemq.network.DemandForwardingBridge
destinationDotFilePluginA DOT file creator plugin which creates a DOT file showing the current topic & queue hierarchies.org.apache.activemq.broker.view.DestinationDotFilePlugin
destinationEntryA default entry in a DestinationMap which holds a single value.org.apache.activemq.filter.DefaultDestinationMapEntry
discardingDLQBrokerPluginorg.apache.activemq.plugin.DiscardingDLQBrokerPlugin
fileCursorPending messagesorg.apache.activemq.broker.region.policy.FilePendingSubscriberMessageStoragePolicy
fileDurableSubscriberCursorPending messages for durable subscribersorg.apache.activemq.broker.region.policy.FilePendingDurableSubscriberMessageStoragePolicy
fileQueueCursorPendingorg.apache.activemq.broker.region.policy.FilePendingQueueMessageStoragePolicy
filteredDestinationRepresents a destination which is filtered using some predicate such as a selector so that messages are only dispatched to the destination if they match the filter.org.apache.activemq.broker.region.virtual.FilteredDestination
fixedCountSubscriptionRecoveryPolicyThis implementation of {@link SubscriptionRecoveryPolicy} will keep a fixed count of last messages.org.apache.activemq.broker.region.policy.FixedCountSubscriptionRecoveryPolicy
fixedSizedSubscriptionRecoveryPolicyThis implementation of {@link SubscriptionRecoveryPolicy} will keep a fixed amount of memory available in RAM for message history which is evicted in time order.org.apache.activemq.broker.region.policy.FixedSizedSubscriptionRecoveryPolicy
forcePersistencyModeBrokerA Plugin which allows to force every incoming message to be PERSISTENT or NON-PERSISTENT. Useful, if you have set the broker usage policy to process ONLY persistent or ONLY non-persistent messages.org.apache.activemq.plugin.ForcePersistencyModeBroker
forcePersistencyModeBrokerPluginA Plugin which allows to force every incoming message to be PERSISTENT or NON-PERSISTENT. Useful, if you have set the broker usage policy to process ONLY persistent or ONLY non-persistent messages.org.apache.activemq.plugin.ForcePersistencyModeBrokerPlugin
forwardingBridgeForwards all messages from the local broker to the remote broker.org.apache.activemq.network.ForwardingBridge
hsqldb-jdbc-adapterorg.apache.activemq.store.jdbc.adapter.HsqldbJDBCAdapter
imageBasedJDBCAdaptorProvides JDBCAdapter since that uses IMAGE datatype to hold binary data. The databases/JDBC drivers that use this adapter are:
  • Sybase
  • MS SQL
org.apache.activemq.store.jdbc.adapter.ImageBasedJDBCAdaptor
inboundQueueBridgeCreate an Inbound Queue Bridgeorg.apache.activemq.network.jms.InboundQueueBridge
inboundTopicBridgeCreate an Inbound Topic Bridgeorg.apache.activemq.network.jms.InboundTopicBridge
individualDeadLetterStrategyA {@link DeadLetterStrategy} where each destination has its own individual DLQ using the subject naming hierarchy.org.apache.activemq.broker.region.policy.IndividualDeadLetterStrategy
informixJDBCAdapterJDBC Adapter for Informix database. Because Informix database restricts length of composite primary keys, length of container name field and subscription id field must be reduced to 150 characters. Therefore be sure not to use longer names for container name and subscription id than 150 characters.org.apache.activemq.store.jdbc.adapter.InformixJDBCAdapter
jaasAuthenticationPluginProvides a JAAS based authentication pluginorg.apache.activemq.security.JaasAuthenticationPlugin
jaasCertificateAuthenticationPluginProvides a JAAS based SSL certificate authentication pluginorg.apache.activemq.security.JaasCertificateAuthenticationPlugin
jaasDualAuthenticationPluginProvides a JAAS based authentication pluginorg.apache.activemq.security.JaasDualAuthenticationPlugin
jdbcPersistenceAdapterA {@link PersistenceAdapter} implementation using JDBC for persistence storage. This persistence adapter will correctly remember prepared XA transactions, but it will not keep track of local transaction commits so that operations performed against the Message store are done as a single uow.org.apache.activemq.store.jdbc.JDBCPersistenceAdapter
jmsQueueConnectorA Bridge to other JMS Queue providersorg.apache.activemq.network.jms.JmsQueueConnector
jmsTopicConnectorA Bridge to other JMS Topic providersorg.apache.activemq.network.jms.JmsTopicConnector
journalPersistenceAdapterAn implementation of {@link PersistenceAdapter} designed for use with a {@link Journal} and then check pointing asynchronously on a timeout with some other long term persistent storage.org.apache.activemq.store.journal.JournalPersistenceAdapter
journalPersistenceAdapterFactoryFactory class that can create PersistenceAdapter objects.org.apache.activemq.store.journal.JournalPersistenceAdapterFactory
journaledJDBCCreates a default persistence model using the Journal and JDBCorg.apache.activemq.store.PersistenceAdapterFactoryBean
kahaDBAn implementation of {@link PersistenceAdapter} designed for use with a {@link Journal} and then check pointing asynchronously on a timeout with some other long term persistent storage.org.apache.activemq.store.kahadb.KahaDBPersistenceAdapter
kahaPersistenceAdapterorg.apache.activemq.store.kahadaptor.KahaPersistenceAdapter
lDAPAuthorizationMapAn {@link AuthorizationMap} which uses LDAPorg.apache.activemq.security.LDAPAuthorizationMap
lastImageSubscriptionRecoveryPolicyThis implementation of {@link SubscriptionRecoveryPolicy} will only keep the last message.org.apache.activemq.broker.region.policy.LastImageSubscriptionRecoveryPolicy
ldapNetworkConnectorclass to create dynamic network connectors listed in an directory server using the LDAP v3 protocol as defined in RFC 2251, the entries listed in the directory server must implement the ipHost and ipService objectClasses as defined in RFC 2307.org.apache.activemq.network.LdapNetworkConnector
loggingBrokerPluginA simple Broker intercepter which allows you to enable/disable logging.org.apache.activemq.broker.util.LoggingBrokerPlugin
managementContextAn abstraction over JMX mbean registrationorg.apache.activemq.broker.jmx.ManagementContext
masterConnectorConnects a Slave Broker to a Master when using Master Slave for High Availability of messages.org.apache.activemq.broker.ft.MasterConnector
maxdb-jdbc-adapterJDBC Adapter for the MaxDB database.org.apache.activemq.store.jdbc.adapter.MaxDBJDBCAdapter
memoryPersistenceAdapterorg.apache.activemq.store.memory.MemoryPersistenceAdapter
memoryUsageUsed to keep track of how much of something is being used so that a productive working set usage can be controlled. Main use case is manage memory usage.org.apache.activemq.usage.MemoryUsage
messageGroupHashBucketFactoryA factory to create instances of {@link SimpleMessageGroupMap} when implementing the Message Groups functionality.org.apache.activemq.broker.region.group.MessageGroupHashBucketFactory
mirroredQueueCreates Mirrored Queue using a prefix and postfix to define the topic name on which to mirror the queue to.org.apache.activemq.broker.region.virtual.MirroredQueue
multicastNetworkConnectorA network connector which uses some kind of multicast-like transport that communicates with potentially many remote brokers over a single logical {@link Transport} instance such as when using multicast. This implementation does not depend on multicast at all; any other group based transport could be used.org.apache.activemq.network.MulticastNetworkConnector
multicastTraceBrokerPluginA Broker interceptor which allows you to trace all operations to a Multicast socket.org.apache.activemq.broker.util.MulticastTraceBrokerPlugin
mysql-jdbc-adapterorg.apache.activemq.store.jdbc.adapter.MySqlJDBCAdapter
networkConnectorA network connector which uses a discovery agent to detect the remote brokers available and setup a connection to each available remote brokerorg.apache.activemq.network.DiscoveryNetworkConnector
noSubscriptionRecoveryPolicyThis SubscriptionRecoveryPolicy disable recovery of messages.org.apache.activemq.broker.region.policy.NoSubscriptionRecoveryPolicy
oldestMessageEvictionStrategyAn eviction strategy which evicts the oldest message first (which is the default).org.apache.activemq.broker.region.policy.OldestMessageEvictionStrategy
oldestMessageWithLowestPriorityEvictionStrategyAn eviction strategy which evicts the oldest message with the lowest priority first.org.apache.activemq.broker.region.policy.OldestMessageWithLowestPriorityEvictionStrategy
oracleJDBCAdapterImplements all the default JDBC operations that are used by the JDBCPersistenceAdapter.

Subclassing is encouraged to override the default implementation of methods to account for differences in JDBC Driver implementations.

The JDBCAdapter inserts and extracts BLOB data using the getBytes()/setBytes() operations.

The databases/JDBC drivers that use this adapter are:

org.apache.activemq.store.jdbc.adapter.OracleJDBCAdapter
outboundQueueBridgeCreate an Outbound Queue Bridgeorg.apache.activemq.network.jms.OutboundQueueBridge
outboundTopicBridgeCreate an Outbound Topic Bridgeorg.apache.activemq.network.jms.OutboundTopicBridge
pListStoreorg.apache.activemq.store.kahadb.plist.PListStore
policyEntryRepresents an entry in a {@link PolicyMap} for assigning policies to a specific destination or a hierarchical wildcard area of destinations.org.apache.activemq.broker.region.policy.PolicyEntry
policyMapRepresents a destination based configuration of policies so that individual destinations or wildcard hierarchies of destinations can be configured using different policies.org.apache.activemq.broker.region.policy.PolicyMap
postgresql-jdbc-adapterImplements all the default JDBC operations that are used by the JDBCPersistenceAdapter.

Subclassing is encouraged to override the default implementation of methods to account for differences in JDBC Driver implementations.

The JDBCAdapter inserts and extracts BLOB data using the getBytes()/setBytes() operations.

The databases/JDBC drivers that use this adapter are:

org.apache.activemq.store.jdbc.adapter.PostgresqlJDBCAdapter
prefetchPolicyDefines the prefetch message policies for different types of consumersorg.apache.activemq.ActiveMQPrefetchPolicy
prefetchRatePendingMessageLimitStrategyThis PendingMessageLimitStrategy sets the maximum pending message limit value to be a multiplier of the prefetch limit of the subscription.org.apache.activemq.broker.region.policy.PrefetchRatePendingMessageLimitStrategy
priorityNetworkDispatchPolicydispatch policy that ignores lower priority duplicate network consumers, used in conjunction with network bridge suppresDuplicateTopicSubscriptionsorg.apache.activemq.broker.region.policy.PriorityNetworkDispatchPolicy
proxyConnectororg.apache.activemq.proxy.ProxyConnector
queryBasedSubscriptionRecoveryPolicyThis implementation of {@link SubscriptionRecoveryPolicy} will perform a user specific query mechanism to load any messages they may have missed.org.apache.activemq.broker.region.policy.QueryBasedSubscriptionRecoveryPolicy
queueAn ActiveMQ Queueorg.apache.activemq.command.ActiveMQQueue
queueDispatchSelectorQueue dispatch policy that determines if a message can be sent to a subscriptionorg.apache.activemq.broker.region.QueueDispatchSelector
redeliveryPolicyConfiguration options used to control how messages are re-delivered when they are rolled back.org.apache.activemq.RedeliveryPolicy
roundRobinDispatchPolicySimple dispatch policy that sends a message to every subscription that matches the message.org.apache.activemq.broker.region.policy.RoundRobinDispatchPolicy
sharedDeadLetterStrategyA default implementation of {@link DeadLetterStrategy} which uses a constant destination.org.apache.activemq.broker.region.policy.SharedDeadLetterStrategy
simpleAuthenticationPluginProvides a simple authentication pluginorg.apache.activemq.security.SimpleAuthenticationPlugin
simpleAuthorizationMapAn AuthorizationMap which is configured with individual DestinationMaps for each operation.org.apache.activemq.security.SimpleAuthorizationMap
simpleDispatchPolicySimple dispatch policy that sends a message to every subscription that matches the message.org.apache.activemq.broker.region.policy.SimpleDispatchPolicy
simpleDispatchSelectorSimple dispatch policy that determines if a message can be sent to a subscriptionorg.apache.activemq.broker.region.policy.SimpleDispatchSelector
simpleJmsMessageConvertorConverts Message from one JMS to anotherorg.apache.activemq.network.jms.SimpleJmsMessageConvertor
simpleMessageGroupMapFactoryA factory to create instances of {@link SimpleMessageGroupMap} when implementing the Message Groups functionality.org.apache.activemq.broker.region.group.SimpleMessageGroupMapFactory
sslContextExtends the SslContext so that it's easier to configure from spring.org.apache.activemq.spring.SpringSslContext
statementsorg.apache.activemq.store.jdbc.Statements
statisticsBrokerPluginA StatisticsBrokerPlugin You can retrieve a Map Message for a Destination - or Broker containing statistics as key-value pairs The message must contain a replyTo Destination - else its ignored To retrieve stats on the broker send a empty message to ActiveMQ.Statistics.Broker (Queue or Topic) With a replyTo set to the destination you want the stats returned to. To retrieve stats for a destination - e.g. foo - send an empty message to ActiveMQ.Statistics.Destination.foo - this works with wildcards to - you get a message for each wildcard match on the replyTo destination. The stats message is a MapMessage populated with statistics for the targetorg.apache.activemq.plugin.StatisticsBrokerPlugin
storeCursorPending messagesorg.apache.activemq.broker.region.policy.StorePendingQueueMessageStoragePolicy
storeDurableSubscriberCursorPending messages for a durableorg.apache.activemq.broker.region.policy.StorePendingDurableSubscriberMessageStoragePolicy
storeUsageUsed to keep track of how much of something is being used so that a productive working set usage can be controlled. Main use case is manage memory usage.org.apache.activemq.usage.StoreUsage
streamJDBCAdapterThis JDBCAdapter inserts and extracts BLOB data using the setBinaryStream()/getBinaryStream() operations. The databases/JDBC drivers that use this adapter are:
  • Axion
org.apache.activemq.store.jdbc.adapter.StreamJDBCAdapter
strictOrderDispatchPolicyDispatch policy that causes every subscription to see messages in the same order.org.apache.activemq.broker.region.policy.StrictOrderDispatchPolicy
sybase-jdbc-adapterA JDBC Adapter for Sybase databasesorg.apache.activemq.store.jdbc.adapter.SybaseJDBCAdapter
systemUsageHolder for Usage instances for memory, store and temp files Main use case is manage memory usage.org.apache.activemq.usage.SystemUsage
tempDestinationAuthorizationEntryRepresents an entry in a {@link DefaultAuthorizationMap} for assigning different operations (read, write, admin) of user roles to a temporary destinationorg.apache.activemq.security.TempDestinationAuthorizationEntry
tempUsageUsed to keep track of how much of something is being used so that a productive working set usage can be controlled. Main use case is manage memory usage.org.apache.activemq.usage.TempUsage
timeStampingBrokerPluginA Broker interceptor which updates a JMS Client's timestamp on the message with a broker timestamp. Useful when the clocks on client machines are known to not be correct and you can only trust the time set on the broker machines. Enabling this plugin will break JMS compliance since the timestamp that the producer sees on the messages after as send() will be different from the timestamp the consumer will observe when he receives the message. This plugin is not enabled in the default ActiveMQ configuration. 2 new attributes have been added which will allow the administrator some override control over the expiration time for incoming messages: Attribute 'zeroExpirationOverride' can be used to apply an expiration time to incoming messages with no expiration defined (messages that would never expire) Attribute 'ttlCeiling' can be used to apply a limit to the expiration timeorg.apache.activemq.broker.util.TimeStampingBrokerPlugin
timedSubscriptionRecoveryPolicyThis implementation of {@link SubscriptionRecoveryPolicy} will keep a timed buffer of messages around in memory and use that to recover new subscriptions.org.apache.activemq.broker.region.policy.TimedSubscriptionRecoveryPolicy
topicAn ActiveMQ Topicorg.apache.activemq.command.ActiveMQTopic
traceBrokerPathPluginThe TraceBrokerPathPlugin can be used in a network of Brokers. Each Broker that has the plugin configured, will add it's brokerName to the content of a JMS Property. If all Brokers have this property enabled, the path the message actually took through the network can be seen in the defined property.org.apache.activemq.broker.util.TraceBrokerPathPlugin
transact-database-lockerRepresents an exclusive lock on a database to avoid multiple brokers running against the same logical database.org.apache.activemq.store.jdbc.adapter.TransactDatabaseLocker
transact-jdbc-adapterA JDBC Adapter for Transact-SQL based databases such as SQL Server or Sybaseorg.apache.activemq.store.jdbc.adapter.TransactJDBCAdapter
transportConnectororg.apache.activemq.broker.TransportConnector
udpTraceBrokerPluginA Broker interceptor which allows you to trace all operations to a UDP socket.org.apache.activemq.broker.util.UDPTraceBrokerPlugin
usageCapacityIdentify if a limit has been reachedorg.apache.activemq.usage.UsageCapacity
virtualDestinationInterceptorImplements Virtual Topics.org.apache.activemq.broker.region.virtual.VirtualDestinationInterceptor
virtualTopicCreates Virtual Topics using a prefix and postfix. The virtual destination creates a wildcard that is then used to look up all active queue subscriptions which match.org.apache.activemq.broker.region.virtual.VirtualTopic
vmCursorPending messages heldorg.apache.activemq.broker.region.policy.VMPendingSubscriberMessageStoragePolicy
vmDurableCursorPendingorg.apache.activemq.broker.region.policy.VMPendingDurableSubscriberMessageStoragePolicy
vmQueueCursorPending messagesorg.apache.activemq.broker.region.policy.VMPendingQueueMessageStoragePolicy
xaConnectionFactoryA Spring enhanced XA 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 JMX.org.apache.activemq.spring.ActiveMQXAConnectionFactory

Element Detail

Element: abortSlowConsumerStrategy

AttributeTypeDescription
abortConnectionxs:booleanabort the consumers connection rather than sending a stop command to the remote consumer
checkPeriodxs:longtime in milliseconds between checks for slow subscriptions
maxSlowCountxs:longnumber of times a subscription can be deemed slow before triggering abort effect depends on dispatch rate as slow determination is done on dispatch
maxSlowDurationxs:longtime in milliseconds that a sub can remain slow before triggering an abort.
namexs:string
ElementTypeDescription
brokerServiceforcePersistencyModeBroker | loggingBrokerPlugin | multicastTraceBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin

Element: amqPersistenceAdapter

AttributeTypeDescription
archiveDataLogsxs:boolean
brokerNamexs:string
checkpointIntervalxs:long
cleanupIntervalxs:long
directoryxs:string
directoryArchivexs:string
disableLockingxs:boolean
forceRecoverReferenceStorexs:boolean
indexBinSizexs:integer
indexKeySizexs:integer
indexLoadFactorxs:integer
indexMaxBinSizexs:integer
indexPageSizexs:stringWhen set using Xbean, values of the form "20 Mb", "1024kb", and "1g" can be used
journalThreadPriorityxs:integer
maxCheckpointMessageAddSizexs:stringWhen set using Xbean, values of the form "20 Mb", "1024kb", and "1g" can be used
maxFileLengthxs:stringWhen set using Xbean, values of the form "20 Mb", "1024kb", and "1g" can be used
maxReferenceFileLengthxs:stringWhen set using Xbean, values of the form "20 Mb", "1024kb", and "1g" can be used
persistentIndexxs:boolean
recoverReferenceStorexs:boolean
syncOnTransactionxs:boolean
syncOnWritexs:boolean
useDedicatedTaskRunnerxs:boolean
useNioxs:boolean
ElementTypeDescription
asyncDataManager<spring:bean/>
brokerServicebroker | brokerService
referenceStoreAdapter<spring:bean/>
taskRunnerFactory<spring:bean/>
usageManagersystemUsage
wireFormat<spring:bean/>

Element: amqPersistenceAdapterFactory

AttributeTypeDescription
brokerNamexs:string
checkpointIntervalxs:long
cleanupIntervalxs:long
dataDirectoryxs:string
forceRecoverReferenceStorexs:boolean
indexBinSizexs:integer
indexKeySizexs:integer
indexLoadFactorxs:integer
indexMaxBinSizexs:integer
indexPageSizexs:integer
journalThreadPriorityxs:integer
maxFileLengthxs:integer
maxReferenceFileLengthxs:integer
persistentIndexxs:boolean
recoverReferenceStorexs:boolean
syncOnTransactionxs:boolean
syncOnWritexs:boolean
useDedicatedTaskRunnerxs:boolean
useNioxs:boolean
ElementTypeDescription
referenceStoreAdapter<spring:bean/>
taskRunnerFactory<spring:bean/>

Element: authenticationUser

AttributeTypeDescription
groupsxs:string
passwordxs:string
usernamexs:string

Element: authorizationEntry

AttributeTypeDescription
adminxs:string
groupClassxs:string
queuexs:stringA helper method to set the destination from a configuration file
readxs:string
tempQueuexs:boolean
tempTopicxs:boolean
topicxs:stringA helper method to set the destination from a configuration file
writexs:string
ElementTypeDescription
adminACLs(<spring:bean/>)*
destinationqueue | topic
readACLs(<spring:bean/>)*
writeACLs(<spring:bean/>)*

Element: authorizationMap

ElementTypeDescription
authorizationEntries(<spring:bean/>)*Sets the individual entries on the authorization map
defaultEntryauthorizationEntry | tempDestinationAuthorizationEntry
entries(<spring:bean/>)*A helper method to allow the destination map to be populated from a dependency injection framework such as Spring
tempDestinationAuthorizationEntrytempDestinationAuthorizationEntry

Element: authorizationPlugin

ElementTypeDescription
mapauthorizationMap | lDAPAuthorizationMap | simpleAuthorizationMap

Element: axionJDBCAdapter

AttributeTypeDescription
batchStatmentsxs:boolean
maxRowsxs:integer
useExternalMessageReferencesxs:boolean
ElementTypeDescription
statementsstatements

Element: blobJDBCAdapter

AttributeTypeDescription
batchStatmentsxs:boolean
maxRowsxs:integer
useExternalMessageReferencesxs:boolean
ElementTypeDescription
statementsstatements

Element: broker

AttributeTypeDescription
advisorySupportxs:booleanAllows the support of advisory messages to be disabled for performance reasons.
brokerIdxs:string
brokerNamexs:stringSets the name of this broker; which must be unique in the network
brokerObjectNamexs:stringSets the JMX ObjectName for this broker
cacheTempDestinationsxs:boolean
consumerSystemUsagePortionxs:integer
dataDirectoryxs:stringSets the directory in which the data files will be stored by default for the JDBC and Journal persistence adaptors.
dataDirectoryFilexs:stringSets the directory in which the data files will be stored by default for the JDBC and Journal persistence adaptors.
dedicatedTaskRunnerxs:boolean
deleteAllMessagesOnStartupxs:booleanSets whether or not all messages are deleted on startup - mostly only useful for testing.
destroyApplicationContextOnShutdownxs:booleanSets whether the broker should shutdown the ApplicationContext when the broker jvm is shutdown. The broker can be stopped because the underlying JDBC store is unavailable for example.
destroyApplicationContextOnStopxs:booleanSets whether the broker should shutdown the ApplicationContext when the broker is stopped. The broker can be stopped because the underlying JDBC store is unavailable for example.
enableStatisticsxs:booleanSets whether or not the Broker's services enable statistics or not.
keepDurableSubsActivexs:boolean
masterConnectorURIxs:string
monitorConnectionSplitsxs:boolean
passiveSlavexs:booleanGet the passiveSlave
persistenceThreadPriorityxs:integer
persistentxs:booleanSets whether or not persistence is enabled or disabled.
populateJMSXUserIDxs:booleanSets whether or not the broker should populate the JMSXUserID header.
producerSystemUsagePortionxs:integer
schedulePeriodForDestinationPurgexs:integer
schedulerDirectoryxs:string
schedulerDirectoryFilexs:string
schedulerSupportxs:boolean
shutdownOnMasterFailurexs:boolean
shutdownOnSlaveFailurexs:boolean
splitSystemUsageForProducersConsumersxs:boolean
startxs:booleanSets whether or not the broker is started along with the ApplicationContext it is defined within. Normally you would want the broker to start up along with the ApplicationContext but sometimes when working with JUnit tests you may wish to start and stop the broker explicitly yourself.
supportFailOverxs:boolean
systemExitOnShutdownxs:boolean
systemExitOnShutdownExitCodexs:integer
taskRunnerPriorityxs:integer
timeBeforePurgeTempDestinationsxs:integer
tmpDataDirectoryxs:string
useJmxxs:booleanSets whether or not the Broker's services should be exposed into JMX or not.
useLocalHostBrokerNamexs:boolean
useLoggingForShutdownErrorsxs:booleanSets whether or not we should use commons-logging when reporting errors when shutting down the broker
useMirroredQueuesxs:booleanSets whether or not Mirrored Queues should be supported by default if they have not been explicitly configured.
useShutdownHookxs:booleanSets whether or not we should use a shutdown handler to close down the broker cleanly if the JVM is terminated. It is recommended you leave this enabled.
useTempMirroredQueuesxs:boolean
useVirtualTopicsxs:booleanSets whether or not Virtual Topics should be supported by default if they have not been explicitly configured.
vmConnectorURIxs:string
waitForSlavexs:boolean
waitForSlaveTimeoutxs:long
ElementTypeDescription
adminView<spring:bean/>Returns the administration view of the broker; used to create and destroy resources such as queues and topics. Note this method returns null if JMX is disabled.
brokerContext<spring:bean/>
consumerSystemUsagesystemUsage
destinationFactory<spring:bean/>
destinationInterceptors(mirroredQueue | virtualDestinationInterceptor)*Sets the destination interceptors to use
destinationPolicypolicyMapSets the destination specific policies available either for exact destinations or for wildcard areas of destinations.
destinations(queue | topic)*Sets the destinations which should be loaded/created on startup
ioExceptionHandler<spring:bean/>
jmsBridgeConnectors(jmsQueueConnector | jmsTopicConnector)*
managementContextmanagementContext
messageAuthorizationPolicy<spring:bean/>Sets the policy used to decide if the current connection is authorized to consume a given message
networkConnectorURIs(<spring:bean/>)*
networkConnectors(ldapNetworkConnector | multicastNetworkConnector | networkConnector)*Sets the network connectors which this broker will use to connect to other brokers in a federated network
persistenceAdapteramqPersistenceAdapter | jdbcPersistenceAdapter | journalPersistenceAdapter | kahaDB | kahaPersistenceAdapter | memoryPersistenceAdapterSets the persistence adaptor implementation to use for this broker
persistenceFactoryamqPersistenceAdapterFactory | journalPersistenceAdapterFactory | journaledJDBC
persistenceTaskRunnerFactory<spring:bean/>
plugins(authorizationPlugin | connectionDotFilePlugin | destinationDotFilePlugin | discardingDLQBrokerPlugin | forcePersistencyModeBrokerPlugin | jaasAuthenticationPlugin | jaasCertificateAuthenticationPlugin | jaasDualAuthenticationPlugin | loggingBrokerPlugin | multicastTraceBrokerPlugin | simpleAuthenticationPlugin | statisticsBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin)*Sets a number of broker plugins to install such as for security authentication or authorization
producerSystemUsagesystemUsage
proxyConnectors(<spring:bean/>)*Sets the network connectors which this broker will use to connect to other brokers in a federated network
regionBrokerforcePersistencyModeBroker | loggingBrokerPlugin | multicastTraceBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin
services(broker | brokerService | commandAgent | forwardingBridge | inboundQueueBridge | inboundTopicBridge | jmsQueueConnector | jmsTopicConnector | ldapNetworkConnector | managementContext | masterConnector | memoryUsage | multicastNetworkConnector | networkConnector | outboundQueueBridge | outboundTopicBridge | pListStore | proxyConnector | storeUsage | systemUsage | tempUsage)*Sets the services associated with this broker such as a {@link MasterConnector}
shutdownHooks(<spring:bean/>)*Sets hooks to be executed when broker shut down
sslContextsslContext
systemUsagesystemUsage
taskRunnerFactory<spring:bean/>
tempDataStorepListStore
transportConnectorURIs(<spring:bean/>)*
transportConnectors(transportConnector)*Sets the transport connectors which this broker will listen on for new clients

Element: brokerService

AttributeTypeDescription
advisorySupportxs:booleanAllows the support of advisory messages to be disabled for performance reasons.
brokerIdxs:string
brokerNamexs:stringSets the name of this broker; which must be unique in the network
brokerObjectNamexs:stringSets the JMX ObjectName for this broker
cacheTempDestinationsxs:boolean
consumerSystemUsagePortionxs:integer
dataDirectoryxs:stringSets the directory in which the data files will be stored by default for the JDBC and Journal persistence adaptors.
dataDirectoryFilexs:stringSets the directory in which the data files will be stored by default for the JDBC and Journal persistence adaptors.
dedicatedTaskRunnerxs:boolean
deleteAllMessagesOnStartupxs:booleanSets whether or not all messages are deleted on startup - mostly only useful for testing.
enableStatisticsxs:booleanSets whether or not the Broker's services enable statistics or not.
keepDurableSubsActivexs:boolean
masterConnectorURIxs:string
monitorConnectionSplitsxs:boolean
passiveSlavexs:booleanGet the passiveSlave
persistenceThreadPriorityxs:integer
persistentxs:booleanSets whether or not persistence is enabled or disabled.
populateJMSXUserIDxs:booleanSets whether or not the broker should populate the JMSXUserID header.
producerSystemUsagePortionxs:integer
schedulePeriodForDestinationPurgexs:integer
schedulerDirectoryxs:string
schedulerDirectoryFilexs:string
schedulerSupportxs:boolean
shutdownOnMasterFailurexs:boolean
shutdownOnSlaveFailurexs:boolean
splitSystemUsageForProducersConsumersxs:boolean
supportFailOverxs:boolean
systemExitOnShutdownxs:boolean
systemExitOnShutdownExitCodexs:integer
taskRunnerPriorityxs:integer
timeBeforePurgeTempDestinationsxs:integer
tmpDataDirectoryxs:string
useJmxxs:booleanSets whether or not the Broker's services should be exposed into JMX or not.
useLocalHostBrokerNamexs:boolean
useLoggingForShutdownErrorsxs:booleanSets whether or not we should use commons-logging when reporting errors when shutting down the broker
useMirroredQueuesxs:booleanSets whether or not Mirrored Queues should be supported by default if they have not been explicitly configured.
useShutdownHookxs:booleanSets whether or not we should use a shutdown handler to close down the broker cleanly if the JVM is terminated. It is recommended you leave this enabled.
useTempMirroredQueuesxs:boolean
useVirtualTopicsxs:booleanSets whether or not Virtual Topics should be supported by default if they have not been explicitly configured.
vmConnectorURIxs:string
waitForSlavexs:boolean
waitForSlaveTimeoutxs:long
ElementTypeDescription
adminView<spring:bean/>Returns the administration view of the broker; used to create and destroy resources such as queues and topics. Note this method returns null if JMX is disabled.
brokerContext<spring:bean/>
consumerSystemUsagesystemUsage
destinationFactory<spring:bean/>
destinationInterceptors(mirroredQueue | virtualDestinationInterceptor)*Sets the destination interceptors to use
destinationPolicypolicyMapSets the destination specific policies available either for exact destinations or for wildcard areas of destinations.
destinations(queue | topic)*Sets the destinations which should be loaded/created on startup
ioExceptionHandler<spring:bean/>
jmsBridgeConnectors(jmsQueueConnector | jmsTopicConnector)*
managementContextmanagementContext
messageAuthorizationPolicy<spring:bean/>Sets the policy used to decide if the current connection is authorized to consume a given message
networkConnectorURIs(<spring:bean/>)*
networkConnectors(ldapNetworkConnector | multicastNetworkConnector | networkConnector)*Sets the network connectors which this broker will use to connect to other brokers in a federated network
persistenceAdapteramqPersistenceAdapter | jdbcPersistenceAdapter | journalPersistenceAdapter | kahaDB | kahaPersistenceAdapter | memoryPersistenceAdapterSets the persistence adaptor implementation to use for this broker
persistenceFactoryamqPersistenceAdapterFactory | journalPersistenceAdapterFactory | journaledJDBC
persistenceTaskRunnerFactory<spring:bean/>
plugins(authorizationPlugin | connectionDotFilePlugin | destinationDotFilePlugin | discardingDLQBrokerPlugin | forcePersistencyModeBrokerPlugin | jaasAuthenticationPlugin | jaasCertificateAuthenticationPlugin | jaasDualAuthenticationPlugin | loggingBrokerPlugin | multicastTraceBrokerPlugin | simpleAuthenticationPlugin | statisticsBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin)*Sets a number of broker plugins to install such as for security authentication or authorization
producerSystemUsagesystemUsage
proxyConnectors(<spring:bean/>)*Sets the network connectors which this broker will use to connect to other brokers in a federated network
regionBrokerforcePersistencyModeBroker | loggingBrokerPlugin | multicastTraceBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin
services(broker | brokerService | commandAgent | forwardingBridge | inboundQueueBridge | inboundTopicBridge | jmsQueueConnector | jmsTopicConnector | ldapNetworkConnector | managementContext | masterConnector | memoryUsage | multicastNetworkConnector | networkConnector | outboundQueueBridge | outboundTopicBridge | pListStore | proxyConnector | storeUsage | systemUsage | tempUsage)*Sets the services associated with this broker such as a {@link MasterConnector}
shutdownHooks(<spring:bean/>)*Sets hooks to be executed when broker shut down
sslContextsslContext
systemUsagesystemUsage
taskRunnerFactory<spring:bean/>
tempDataStorepListStore
transportConnectorURIs(<spring:bean/>)*
transportConnectors(transportConnector)*Sets the transport connectors which this broker will listen on for new clients

Element: bytesJDBCAdapter

AttributeTypeDescription
batchStatmentsxs:boolean
maxRowsxs:integer
useExternalMessageReferencesxs:boolean
ElementTypeDescription
statementsstatements

Element: commandAgent

AttributeTypeDescription
brokerUrlxs:string
passwordxs:string
usernamexs:string
ElementTypeDescription
commandDestinationqueue | topic
connection<spring:bean/>
connectionFactoryconnectionFactory | xaConnectionFactory

Element: compositeDemandForwardingBridge

AttributeTypeDescription
createdByDuplexxs:boolean
ElementTypeDescription
brokerServicebroker | brokerService
configurationldapNetworkConnector | multicastNetworkConnector | networkConnector
durableDestinations(queue | topic)*
dynamicallyIncludedDestinations(queue | topic)*
excludedDestinations(queue | topic)*
localBroker<spring:bean/>
networkBridgeListener<spring:bean/>
remoteBroker<spring:bean/>
staticallyIncludedDestinations(queue | topic)*

Element: compositeQueue

AttributeTypeDescription
copyMessagexs:booleanSets whether a copy of the message will be sent to each destination. Defaults to true so that the forward destination is set as the destination of the message
forwardOnlyxs:booleanSets if the virtual destination is forward only (and so there is no physical queue to match the virtual queue) or if there is also a physical queue with the same name).
namexs:stringSets the name of this composite destination
ElementTypeDescription
forwardTo(<spring:bean/>)*Sets the list of destinations to forward to

Element: compositeTopic

AttributeTypeDescription
copyMessagexs:booleanSets whether a copy of the message will be sent to each destination. Defaults to true so that the forward destination is set as the destination of the message
forwardOnlyxs:booleanSets if the virtual destination is forward only (and so there is no physical queue to match the virtual queue) or if there is also a physical queue with the same name).
namexs:stringSets the name of this composite destination
ElementTypeDescription
forwardTo(<spring:bean/>)*Sets the list of destinations to forward to

Element: connectionDotFilePlugin

AttributeTypeDescription
filexs:stringSets the destination file name to create the destination diagram

Element: connectionFactory

AttributeTypeDescription
alwaysSessionAsyncxs:booleanIf 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
alwaysSyncSendxs:booleanSet true if always require messages to be sync sent
auditDepthxs:integer
auditMaximumProducerNumberxs:integer
beanNamexs:string
brokerURLxs:stringSets the connection URL used to connect to the ActiveMQ broker.
checkForDuplicatesxs:boolean
clientIDxs:stringSets 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
clientIDPrefixxs:stringSets the prefix used by autogenerated JMS Client ID values which are used if the JMS client does not explicitly specify on.
closeTimeoutxs:integerSets 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
consumerFailoverRedeliveryWaitPeriodxs:long
copyMessageOnSendxs:booleanShould 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
disableTimeStampsByDefaultxs:booleanSets whether or not timestamps on messages should be disabled or not. If you disable them it adds a small performance boost.
dispatchAsyncxs:booleanEnables or disables the default setting of whether or not consumers have their messages dispatched synchronously or asynchronously by the broker. 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.
exclusiveConsumerxs:booleanEnables or disables whether or not queue consumers should be exclusive or not for example to preserve ordering when not using Message Groups
messagePrioritySupportedxs:boolean
nestedMapAndListEnabledxs:booleanEnables/disables whether or not Message properties and MapMessage entries support Nested Structures of Map and List objects
objectMessageSerializationDeferedxs:booleanWhen 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.
optimizeAcknowledgexs:boolean
optimizedMessageDispatchxs:booleanIf this flag is set then an larger prefetch limit is used - only applicable for durable topic subscribers.
passwordxs:stringSets the JMS password used for connections created from this factory
producerWindowSizexs:integer
sendAcksAsyncxs:boolean
sendTimeoutxs:integer
statsEnabledxs:boolean
useAsyncSendxs:booleanForces the use of Async Sends 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.
useBeanNameAsClientIdPrefixxs:boolean
useCompressionxs:booleanEnables the use of compression of the message bodies
useDedicatedTaskRunnerxs:boolean
useRetroactiveConsumerxs:booleanSets 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.
userNamexs:stringSets the JMS userName used by connections created by this factory
warnAboutUnstartedConnectionTimeoutxs:longEnables 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 start the connection 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).
watchTopicAdvisoriesxs:boolean
ElementTypeDescription
blobTransferPolicy<spring:bean/>Sets the policy used to describe how out-of-band BLOBs (Binary Large OBjects) are transferred from producers to brokers to consumers
clientIdGenerator<spring:bean/>
clientInternalExceptionListener<spring:bean/>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.

Note: access to this clientInternalExceptionListener will not 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)

exceptionListenercommandAgentAllows 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.

Note: access to this exceptionLinstener will not 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)

prefetchPolicyprefetchPolicySets the prefetch policy for consumers created by this connection.
properties<spring:bean/>Get the properties from this instance for storing in JNDI
redeliveryPolicyredeliveryPolicySets the global redelivery policy to be used when a message is delivered but the session is rolled back
transformer<spring:bean/>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
transportListener<spring:bean/>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.

Element: constantPendingMessageLimitStrategy

AttributeTypeDescription
limitxs:integer

Element: database-locker

AttributeTypeDescription
lockAcquireSleepIntervalxs:long
ElementTypeDescription
exceptionHandler<spring:bean/>
persistenceAdapterjdbcPersistenceAdapter

Element: db2JDBCAdapter

AttributeTypeDescription
batchStatmentsxs:boolean
maxRowsxs:integer
useExternalMessageReferencesxs:boolean
ElementTypeDescription
statementsstatements

Element: defaultJDBCAdapter

AttributeTypeDescription
batchStatmentsxs:boolean
maxRowsxs:integer
useExternalMessageReferencesxs:boolean
ElementTypeDescription
statementsstatements

Element: defaultUsageCapacity

AttributeTypeDescription
limitxs:long

Element: demandForwardingBridge

AttributeTypeDescription
createdByDuplexxs:boolean
ElementTypeDescription
brokerServicebroker | brokerService
configurationldapNetworkConnector | multicastNetworkConnector | networkConnector
durableDestinations(queue | topic)*
dynamicallyIncludedDestinations(queue | topic)*
excludedDestinations(queue | topic)*
localBroker<spring:bean/>
networkBridgeListener<spring:bean/>
remoteBroker<spring:bean/>
staticallyIncludedDestinations(queue | topic)*

Element: destinationDotFilePlugin

AttributeTypeDescription
filexs:stringSets the destination file name to create the destination diagram

Element: destinationEntry

AttributeTypeDescription
queuexs:stringA helper method to set the destination from a configuration file
tempQueuexs:boolean
tempTopicxs:boolean
topicxs:stringA helper method to set the destination from a configuration file
ElementTypeDescription
destinationqueue | topic
value<spring:bean/>

Element: discardingDLQBrokerPlugin

AttributeTypeDescription
dropAllxs:boolean
dropOnlyxs:string
dropTemporaryQueuesxs:boolean
dropTemporaryTopicsxs:boolean
reportIntervalxs:integer

Element: fileCursor

Element: fileDurableSubscriberCursor

Element: fileQueueCursor

Element: filteredDestination

AttributeTypeDescription
queuexs:stringSets the destination property to the given queue name
selectorxs:stringSets the JMS selector used to filter messages before forwarding them to this destination
topicxs:stringSets the destination property to the given topic name
ElementTypeDescription
destinationqueue | topicThe destination to send messages to if they match the filter
filter<spring:bean/>

Element: fixedCountSubscriptionRecoveryPolicy

AttributeTypeDescription
maximumSizexs:integerSets the maximum number of messages that this destination will hold around in RAM
ElementTypeDescription
brokerforcePersistencyModeBroker | loggingBrokerPlugin | multicastTraceBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin

Element: fixedSizedSubscriptionRecoveryPolicy

AttributeTypeDescription
maximumSizexs:integerSets the maximum amount of RAM in bytes that this buffer can hold in RAM
useSharedBufferxs:boolean
ElementTypeDescription
brokerforcePersistencyModeBroker | loggingBrokerPlugin | multicastTraceBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin
buffer<spring:bean/>

Element: forcePersistencyModeBroker

AttributeTypeDescription
persistenceFlagxs:boolean
ElementTypeDescription
adminConnectionContext<spring:bean/>
nextforcePersistencyModeBroker | loggingBrokerPlugin | multicastTraceBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin

Element: forcePersistencyModeBrokerPlugin

AttributeTypeDescription
persistenceFlagxs:booleanSets the persistency mode.

Element: forwardingBridge

AttributeTypeDescription
clientIdxs:string
destinationFilterxs:string
dispatchAsyncxs:boolean
prefetchSizexs:integer
ElementTypeDescription
localBroker<spring:bean/>
networkBridgeFailedListener<spring:bean/>
remoteBroker<spring:bean/>

Element: hsqldb-jdbc-adapter

AttributeTypeDescription
batchStatmentsxs:boolean
maxRowsxs:integer
useExternalMessageReferencesxs:boolean
ElementTypeDescription
statementsstatements

Element: imageBasedJDBCAdaptor

AttributeTypeDescription
batchStatmentsxs:boolean
maxRowsxs:integer
useExternalMessageReferencesxs:boolean
ElementTypeDescription
statementsstatements

Element: inboundQueueBridge

AttributeTypeDescription
doHandleReplyToxs:boolean
inboundQueueNamexs:string
localQueueNamexs:string
maximumRetriesxs:integerSets the maximum number of retries if a send fails before closing the bridge
selectorxs:string
ElementTypeDescription
consumer<spring:bean/>
consumerConnection<spring:bean/>
consumerQueuequeue
jmsConnectorjmsQueueConnector | jmsTopicConnector
jmsMessageConvertorsimpleJmsMessageConvertor
producerConnection<spring:bean/>
producerQueuequeue

Element: inboundTopicBridge

AttributeTypeDescription
consumerNamexs:string
doHandleReplyToxs:boolean
inboundTopicNamexs:string
localTopicNamexs:string
maximumRetriesxs:integerSets the maximum number of retries if a send fails before closing the bridge
selectorxs:string
ElementTypeDescription
consumer<spring:bean/>
consumerConnection<spring:bean/>
consumerTopictopic
jmsConnectorjmsQueueConnector | jmsTopicConnector
jmsMessageConvertorsimpleJmsMessageConvertor
producerConnection<spring:bean/>
producerTopictopic

Element: individualDeadLetterStrategy

AttributeTypeDescription
processExpiredxs:boolean
processNonPersistentxs:boolean
queuePrefixxs:stringSets the prefix to use for all dead letter queues for queue messages
topicPrefixxs:stringSets the prefix to use for all dead letter queues for topic messages
useQueueForQueueMessagesxs:booleanSets whether a queue or topic should be used for queue messages sent to a DLQ. The default is to use a Queue
useQueueForTopicMessagesxs:booleanSets whether a queue or topic should be used for topic messages sent to a DLQ. The default is to use a Queue

Element: informixJDBCAdapter

AttributeTypeDescription
batchStatmentsxs:boolean
maxRowsxs:integer
useExternalMessageReferencesxs:boolean
ElementTypeDescription
statementsstatements

Element: jaasAuthenticationPlugin

AttributeTypeDescription
configurationxs:stringSets the JAAS configuration domain name used
discoverLoginConfigxs:booleanEnables or disables the auto-discovery of the login.config file for JAAS to initialize itself. This flag is enabled by default such that if the java.security.auth.login.config system property is not defined then it is set to the location of the login.config file on the classpath.

Element: jaasCertificateAuthenticationPlugin

AttributeTypeDescription
configurationxs:stringSets the JAAS configuration domain name used
discoverLoginConfigxs:booleanEnables or disables the auto-discovery of the login.config file for JAAS to initialize itself. This flag is enabled by default such that if the java.security.auth.login.config system property is not defined then it is set to the location of the login.config file on the classpath.

Element: jaasDualAuthenticationPlugin

AttributeTypeDescription
configurationxs:stringSets the JAAS configuration domain name used
discoverLoginConfigxs:booleanEnables or disables the auto-discovery of the login.config file for JAAS to initialize itself. This flag is enabled by default such that if the java.security.auth.login.config system property is not defined then it is set to the location of the login.config file on the classpath.
sslConfigurationxs:stringSet the JAAS SSL configuration domain

Element: jdbcPersistenceAdapter

AttributeTypeDescription
auditRecoveryDepthxs:integer
brokerNamexs:string
cleanupPeriodxs:integerSets the number of milliseconds until the database is attempted to be cleaned up for durable topics
createTablesOnStartupxs:booleanSets whether or not tables are created on startup
dataDirectoryxs:string
dataDirectoryFilexs:string
directoryxs:string
enableAuditxs:boolean
lockAcquireSleepIntervalxs:longmillisecond interval between lock acquire attempts, applied to newly created DefaultDatabaseLocker not applied if DataBaseLocker is injected.
lockKeepAlivePeriodxs:long
maxAuditDepthxs:integer
maxProducersToAuditxs:integer
maxRowsxs:integer
transactionIsolationxs:integerset the Transaction isolation level to something other that TRANSACTION_READ_UNCOMMITTED This allowable dirty isolation level may not be achievable in clustered DB environments so a more restrictive and expensive option may be needed like TRANSACTION_REPEATABLE_READ see isolation level constants in {@link java.sql.Connection}
useDatabaseLockxs:booleanSets whether or not an exclusive database lock should be used to enable JDBC Master/Slave. Enabled by default.
useExternalMessageReferencesxs:boolean
ElementTypeDescription
adapteraxionJDBCAdapter | blobJDBCAdapter | bytesJDBCAdapter | db2JDBCAdapter | defaultJDBCAdapter | hsqldb-jdbc-adapter | imageBasedJDBCAdaptor | informixJDBCAdapter | maxdb-jdbc-adapter | mysql-jdbc-adapter | oracleJDBCAdapter | postgresql-jdbc-adapter | streamJDBCAdapter | sybase-jdbc-adapter | transact-jdbc-adapter
brokerServicebroker | brokerService
dataSource<spring:bean/>
databaseLockerdatabase-locker | transact-database-lockerSets the database locker strategy to use to lock the database on startup
ds<spring:bean/>
lockDataSource<spring:bean/>
scheduledThreadPoolExecutor<spring:bean/>
statementsstatements
usageManagersystemUsage
wireFormat<spring:bean/>

Element: jmsQueueConnector

AttributeTypeDescription
jndiLocalTemplatexs:string
jndiOutboundTemplatexs:string
localClientIdxs:string
localConnectionFactoryNamexs:string
localPasswordxs:string
localUsernamexs:string
namexs:string
outboundClientIdxs:string
outboundPasswordxs:string
outboundQueueConnectionFactoryNamexs:string
outboundUsernamexs:string
replyToDestinationCacheSizexs:integer
ElementTypeDescription
brokerServicebroker | brokerServiceOne way to configure the local connection - this is called by The BrokerService when the Connector is embedded
inboundMessageConvertorsimpleJmsMessageConvertor
inboundQueueBridges(inboundQueueBridge)*
localQueueConnection<spring:bean/>
localQueueConnectionFactoryconnectionFactory | xaConnectionFactory
outboundMessageConvertorsimpleJmsMessageConvertor
outboundQueueBridges(outboundQueueBridge)*
outboundQueueConnection<spring:bean/>
outboundQueueConnectionFactoryconnectionFactory | xaConnectionFactory

Element: jmsTopicConnector

AttributeTypeDescription
jndiLocalTemplatexs:string
jndiOutboundTemplatexs:string
localClientIdxs:string
localConnectionFactoryNamexs:string
localPasswordxs:string
localUsernamexs:string
namexs:string
outboundClientIdxs:string
outboundPasswordxs:string
outboundTopicConnectionFactoryNamexs:string
outboundUsernamexs:string
replyToDestinationCacheSizexs:integer
ElementTypeDescription
brokerServicebroker | brokerServiceOne way to configure the local connection - this is called by The BrokerService when the Connector is embedded
inboundMessageConvertorsimpleJmsMessageConvertor
inboundTopicBridges(inboundTopicBridge)*
localTopicConnection<spring:bean/>
localTopicConnectionFactoryconnectionFactory | xaConnectionFactory
outboundMessageConvertorsimpleJmsMessageConvertor
outboundTopicBridges(outboundTopicBridge)*
outboundTopicConnection<spring:bean/>
outboundTopicConnectionFactoryconnectionFactory | xaConnectionFactory

Element: journalPersistenceAdapter

AttributeTypeDescription
brokerNamexs:string
directoryxs:string
maxCheckpointMessageAddSizexs:integer
maxCheckpointWorkersxs:integer
useExternalMessageReferencesxs:boolean
ElementTypeDescription
brokerServicebroker | brokerService
journal<spring:bean/>
longTermPersistenceamqPersistenceAdapter | jdbcPersistenceAdapter | journalPersistenceAdapter | kahaDB | kahaPersistenceAdapter | memoryPersistenceAdapter
persistenceAdapteramqPersistenceAdapter | jdbcPersistenceAdapter | journalPersistenceAdapter | kahaDB | kahaPersistenceAdapter | memoryPersistenceAdapter
taskRunnerFactory<spring:bean/>
usageManagersystemUsage

Element: journalPersistenceAdapterFactory

AttributeTypeDescription
createTablesOnStartupxs:booleanSets whether or not tables are created on startup
dataDirectoryxs:string
dataDirectoryFilexs:string
journalArchiveDirectoryxs:string
journalLogFileSizexs:stringSets the size of the journal log files When set using Xbean, values of the form "20 Mb", "1024kb", and "1g" can be used
journalLogFilesxs:integerSets the number of journal log files to use
journalThreadPriorityxs:integerSets the thread priority of the journal thread
useDatabaseLockxs:booleanSets whether or not an exclusive database lock should be used to enable JDBC Master/Slave. Enabled by default.
useDedicatedTaskRunnerxs:boolean
useJournalxs:booleanEnables or disables the use of the journal. The default is to use the journal
useQuickJournalxs:booleanEnables or disables the use of quick journal, which keeps messages in the journal and just stores a reference to the messages in JDBC. Defaults to false so that messages actually reside long term in the JDBC database.
ElementTypeDescription
adapteraxionJDBCAdapter | blobJDBCAdapter | bytesJDBCAdapter | db2JDBCAdapter | defaultJDBCAdapter | hsqldb-jdbc-adapter | imageBasedJDBCAdaptor | informixJDBCAdapter | maxdb-jdbc-adapter | mysql-jdbc-adapter | oracleJDBCAdapter | postgresql-jdbc-adapter | streamJDBCAdapter | sybase-jdbc-adapter | transact-jdbc-adapter
dataSource<spring:bean/>
jdbcAdapterjdbcPersistenceAdapter
journal<spring:bean/>
statementsstatements
taskRunnerFactory<spring:bean/>

Element: journaledJDBC

AttributeTypeDescription
createTablesOnStartupxs:booleanSets whether or not tables are created on startup
dataDirectoryxs:string
dataDirectoryFilexs:string
journalArchiveDirectoryxs:string
journalLogFileSizexs:stringSets the size of the journal log files When set using Xbean, values of the form "20 Mb", "1024kb", and "1g" can be used
journalLogFilesxs:integerSets the number of journal log files to use
journalThreadPriorityxs:integerSets the thread priority of the journal thread
useDatabaseLockxs:booleanSets whether or not an exclusive database lock should be used to enable JDBC Master/Slave. Enabled by default.
useDedicatedTaskRunnerxs:boolean
useJournalxs:booleanEnables or disables the use of the journal. The default is to use the journal
useQuickJournalxs:booleanEnables or disables the use of quick journal, which keeps messages in the journal and just stores a reference to the messages in JDBC. Defaults to false so that messages actually reside long term in the JDBC database.
ElementTypeDescription
adapteraxionJDBCAdapter | blobJDBCAdapter | bytesJDBCAdapter | db2JDBCAdapter | defaultJDBCAdapter | hsqldb-jdbc-adapter | imageBasedJDBCAdaptor | informixJDBCAdapter | maxdb-jdbc-adapter | mysql-jdbc-adapter | oracleJDBCAdapter | postgresql-jdbc-adapter | streamJDBCAdapter | sybase-jdbc-adapter | transact-jdbc-adapter
dataSource<spring:bean/>
jdbcAdapterjdbcPersistenceAdapter
journal<spring:bean/>
statementsstatements
taskRunnerFactory<spring:bean/>

Element: kahaDB

AttributeTypeDescription
archiveDataLogsxs:boolean
brokerNamexs:string
checkForCorruptJournalFilesxs:boolean
checkpointIntervalxs:longGet the checkpointInterval
checksumJournalFilesxs:boolean
cleanupIntervalxs:longGet the cleanupInterval
concurrentStoreAndDispatchQueuesxs:boolean
concurrentStoreAndDispatchTopicsxs:boolean
databaseLockedWaitDelayxs:integer
directoryxs:stringGet the directory
directoryArchivexs:string
enableIndexWriteAsyncxs:booleanGet the enableIndexWriteAsync
enableJournalDiskSyncsxs:booleanGet the enableJournalDiskSyncs
failoverProducersAuditDepthxs:integerset the audit window depth for duplicate suppression (should exceed the max transaction batch)
forceRecoverIndexxs:boolean
ignoreMissingJournalfilesxs:booleanGet the ignoreMissingJournalfiles
indexCacheSizexs:stringGet the indexCacheSize
indexWriteBatchSizexs:stringGet the indexWriteBatchSize
journalMaxFileLengthxs:stringGet the journalMaxFileLength
journalMaxWriteBatchSizexs:stringGet the journalMaxWriteBatchSize
maxAsyncJobsxs:integer
maxFailoverProducersToTrackxs:integerSet the max number of producers (LRU cache) to track for duplicate sends
ElementTypeDescription
brokerServicebroker | brokerService
usageManagersystemUsage

Element: kahaPersistenceAdapter

AttributeTypeDescription
brokerNamexs:string
directoryxs:string
maxDataFileLengthxs:stringWhen set using Xbean, values of the form "20 Mb", "1024kb", and "1g" can be used
persistentIndexxs:boolean
ElementTypeDescription
brokerServicebroker | brokerService
size<spring:bean/>
usageManagersystemUsage

Element: lDAPAuthorizationMap

AttributeTypeDescription
adminAttributexs:string
adminBasexs:string
authenticationxs:string
connectionPasswordxs:string
connectionProtocolxs:string
connectionURLxs:string
connectionUsernamexs:string
initialContextFactoryxs:string
queueSearchSubtreeBoolxs:boolean
readAttributexs:string
readBasexs:string
topicSearchSubtreeBoolxs:boolean
writeAttributexs:string
writeBasexs:string
ElementTypeDescription
context<spring:bean/>
options<spring:bean/>
queueSearchMatchingFormat<spring:bean/>
topicSearchMatchingFormat<spring:bean/>

Element: lastImageSubscriptionRecoveryPolicy

ElementTypeDescription
brokerforcePersistencyModeBroker | loggingBrokerPlugin | multicastTraceBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin

Element: ldapNetworkConnector

AttributeTypeDescription
anonymousAuthenticationxs:booleansets LDAP anonymous authentication access credentials
basexs:stringsets the base LDAP dn used for lookup operations
bridgeTempDestinationsxs:boolean
brokerNamexs:string
brokerURLxs:string
conduitSubscriptionsxs:boolean
decreaseNetworkConsumerPriorityxs:boolean
destinationFilterxs:string
dispatchAsyncxs:boolean
duplexxs:boolean
dynamicOnlyxs:boolean
localUrixs:string
namexs:string
networkTTLxs:integer
objectNamexs:string
passwordxs:stringsets the LDAP password for access credentials
prefetchSizexs:string
searchEventListenerxs:booleanenables/disable a persistent search to the LDAP server as defined in draft-ietf-ldapext-psearch-03.txt (2.16.840.1.113730.3.4.3)
searchFilterxs:stringsets the LDAP search filter as defined in RFC 2254
searchScopexs:stringsets the LDAP search scope
suppressDuplicateQueueSubscriptionsxs:boolean
suppressDuplicateTopicSubscriptionsxs:boolean
urixs:stringreturns the next URI from the configured list
userxs:stringsets the LDAP user for access credentials
userNamexs:string
ElementTypeDescription
brokerServicebroker | brokerService
connectionFilter<spring:bean/>
durableDestinations(<spring:bean/>)*
dynamicallyIncludedDestinations(<spring:bean/>)*
excludedDestinations(<spring:bean/>)*
staticallyIncludedDestinations(<spring:bean/>)*

Element: loggingBrokerPlugin

AttributeTypeDescription
logAllxs:booleanLog all Events that go through the Plugin
logConnectionEventsxs:booleanLog Events that are related to connections and sessions
logConsumerEventsxs:booleanLog Events that are related to Consumers
logInternalEventsxs:booleanLog Events that are normally internal to the broker
logMessageEventsxs:booleanLog Events that are related to message processing
logProducerEventsxs:booleanLog Events that are related to Producers
logTransactionEventsxs:booleanLog Events that are related to transaction processing
ElementTypeDescription
adminConnectionContext<spring:bean/>
nextforcePersistencyModeBroker | loggingBrokerPlugin | multicastTraceBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin

Element: managementContext

AttributeTypeDescription
connectorHostxs:stringGet the connectorHost
connectorPathxs:string
connectorPortxs:string
createConnectorxs:boolean
createMBeanServerxs:boolean
findTigerMbeanServerxs:booleanEnables/disables the searching for the Java 5 platform MBeanServer
jmxDomainNamexs:string
rmiServerPortxs:string
useMBeanServerxs:boolean
ElementTypeDescription
MBeanServer<spring:bean/>Get the MBeanServer
environment<spring:bean/>
server<spring:bean/>

Element: masterConnector

AttributeTypeDescription
failedToStartxs:booleanGet the failedToStart
localURIxs:string
passwordxs:string
remoteURIxs:string
remoteUrixs:string
userNamexs:string
ElementTypeDescription
brokerServicebroker | brokerService

Element: maxdb-jdbc-adapter

AttributeTypeDescription
batchStatmentsxs:boolean
maxRowsxs:integer
useExternalMessageReferencesxs:boolean
ElementTypeDescription
statementsstatements

Element: memoryPersistenceAdapter

AttributeTypeDescription
brokerNamexs:string
createTransactionStorexs:boolean
directoryxs:string
useExternalMessageReferencesxs:boolean
ElementTypeDescription
usageManagersystemUsage

Element: memoryUsage

AttributeTypeDescription
limitxs:stringSets the memory limit in bytes. Setting the limit in bytes will set the usagePortion to 0 since the UsageManager is not going to be portion based off the parent. When set using Xbean, values of the form "20 Mb", "1024kb", and "1g" can be used
namexs:string
percentUsagexs:integer
percentUsageMinDeltaxs:stringSets the minimum number of percentage points the usage has to change before a UsageListener event is fired by the manager.
pollingTimexs:integer
portionxs:float
usagexs:long
usagePortionxs:float
ElementTypeDescription
executor<spring:bean/>
limiterdefaultUsageCapacity | usageCapacity
parent<spring:bean/>

Element: messageGroupHashBucketFactory

AttributeTypeDescription
bucketCountxs:integerSets the number of hash buckets to use for the message group functionality. This is only applicable to using message groups to parallelize processing of a queue while preserving order across an individual JMSXGroupID header value. This value sets the number of hash buckets that will be used (i.e. the maximum possible concurrency).

Element: mirroredQueue

AttributeTypeDescription
copyMessagexs:booleanSets whether a copy of the message will be sent to each destination. Defaults to true so that the forward destination is set as the destination of the message
postfixxs:stringSets any postix used to identify the queue consumers
prefixxs:stringSets the prefix wildcard used to identify the queue consumers for a given topic
ElementTypeDescription
brokerServicebroker | brokerService

Element: multicastNetworkConnector

AttributeTypeDescription
bridgeTempDestinationsxs:boolean
brokerNamexs:string
brokerURLxs:string
conduitSubscriptionsxs:boolean
decreaseNetworkConsumerPriorityxs:boolean
destinationFilterxs:string
dispatchAsyncxs:boolean
duplexxs:boolean
dynamicOnlyxs:boolean
localUrixs:string
namexs:string
networkTTLxs:integer
objectNamexs:string
passwordxs:string
prefetchSizexs:string
remoteURIxs:stringSets the remote transport URI to some group transport like multicast://address:port
suppressDuplicateQueueSubscriptionsxs:boolean
suppressDuplicateTopicSubscriptionsxs:boolean
userNamexs:string
ElementTypeDescription
bridgecompositeDemandForwardingBridge | demandForwardingBridge
brokerServicebroker | brokerService
connectionFilter<spring:bean/>
durableDestinations(<spring:bean/>)*
dynamicallyIncludedDestinations(<spring:bean/>)*
excludedDestinations(<spring:bean/>)*
localTransport<spring:bean/>
remoteTransport<spring:bean/>Sets the remote transport implementation
staticallyIncludedDestinations(<spring:bean/>)*

Element: multicastTraceBrokerPlugin

AttributeTypeDescription
broadcastxs:boolean
destinationxs:string
maxTraceDatagramSizexs:integer
timeToLivexs:integer
ElementTypeDescription
address<spring:bean/>
adminConnectionContext<spring:bean/>
nextforcePersistencyModeBroker | loggingBrokerPlugin | multicastTraceBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin
wireFormat<spring:bean/>
wireFormatFactory<spring:bean/>

Element: mysql-jdbc-adapter

AttributeTypeDescription
batchStatmentsxs:boolean
engineTypexs:string
maxRowsxs:integer
typeStatementxs:string
useExternalMessageReferencesxs:boolean
ElementTypeDescription
statementsstatements

Element: networkConnector

AttributeTypeDescription
bridgeTempDestinationsxs:boolean
brokerNamexs:string
brokerURLxs:string
conduitSubscriptionsxs:boolean
decreaseNetworkConsumerPriorityxs:boolean
destinationFilterxs:string
discoveryURIxs:string
dispatchAsyncxs:boolean
duplexxs:boolean
dynamicOnlyxs:boolean
localUrixs:string
namexs:string
networkTTLxs:integer
objectNamexs:string
passwordxs:string
prefetchSizexs:string
suppressDuplicateQueueSubscriptionsxs:boolean
suppressDuplicateTopicSubscriptionsxs:boolean
urixs:string
userNamexs:string
ElementTypeDescription
brokerServicebroker | brokerService
connectionFilter<spring:bean/>
discoveryAgent<spring:bean/>
durableDestinations(<spring:bean/>)*
dynamicallyIncludedDestinations(<spring:bean/>)*
excludedDestinations(<spring:bean/>)*
staticallyIncludedDestinations(<spring:bean/>)*

Element: noSubscriptionRecoveryPolicy

ElementTypeDescription
brokerforcePersistencyModeBroker | loggingBrokerPlugin | multicastTraceBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin

Element: oldestMessageEvictionStrategy

AttributeTypeDescription
evictExpiredMessagesHighWatermarkxs:integerSets the high water mark on which we will eagerly evict expired messages from RAM

Element: oldestMessageWithLowestPriorityEvictionStrategy

AttributeTypeDescription
evictExpiredMessagesHighWatermarkxs:integerSets the high water mark on which we will eagerly evict expired messages from RAM

Element: oracleJDBCAdapter

AttributeTypeDescription
batchStatmentsxs:boolean
maxRowsxs:integer
useExternalMessageReferencesxs:boolean
ElementTypeDescription
statementsstatements

Element: outboundQueueBridge

AttributeTypeDescription
doHandleReplyToxs:boolean
localQueueNamexs:string
maximumRetriesxs:integerSets the maximum number of retries if a send fails before closing the bridge
outboundQueueNamexs:string
selectorxs:string
ElementTypeDescription
consumer<spring:bean/>
consumerConnection<spring:bean/>
consumerQueuequeue
jmsConnectorjmsQueueConnector | jmsTopicConnector
jmsMessageConvertorsimpleJmsMessageConvertor
producerConnection<spring:bean/>
producerQueuequeue

Element: outboundTopicBridge

AttributeTypeDescription
consumerNamexs:string
doHandleReplyToxs:boolean
localTopicNamexs:string
maximumRetriesxs:integerSets the maximum number of retries if a send fails before closing the bridge
outboundTopicNamexs:string
selectorxs:string
ElementTypeDescription
consumer<spring:bean/>
consumerConnection<spring:bean/>
consumerTopictopic
jmsConnectorjmsQueueConnector | jmsTopicConnector
jmsMessageConvertorsimpleJmsMessageConvertor
producerConnection<spring:bean/>
producerTopictopic

Element: pListStore

AttributeTypeDescription
directoryxs:string
enableIndexWriteAsyncxs:boolean
failIfDatabaseIsLockedxs:boolean
journalMaxFileLengthxs:integer
journalMaxWriteBatchSizexs:integer

Element: policyEntry

AttributeTypeDescription
advisdoryForFastProducersxs:boolean
advisoryForConsumedxs:boolean
advisoryForDeliveryxs:boolean
advisoryForDiscardingMessagesxs:boolean
advisoryForSlowConsumersxs:boolean
advisoryWhenFullxs:boolean
allConsumersExclusiveByDefaultxs:boolean
blockedProducerWarningIntervalxs:longSet's the interval at which warnings about producers being blocked by resource usage will be triggered. Values of 0 or less will disable warnings
consumersBeforeDispatchStartsxs:integer
cursorMemoryHighWaterMarkxs:integer
durableTopicPrefetchxs:integerGet the durableTopicPrefetch
enableAuditxs:boolean
expireMessagesPeriodxs:long
gcInactiveDestinationsxs:boolean
inactiveTimoutBeforeGCxs:long
lazyDispatchxs:boolean
maxAuditDepthxs:integer
maxBrowsePageSizexs:integer
maxExpirePageSizexs:integer
maxPageSizexs:integer
maxProducersToAuditxs:integer
maxQueueAuditDepthxs:integer
memoryLimitxs:stringWhen set using Xbean, values of the form "20 Mb", "1024kb", and "1g" can be used
minimumMessageSizexs:long
optimizedDispatchxs:boolean
prioritizedMessagesxs:boolean
producerFlowControlxs:boolean
queuexs:stringA helper method to set the destination from a configuration file
queueBrowserPrefetchxs:integerGet the queueBrowserPrefetch
queuePrefetchxs:integerGet the queuePrefetch
reduceMemoryFootprintxs:boolean
sendAdvisoryIfNoConsumersxs:booleanSends an advisory message if a non-persistent message is sent and there are no active consumers
storeUsageHighWaterMarkxs:integer
strictOrderDispatchxs:boolean
tempQueuexs:boolean
tempTopicxs:boolean
timeBeforeDispatchStartsxs:integer
topicxs:stringA helper method to set the destination from a configuration file
topicPrefetchxs:integerGet the topicPrefetch
useCachexs:boolean
useConsumerPriorityxs:boolean
usePrefetchExtensionxs:boolean
ElementTypeDescription
deadLetterStrategyindividualDeadLetterStrategy | sharedDeadLetterStrategySets the policy used to determine which dead letter queue destination should be used
destinationqueue | topic
dispatchPolicypriorityNetworkDispatchPolicy | roundRobinDispatchPolicy | simpleDispatchPolicy | strictOrderDispatchPolicy
messageEvictionStrategyoldestMessageEvictionStrategy | oldestMessageWithLowestPriorityEvictionStrategySets the eviction strategy used to decide which message to evict when the slow consumer needs to discard messages
messageGroupMapFactorymessageGroupHashBucketFactory | simpleMessageGroupMapFactorySets the factory used to create new instances of {MessageGroupMap} used to implement the Message Groups functionality.
pendingDurableSubscriberPolicyfileDurableSubscriberCursor | storeDurableSubscriberCursor | vmDurableCursor
pendingMessageLimitStrategyconstantPendingMessageLimitStrategy | prefetchRatePendingMessageLimitStrategySets the strategy to calculate the maximum number of messages that are allowed to be pending on consumers (in addition to their prefetch sizes). Once the limit is reached, non-durable topics can then start discarding old messages. This allows us to keep dispatching messages to slow consumers while not blocking fast consumers and discarding the messages oldest first.
pendingQueuePolicyfileQueueCursor | storeCursor | vmQueueCursor
pendingSubscriberPolicyfileCursor | vmCursor
slowConsumerStrategyabortSlowConsumerStrategy
subscriptionRecoveryPolicyfixedCountSubscriptionRecoveryPolicy | fixedSizedSubscriptionRecoveryPolicy | lastImageSubscriptionRecoveryPolicy | noSubscriptionRecoveryPolicy | queryBasedSubscriptionRecoveryPolicy | timedSubscriptionRecoveryPolicy

Element: policyMap

ElementTypeDescription
defaultEntrypolicyEntry
entries(<spring:bean/>)*A helper method to allow the destination map to be populated from a dependency injection framework such as Spring
policyEntries(<spring:bean/>)*Sets the individual entries on the policy map

Element: postgresql-jdbc-adapter

AttributeTypeDescription
batchStatmentsxs:boolean
maxRowsxs:integer
useExternalMessageReferencesxs:boolean
ElementTypeDescription
statementsstatements

Element: prefetchPolicy

AttributeTypeDescription
allxs:integer
durableTopicPrefetchxs:integer
inputStreamPrefetchxs:integer
maximumPendingMessageLimitxs:integerSets how many messages a broker will keep around, above the prefetch limit, for non-durable topics before starting to discard older messages.
optimizeDurableTopicPrefetchxs:integer
queueBrowserPrefetchxs:integer
queuePrefetchxs:integer
topicPrefetchxs:integer

Element: prefetchRatePendingMessageLimitStrategy

AttributeTypeDescription
multiplierxs:doubleSets the multiplier of the prefetch size which will be used to define the maximum number of pending messages for non-durable topics before messages are discarded.

Element: priorityNetworkDispatchPolicy

Element: proxyConnector

AttributeTypeDescription
bindxs:string
localUrixs:string
namexs:string
proxyToLocalBrokerxs:boolean
remotexs:string
ElementTypeDescription
server<spring:bean/>

Element: queryBasedSubscriptionRecoveryPolicy

ElementTypeDescription
brokerforcePersistencyModeBroker | loggingBrokerPlugin | multicastTraceBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin
query<spring:bean/>Sets the query strategy to load initial messages

Element: queue

AttributeTypeDescription
namexs:string
physicalNamexs:string
ElementTypeDescription
compositeDestinations(queue | topic)*
properties<spring:bean/>Get the properties from this instance for storing in JNDI

Element: queueDispatchSelector

ElementTypeDescription
destinationqueue | topic
exclusiveConsumer<spring:bean/>

Element: redeliveryPolicy

AttributeTypeDescription
backOffMultiplierxs:double
collisionAvoidancePercentxs:short
initialRedeliveryDelayxs:long
maximumRedeliveriesxs:integer
redeliveryDelayxs:long
useCollisionAvoidancexs:boolean
useExponentialBackOffxs:boolean

Element: roundRobinDispatchPolicy

Element: sharedDeadLetterStrategy

AttributeTypeDescription
processExpiredxs:boolean
processNonPersistentxs:boolean
ElementTypeDescription
deadLetterQueuequeue | topic

Element: simpleAuthenticationPlugin

AttributeTypeDescription
anonymousAccessAllowedxs:boolean
anonymousGroupxs:string
anonymousUserxs:string
ElementTypeDescription
userGroups<spring:bean/>Sets the groups a user is in. The key is the user name and the value is a Set of groups
userPasswords<spring:bean/>Sets the map indexed by user name with the value the password
users(<spring:bean/>)*Sets individual users for authentication

Element: simpleAuthorizationMap

ElementTypeDescription
adminACLsauthorizationMap | policyMap
readACLsauthorizationMap | policyMap
tempDestinationAuthorizationEntrytempDestinationAuthorizationEntry
writeACLsauthorizationMap | policyMap

Element: simpleDispatchPolicy

Element: simpleDispatchSelector

ElementTypeDescription
destinationqueue | topic

Element: simpleJmsMessageConvertor

ElementTypeDescription
connection<spring:bean/>

Element: simpleMessageGroupMapFactory

Element: sslContext

AttributeTypeDescription
keyStorexs:string
keyStoreAlgorithmxs:string
keyStorePasswordxs:string
keyStoreTypexs:string
protocolxs:string
providerxs:string
secureRandomAlgorithmxs:string
trustStorexs:string
trustStoreAlgorithmxs:string
trustStorePasswordxs:string
trustStoreTypexs:string
ElementTypeDescription
SSLContext<spring:bean/>
keyManagers(<spring:bean/>)*
secureRandom<spring:bean/>
trustManagers(<spring:bean/>)*

Element: statements

AttributeTypeDescription
addMessageStatementxs:string
binaryDataTypexs:string
containerNameDataTypexs:string
createDurableSubStatementxs:string
deleteOldMessagesStatementxs:string
deleteOldMessagesStatementWithPriorityxs:string
deleteSubscriptionStatementxs:string
destinationMessageCountStatementxs:string
durableSubAcksTableNamexs:string
durableSubscriberMessageCountStatementxs:string
durableSubscriberMessageCountStatementWithPriorityxs:string
findAllDestinationsStatementxs:string
findAllDurableSubMessagesStatementxs:string
findAllDurableSubsStatementxs:string
findAllMessagesStatementxs:string
findDurableSubMessagesStatementxs:string
findDurableSubStatementxs:string
findLastSequenceIdInAcksStatementxs:string
findLastSequenceIdInMsgsStatementxs:string
findMessageByIdStatementxs:string
findMessageSequenceIdStatementxs:string
findMessageStatementxs:string
findNextMessagesStatementxs:string
insertDurablePriorityAckStatementxs:string
lastAckedDurableSubscriberMessageStatementxs:string
lastProducerSequenceIdStatementxs:string
lockCreateStatementxs:string
lockTableNamexs:string
lockUpdateStatementxs:string
longDataTypexs:string
messageTableNamexs:string
msgIdDataTypexs:string
nextDurableSubscriberMessageStatementxs:string
removeAllMessagesStatementxs:string
removeAllSubscriptionsStatementxs:string
removeMessageStatmentxs:string
selectDurablePriorityAckStatementxs:string
sequenceDataTypexs:string
stringIdDataTypexs:string
tablePrefixxs:string
updateDurableLastAckStatementxs:string
updateLastPriorityAckRowOfDurableSubStatementxs:string
updateMessageStatementxs:string
useExternalMessageReferencesxs:boolean
useLockCreateWhereClausexs:boolean
ElementTypeDescription
createSchemaStatements(<spring:bean/>)*
dropSchemaStatements(<spring:bean/>)*

Element: statisticsBrokerPlugin

Element: storeCursor

Element: storeDurableSubscriberCursor

Element: storeUsage

AttributeTypeDescription
limitxs:stringSets the memory limit in bytes. Setting the limit in bytes will set the usagePortion to 0 since the UsageManager is not going to be portion based off the parent. When set using Xbean, values of the form "20 Mb", "1024kb", and "1g" can be used
namexs:string
percentUsagexs:integer
percentUsageMinDeltaxs:stringSets the minimum number of percentage points the usage has to change before a UsageListener event is fired by the manager.
pollingTimexs:integer
usagePortionxs:float
ElementTypeDescription
executor<spring:bean/>
limiterdefaultUsageCapacity | usageCapacity
parent<spring:bean/>
storeamqPersistenceAdapter | jdbcPersistenceAdapter | journalPersistenceAdapter | kahaDB | kahaPersistenceAdapter | memoryPersistenceAdapter

Element: streamJDBCAdapter

AttributeTypeDescription
batchStatmentsxs:boolean
maxRowsxs:integer
useExternalMessageReferencesxs:boolean
ElementTypeDescription
statementsstatements

Element: strictOrderDispatchPolicy

Element: sybase-jdbc-adapter

AttributeTypeDescription
batchStatmentsxs:boolean
maxRowsxs:integer
useExternalMessageReferencesxs:boolean
ElementTypeDescription
statementsstatements

Element: systemUsage

AttributeTypeDescription
namexs:string
sendFailIfNoSpacexs:booleanSets whether or not a send() should fail if there is no space free. The default value is false which means to block the send() method until space becomes available
sendFailIfNoSpaceAfterTimeoutxs:long
sendFailIfNoSpaceExplicitySetxs:boolean
ElementTypeDescription
adapteramqPersistenceAdapter | jdbcPersistenceAdapter | journalPersistenceAdapter | kahaDB | kahaPersistenceAdapter | memoryPersistenceAdapter
executor<spring:bean/>
memoryUsagememoryUsage
parentsystemUsage
storeUsagestoreUsage
tempStorepListStore
tempUsagetempUsage

Element: tempDestinationAuthorizationEntry

AttributeTypeDescription
adminxs:string
groupClassxs:string
queuexs:stringA helper method to set the destination from a configuration file
readxs:string
tempQueuexs:boolean
tempTopicxs:boolean
topicxs:stringA helper method to set the destination from a configuration file
writexs:string
ElementTypeDescription
adminACLs(<spring:bean/>)*
destinationqueue | topic
readACLs(<spring:bean/>)*
writeACLs(<spring:bean/>)*

Element: tempUsage

AttributeTypeDescription
limitxs:stringSets the memory limit in bytes. Setting the limit in bytes will set the usagePortion to 0 since the UsageManager is not going to be portion based off the parent. When set using Xbean, values of the form "20 Mb", "1024kb", and "1g" can be used
namexs:string
percentUsagexs:integer
percentUsageMinDeltaxs:stringSets the minimum number of percentage points the usage has to change before a UsageListener event is fired by the manager.
pollingTimexs:integer
usagePortionxs:float
ElementTypeDescription
executor<spring:bean/>
limiterdefaultUsageCapacity | usageCapacity
parent<spring:bean/>
storepListStore

Element: timeStampingBrokerPlugin

AttributeTypeDescription
futureOnlyxs:boolean
ttlCeilingxs:longsetter method for ttlCeiling
zeroExpirationOverridexs:longsetter method for zeroExpirationOverride
ElementTypeDescription
adminConnectionContext<spring:bean/>
nextforcePersistencyModeBroker | loggingBrokerPlugin | multicastTraceBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin
processNetworkMessages<spring:bean/>

Element: timedSubscriptionRecoveryPolicy

AttributeTypeDescription
recoverDurationxs:long
ElementTypeDescription
brokerforcePersistencyModeBroker | loggingBrokerPlugin | multicastTraceBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin

Element: topic

AttributeTypeDescription
namexs:string
physicalNamexs:string
ElementTypeDescription
compositeDestinations(queue | topic)*
properties<spring:bean/>Get the properties from this instance for storing in JNDI

Element: traceBrokerPathPlugin

AttributeTypeDescription
stampPropertyxs:string
ElementTypeDescription
adminConnectionContext<spring:bean/>
nextforcePersistencyModeBroker | loggingBrokerPlugin | multicastTraceBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin

Element: transact-database-locker

AttributeTypeDescription
lockAcquireSleepIntervalxs:long
ElementTypeDescription
exceptionHandler<spring:bean/>
persistenceAdapterjdbcPersistenceAdapter

Element: transact-jdbc-adapter

AttributeTypeDescription
batchStatmentsxs:boolean
maxRowsxs:integer
useExternalMessageReferencesxs:boolean
ElementTypeDescription
statementsstatements

Element: transportConnector

AttributeTypeDescription
brokerNamexs:string
connectUrixs:string
disableAsyncDispatchxs:boolean
discoveryUrixs:string
enableStatusMonitorxs:boolean
namexs:string
rebalanceClusterClientsxs:boolean
updateClusterClientsxs:boolean
updateClusterClientsOnRemovexs:boolean
updateClusterFilterxs:string
urixs:stringSets the server transport URI to use if there is not a {@link TransportServer} configured via the {@link #setServer(TransportServer)} method. This value is used to lazy create a {@link TransportServer} instance
ElementTypeDescription
brokerInfo<spring:bean/>
brokerServicebroker | brokerServiceThis is called by the BrokerService right before it starts the transport.
discoveryAgent<spring:bean/>
messageAuthorizationPolicy<spring:bean/>Sets the policy used to decide if the current connection is authorized to consume a given message
server<spring:bean/>
taskRunnerFactory<spring:bean/>

Element: udpTraceBrokerPlugin

AttributeTypeDescription
broadcastxs:boolean
destinationxs:string
maxTraceDatagramSizexs:integer
ElementTypeDescription
address<spring:bean/>
adminConnectionContext<spring:bean/>
nextforcePersistencyModeBroker | loggingBrokerPlugin | multicastTraceBrokerPlugin | timeStampingBrokerPlugin | traceBrokerPathPlugin | udpTraceBrokerPlugin
wireFormat<spring:bean/>
wireFormatFactory<spring:bean/>

Element: usageCapacity

AttributeTypeDescription
limitxs:long

Element: virtualDestinationInterceptor

ElementTypeDescription
virtualDestinations(compositeQueue | compositeTopic | virtualTopic)*

Element: virtualTopic

AttributeTypeDescription
namexs:string
postfixxs:stringSets any postix used to identify the queue consumers
prefixxs:stringSets the prefix wildcard used to identify the queue consumers for a given topic
selectorAwarexs:booleanIndicates whether the selectors of consumers are used to determine dispatch to a virtual destination, when true only messages matching an existing consumer will be dispatched.

Element: vmCursor

Element: vmDurableCursor

Element: vmQueueCursor

Element: xaConnectionFactory

AttributeTypeDescription
alwaysSessionAsyncxs:booleanIf 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
alwaysSyncSendxs:booleanSet true if always require messages to be sync sent
auditDepthxs:integer
auditMaximumProducerNumberxs:integer
beanNamexs:string
brokerURLxs:stringSets the connection URL used to connect to the ActiveMQ broker.
checkForDuplicatesxs:boolean
clientIDxs:stringSets 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
clientIDPrefixxs:stringSets the prefix used by autogenerated JMS Client ID values which are used if the JMS client does not explicitly specify on.
closeTimeoutxs:integerSets 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
consumerFailoverRedeliveryWaitPeriodxs:long
copyMessageOnSendxs:booleanShould 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
disableTimeStampsByDefaultxs:booleanSets whether or not timestamps on messages should be disabled or not. If you disable them it adds a small performance boost.
dispatchAsyncxs:booleanEnables or disables the default setting of whether or not consumers have their messages dispatched synchronously or asynchronously by the broker. 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.
exclusiveConsumerxs:booleanEnables or disables whether or not queue consumers should be exclusive or not for example to preserve ordering when not using Message Groups
messagePrioritySupportedxs:boolean
nestedMapAndListEnabledxs:booleanEnables/disables whether or not Message properties and MapMessage entries support Nested Structures of Map and List objects
objectMessageSerializationDeferedxs:booleanWhen 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.
optimizeAcknowledgexs:boolean
optimizedMessageDispatchxs:booleanIf this flag is set then an larger prefetch limit is used - only applicable for durable topic subscribers.
passwordxs:stringSets the JMS password used for connections created from this factory
producerWindowSizexs:integer
sendAcksAsyncxs:boolean
sendTimeoutxs:integer
statsEnabledxs:boolean
useAsyncSendxs:booleanForces the use of Async Sends 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.
useBeanNameAsClientIdPrefixxs:boolean
useCompressionxs:booleanEnables the use of compression of the message bodies
useDedicatedTaskRunnerxs:boolean
useRetroactiveConsumerxs:booleanSets 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.
userNamexs:stringSets the JMS userName used by connections created by this factory
warnAboutUnstartedConnectionTimeoutxs:longEnables 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 start the connection 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).
watchTopicAdvisoriesxs:boolean
ElementTypeDescription
blobTransferPolicy<spring:bean/>Sets the policy used to describe how out-of-band BLOBs (Binary Large OBjects) are transferred from producers to brokers to consumers
clientIdGenerator<spring:bean/>
clientInternalExceptionListener<spring:bean/>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.

Note: access to this clientInternalExceptionListener will not 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)

exceptionListenercommandAgentAllows 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.

Note: access to this exceptionLinstener will not 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)

prefetchPolicyprefetchPolicySets the prefetch policy for consumers created by this connection.
properties<spring:bean/>Get the properties from this instance for storing in JNDI
redeliveryPolicyredeliveryPolicySets the global redelivery policy to be used when a message is delivered but the session is rolled back
transformer<spring:bean/>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
transportListener<spring:bean/>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.