Apache ActiveMQ ™ -- XBean XML Reference 5.0

- -

ActiveMQ ™ ASF @@ -615,9 +616,9 @@ available and setup a connection to each

The <amqPersistenceAdapter> Element

- An implementation of {@link PersistenceAdapter} designed for use with a +

An 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. +other long term persistent storage.

Properties

The <amqPersistenceAdapterFactory> Element

- An implementation of {@link PersistenceAdapterFactory} +

An implementation of {@link PersistenceAdapterFactory}

Properties

Property Name	Type	Description
archiveDataLogs	boolean
asyncDataManager	org.apache.activemq.kaha.impl.async.AsyncDataManager
brokerName	java.lang.String
brokerService	org.apache.activemq.broker.BrokerService
checkpointInterval	long
cleanupInterval	long
directory	java.io.File
directoryArchive	java.io.File
indexBinSize	int
indexKeySize	int
indexPageSize	int	When set using XBean, you can use values such as: "20 @@ -629,7 +630,7 @@ mb", "1024 kb", or "1 gb"

Property Name	Type	Description
brokerName	java.lang.String
dataDirectory	java.io.File
journalThreadPriority	int
maxFileLength	int
persistentIndex	boolean
referenceStoreAdapter	org.apache.activemq.store.ReferenceStoreAdapter
syncOnWrite	boolean
taskRunnerFactory	org.apache.activemq.thread.TaskRunnerFactory
useNio	boolean

@@ -638,7 +639,7 @@ mb", "1024 kb", or "1 gb"

The <authenticationUser> Element

- A helper object used to configure simple authentiaction plugin +

A helper object used to configure simple authentiaction plugin

Properties

Property Name	Type	Description
groups	java.lang.String
password	java.lang.String
username	java.lang.String

@@ -647,9 +648,9 @@ mb", "1024 kb", or "1 gb"

The <authorizationEntry> Element

- Represents an entry in a {@link DefaultAuthorizationMap} for assigning +

Represents 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. +destination or a hierarchical wildcard area of destinations.

Properties

Property Name	Type	Description
admin	java.lang.String
adminACLs	(java.lang.Object)*
destination	org.apache.activemq.command.ActiveMQDestination
groupClass	java.lang.String
queue	java.lang.String	A helper method to set the destination from a configuration file
read	java.lang.String
readACLs	(java.lang.Object)*
topic < /td>	java.lang.String	A helper method to set the destination from a configuration file
write	java.lang.String
writeACLs	(java.lang.Object)*

@@ -658,10 +659,10 @@ destination or a hierarchical wildcard a

The <authorizationMap> Element

- Represents a destination based configuration of policies so that individual +

Represents 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. +for each operation.

Properties

Property Name

Type

Description

authorizationEntries

(java.lang.Object)*

Sets the individual entries on the authorization map

defaultEntry

org.apache.activemq.security.AuthorizationEntry

entries

(java.la ng.Object)*

A helper method to allow the destination map to be populated from a @@ -671,8 +672,8 @@ dependency injection framework such as S

The <authorizationPlugin> Element

- An authorization plugin where each operation on a destination is checked -against an authorizationMap +

An authorization plugin where each operation on a destination is checked +against an authorizationMap

Properties

Property Name	Type	Description
map	org.apache.activemq.security.AuthorizationMap

@@ -681,11 +682,11 @@ against an authorizationMap

The <axionJDBCAdapter> Element

- Axion specific Adapter. +

Axion 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. +- We cannot delete durable sub messages that have be acknowledged by all consumers.

Properties

Property Name	Type	Description
batchStatments	boolean
statements	org.apache.activemq.store.jdbc.Statements
useExternalMessageReferences	boolean

@@ -694,7 +695,7 @@ Axion does not seem to support ALTER sta

The <blobJDBCAdapter> Element

- This JDBCAdapter inserts and extracts BLOB data using the getBlob()/setBlob() +

This 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: @@ -702,7 +703,7 @@ to: value. The databases/JDBC drivers that use this adapter are: -

Properties

Property Name	Type	Description
batchStatments	boolean
statements	org.apache.activemq.store.jdbc.Statements
useExternalMessageReferences	boolean

@@ -711,9 +712,9 @@ The databases/JDBC drivers that use this

The <broker> Element

- An ActiveMQ Message Broker. It consists of a number of transport +

An 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. +configure the broker as its lazily created.

Properties

Property Name

Type

Description

adminView

org.apache.activemq.broker.jmx.BrokerView

Returns the administration view of the broker; used to create and destroy @@ -745,9 +746,9 @@ explicitly configured.

The <bytesJDBCAdapter> Element

- This JDBCAdapter inserts and extracts BLOB data using the +

This JDBCAdapter inserts and extracts BLOB data using the setBytes()/getBytes() operations. The databases/JDBC drivers that use this -adapter are: +adapter are:

Properties

Property Name	Type	Description
batchStatments	boolean
statements	org.apache.activemq.store.jdbc.Statements
useExternalMessageReferences	boolean

@@ -756,7 +757,7 @@ adapter are:

The <commandAgent> Element

- An agent which listens to commands on a JMS destination +

An agent which listens to commands on a JMS destination

Properties

Property Name	Type	Description
brokerUrl	java.lang.String
commandDestination	javax.jms.Destination
connection	javax.jms.Connection
connectionFactory	javax.jms.ConnectionFactory

@@ -765,8 +766,8 @@ adapter are:

The <compositeDemandForwardingBridge> Element

- A demand forwarding bridge which works with multicast style transports where -a single Transport could be communicating with multiple remote brokers +

A demand forwarding bridge which works with multicast style transports where +a single Transport could be communicating with multiple remote brokers

Properties

Property Name	Type	Description
configuration	org.apache.activemq.network.NetworkBridgeConfiguration
createdByDuplex	boolean
durableDestinations	(org.apache.activemq.command.ActiveMQDestination)*
dynamicallyIncludedDestinations	(org.apache.activemq.command.ActiveMQDestination)*
excludedDestinations	(org.apache.activemq.command.ActiveMQDestination)*
localBroker	org.apache.activemq.transport.Transport
networkBridgeListener	org.apache.activemq.network.NetworkBridgeListener
remoteBroker	org.apache.activemq.transport.Transport
staticallyIncludedDestinations	(org.apache.activemq.command.ActiveMQDestination)*

@@ -775,7 +776,7 @@ a single Transport could be communicatin

The <compositeQueue> Element

- Represents a virtual queue which forwards to a number of other destinations. +

Represents a virtual queue which forwards to a number of other destinations.

Properties

The <compositeTopic> Element

- Represents a virtual topic which forwards to a number of other destinations. +

Represents a virtual topic which forwards to a number of other destinations.

Properties

Property Name	Type	Description
copyMessage	boolean	Sets whether a copy of the message will be sent to each destination. @@ -788,7 +789,7 @@ queue with the same name).

The <connectionDotFilePlugin> Element

- A DOT file creator plugin which -creates a DOT file showing the current connections +

A DOT file creator plugin which +creates a DOT file showing the current connections

Properties

Property Name	Type	Description
copyMessage	boolean	Sets whether a copy of the message will be sent to each destination. @@ -801,8 +802,8 @@ queue with the same name).

Property Name	Type	Description
file	java.lang.String	Sets the destination file name to create the destination diagram

@@ -811,10 +812,10 @@ creates a DOT file showing the current c

The <connectionFactory> Element

- A Spring enhanced connection +

A 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. +easier comprehension from JMX.

Properties

Property Name

Type

Description

alwaysSessionAsync

boolean

If this flag is set then a separate thread is not used for dispatching @@ -868,7 +869,7 @@ warning if the user forgets. To disable

The <constantPendingMessageLimitStrategy> Element

- This PendingMessageLimitStrategy is configured to a constant value for all subscriptions. +

This PendingMessageLimitStrategy is configured to a constant value for all subscriptions.

Properties

Property Name	Type	Description
limit	int

@@ -877,7 +878,7 @@ warning if the user forgets. To disable

The <db2JDBCAdapter> Element

- +

Properties

Property Name	Type	Description
batchStatments	boolean
statements	org.apache.activemq.store.jdbc.Statements
useExternalMessageReferences	boolean

@@ -886,8 +887,8 @@ warning if the user forgets. To disable

The <defaultJDBCAdapter> Element

- Implements all the default JDBC operations that are used by the -JDBCPersistenceAdapter.

sub-classing is encouraged to override the +

Implements 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 @@ -901,7 +902,7 @@ use this adapter are:

The <defaultUsageCapacity> Element

- Identify if a limit has been reached +

Identify if a limit has been reached

Properties

Property Name	Type	Description
limit	long

@@ -910,7 +911,7 @@ use this adapter are:

The <demandForwardingBridge> Element

- Forwards messages from the local broker to the remote broker based on demand. +

Forwards messages from the local broker to the remote broker based on demand.

Properties

Property Name	Type	Description
configuration	org.apache.activemq.network.NetworkBridgeConfiguration
createdByDuplex	boolean
durableDestinations	(org.apache.activemq.command.ActiveMQDestination)*
dynamicallyIncludedDestinations	(org.apache.activemq.command.ActiveMQDestination)*
excludedDestinations	(org.apache.activemq.command.ActiveMQDestination)*
localBroker	org.apache.activemq.transport.Transport
networkBridgeListener	org.apache.activemq.network.NetworkBridgeListener
remoteBroker	org.apache.activemq.transport.Transport
staticallyIncludedDestinations	(org.apache.activemq.command.ActiveMQDestination)*

@@ -919,8 +920,8 @@ use this adapter are:

The <destinationDotFilePlugin> Element

- A DOT -file creator plugin which creates a DOT file showing the current topic & queue hierarchies. +

A DOT +file creator plugin which creates a DOT file showing the current topic & queue hierarchies.

Properties

Property Name	Type	Description
file	java.lang.String	Sets the destination file name to create the destination diagram

@@ -929,7 +930,7 @@ file creator plugin which creates a DOT

The <destinationEntry> Element

- A default entry in a DestinationMap which holds a single value. +

A default entry in a DestinationMap which holds a single value.

Properties

Property Name	Type	Description
destination	org.apache.activemq.command.ActiveMQDestination
queue	java.lang.String	A helper method to set the destination from a configuration file
topic	java.lang.String< /em>	A helper method to set the destination from a configuration file
value	java.lang.Object

@@ -938,20 +939,20 @@ file creator plugin which creates a DOT

The <fileCursor> Element

- Pending messages +

Pending messages

The <fileDurableSubscriberCursor> Element

- Pending messages for durable subscribers +

Pending messages for durable subscribers

The <fileQueueCursor> Element

- Pending +

Pending

The <filteredDestination> Element

- Represents 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. +

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

Properties

Property Name	Type	Description
destination	org.apache.activemq.command.ActiveMQDestination	The destination to send messages to if they match the filter
filter	org.apache.activemq.filter.BooleanExpression
queue	java.lang.String	Sets the destination property to the given queue name
selector	java.lang.String	Sets the JMS selector used to filter messages before forwarding them to this destination
topic	java.lang.String	Sets the destination property to the given topic name

@@ -960,8 +961,8 @@ so that messages are only dispatched to

The <fixedCountSubscriptionRecoveryPolicy> Element

- This implementation of {@link SubscriptionRecoveryPolicy} will keep a fixed -count of last messages. +

This implementation of {@link SubscriptionRecoveryPolicy} will keep a fixed +count of last messages.

Properties

Property Name	Type	Description
maximumSize	int	Sets the maximum number of messages that this destination will hold @@ -971,9 +972,9 @@ around in RAM

The <fixedSizedSubscriptionRecoveryPolicy> Element

- This implementation of {@link SubscriptionRecoveryPolicy} will keep a fixed +

This implementation of {@link SubscriptionRecoveryPolicy} will keep a fixed amount of memory available in RAM for message history which is evicted in -time order. +time order.

Properties

Property Name	Type	Description
buffer	org.apache.activemq.memory.list.MessageList
maximumSize	int	Sets the maximum amount of RAM in bytes that this buffer can hold in RAM
useSharedBuffer	boolean

@@ -982,7 +983,7 @@ time order.

The <forwardingBridge> Element

- Forwards all messages from the local broker to the remote broker. +

Forwards all messages from the local broker to the remote broker.

Properties

Property Name	Type	Description
clientId	java.lang.String
destinationFilter	java.lang.String
dispatchAsync	boolean
localBroker	org.apache.activemq.transport.Transport
networkBridgeFailedListener	org.apache.activemq.network.NetworkBridgeListener
prefetchSize	int
remoteBroker	org.apache.activemq.transport.Transport

@@ -991,11 +992,11 @@ time order.

The <imageBasedJDBCAdaptor> Element

- Provides JDBCAdapter since that uses +

Provides JDBCAdapter since that uses IMAGE datatype to hold binary data. The databases/JDBC drivers that use this adapter are: -

Sybase
MS SQL

Sybase
MS SQL

Properties

Property Name	Type	Description
batchStatments	boolean
statements	org.apache.activemq.store.jdbc.Statements
useExternalMessageReferences	boolean

@@ -1004,7 +1005,7 @@ The databases/JDBC drivers that use this

The <inboundQueueBridge> Element

- Create an Inbound Queue Bridge +

Create an Inbound Queue Bridge

Properties

Property Name

Type

Description

consumer

javax.jms.MessageConsumer

consumerConnection

javax.jms.QueueConnection

consumerQueue

javax.jms.Queue

doHandleReplyTo

boolean

inboundQueueName

java.lang.String

jmsConnector

org.apache.activemq.network.jms.JmsConnector

jmsMessageConvertor

org.apache.activemq.network.jms.JmsMesageConvertor

localQueueName

java.lang.String

maximumRetries

int

Sets the maximum number of retries if a send fails before closing the @@ -1014,7 +1015,7 @@ bridge

The <inboundTopicBridge> Element

- Create an Inbound Topic Bridge +

Create an Inbound Topic Bridge

Properties

Property Name

Type

Description

consumer

javax.jms.MessageConsumer

consumerConnection

javax.jms.TopicConnection

consumerName

java.lang.String

consumerTopic

javax.jms.Topic

doHandleReplyTo

boolean

inboundTopicName

java.lang.String

jmsConnector

org.apache.activemq.network.jms.JmsConnector

jmsMessageConvertor

org.apache.activemq.network.jms.JmsMesageConvertor

localTopicName

java.lang.String

maximumRetries

int

Sets the maximum number of retries if a send fails before closing the @@ -1024,8 +1025,8 @@ bridge

The <individualDeadLetterStrategy> Element

- A {@link DeadLetterStrategy} where each destination has its own individual -DLQ using the subject naming hierarchy. +

A {@link DeadLetterStrategy} where each destination has its own individual +DLQ using the subject naming hierarchy.

Properties

The <informixJDBCAdapter> Element

- JDBC Adapter for Informix database. +

JDBC 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. +Therefore be sure not to use longer names for container name and subscription id than 150 characters.

Properties

Property Name	Type	Description
processExpired	boolean
processNonPersistent	boolean
queuePrefix	java.lang.String	Sets the prefix to use for all dead letter queues for queue messages
topicPrefix	java.lang.String	Sets the prefix to use for all dead letter queues for topic messages
useQueueForQueueMessages	boolean	Sets whether a queue or topic should be used for queue messages sent to a @@ -1036,10 +1037,10 @@ DLQ. The default is to use a Queue

Property Name	Type	Description
batchStatments	boolean
statements	org.apache.activemq.store.jdbc.Statements
useExternalMessageReferences	boolean

@@ -1048,7 +1049,7 @@ Therefore be sure not to use longer name

The <jaasAuthenticationPlugin> Element

- Provides a JAAS based authentication plugin +

Provides a JAAS based authentication plugin

Properties

Property Name

Type

Description

configuration

java.lang.String

Sets the JAAS configuration domain name used

discoverLoginConfig

boolean

Enables or disables the auto-discovery of the login.config file for JAAS to initialize itself. @@ -1059,7 +1060,7 @@ is not defined then it is set to the loc

The <jaasCertificateAuthenticationPlugin> Element

- Provides a JAAS based SSL certificate authentication plugin +

Provides a JAAS based SSL certificate authentication plugin

Properties

Property Name

Type

Description

configuration

java.lang.String

Sets the JAAS configuration domain name used

discoverLoginConfig

boolean

Enables or disables the auto-discovery of the login.config file for JAAS to initialize itself. @@ -1070,12 +1071,12 @@ is not defined then it is set to the loc

The <jdbcPersistenceAdapter> Element

- A {@link PersistenceAdapter} implementation using JDBC for persistence +

A {@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. +performed against the Message store are done as a single uow.

Properties

Property Name

Type

Description

adapter

org.apache.activemq.store.jdbc.JDBCAdapter

brokerName

java.lang.String

brokerService

org.apache.activemq.broker.BrokerService

cleanupPeriod

int

Sets the number of milliseconds until the database is attempted to be @@ -1086,7 +1087,7 @@ JDBC Master/Slave. Enabled by default. <

The <jmsQueueConnector> Element

- A Bridge to other JMS Queue providers +

A Bridge to other JMS Queue providers

Properties

Property Name

Type

Description

brokerService

org.apache.activemq.broker.BrokerService

One way to configure the local connection - this is called by The @@ -1096,7 +1097,7 @@ BrokerService when the Connector is embe

The <jmsTopicConnector> Element

- A Bridge to other JMS Topic providers +

A Bridge to other JMS Topic providers

Properties

Property Name

Type

Description

brokerService

org.apache.activemq.broker.BrokerService

One way to configure the local connection - this is called by The @@ -1106,9 +1107,9 @@ BrokerService when the Connector is embe

The <journalPersistenceAdapter> Element

- An implementation of {@link PersistenceAdapter} designed for use with a +

Properties

Property Name	Type	Description
brokerName	java.lang.String
directory	java.io.File
journal	org.apache.activeio.journal.Journal
longTermPersistence	org.apache.activemq.store.PersistenceAdapter
maxCheckpointMessageAddSize	int
maxCheckpointWorkers	int
taskRunnerFactory	org.apache.activemq.thread.TaskRunnerFactory
us ageManager	org.apache.activemq.usage.SystemUsage
useExternalMessageReferences	boolean

@@ -1117,7 +1118,7 @@ other long term persistent storage.

The <journaledJDBC> Element

- Creates a default persistence model using the Journal and JDBC +

Creates a default persistence model using the Journal and JDBC

Properties

< td colspan="1" rowspan="1" class="confluenceTd">

Property Name

Type

Description

adapter

org.apache.activemq.store.jdbc.JDBCAdapter

createTablesOnStartup

boolean

Sets whether or not tables are created on startup

dataDirectory

java.lang.String

dataDirectoryFile

java.io.File

dataSource

javax.sql.DataSource

jdbcAdapter

org.apache.activemq.store.jdbc.JDBCPersistenceAdapter

journal

org.apache.activeio. journal.Journal

journalArchiveDirectory

java.io.File

journalLogFileSize

int

Sets the size of the journal log files

journalLogFiles

int

Sets the number of journal log files to use

journalThreadPriority

int

Sets the thread priority of the journal thread

statements

org.apache.activemq.store.jdbc.Statements

taskRunnerFactory

org.apache.activemq.thread.TaskRunnerFactory

useDatabaseLock

boolean

Sets whether or not an exclusive database lock should be used to enable @@ -1130,7 +1131,7 @@ false so that messages actually reside l

The <kahaPersistenceAdapter> Element

- +

Properties

Property Name	Type	Description
brokerName	java.lang.String
directory	java.io.File
maxDataFileLength	long
persistentIndex	boolean
size	java.util.concurrent.atomic.AtomicLong
usageManager	org.apache.activemq.usage.SystemUsage

@@ -1139,7 +1140,7 @@ false so that messages actually reside l

The <lDAPAuthorizationMap> Element

- An {@link AuthorizationMap} which uses LDAP +

An {@link AuthorizationMap} which uses LDAP

Properties

[... 546 lines stripped ...]