Apache ActiveMQ ™ -- XBean XML Reference 4.1
Using ActiveMQ > Xml Reference > XBean XML Reference 4.1
Elements By Type
The org.apache.activemq.network.jms.InboundQueueBridge Type Implementations
Create an Inbound Queue Bridge
The org.apache.activemq.broker.BrokerService Type Implementations
An ActiveMQ Message Broker which consists of a number of transport connectors, network connectors and a persistence adaptor
The org.apache.activemq.broker.BrokerPlugin Type Implementations
An authorization plugin where each operation on a destination is checked against an authorizationMap
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 topic & queue hierarchies.
Provides a JAAS based authentication plugin
A simple Broker interceptor which allows you to enable/disable logging.
Provides a simple authentication plugin configured with a map of user-passwords and a map of user-groups
The org.apache.activemq.store.jdbc.JDBCAdapter Type Implementations
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: 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:
This JDBCAdapter inserts and extracts BLOB data using the setBytes()/getBytes() operations. The databases/JDBC drivers that use this adapter are:
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 use this adapter are:
Provides JDBCAdapter since that uses IMAGE datatype to hold binary data. The databases/JDBC drivers that use this adapter are:
- Sybase
- MS SQL
Implements 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:
This JDBCAdapter inserts and extracts BLOB data using the setBinaryStream()/getBinaryStream() operations. The databases/JDBC drivers that use this adapter are:
- Axion
The org.apache.activemq.broker.region.virtual.VirtualDestination Type Implementations
Represents a virtual queue which forwards to a number of other destinations.
Represents a virtual topic which forwards to a number of other destinations.
Creates 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.
The org.apache.activemq.broker.region.policy.PolicyMap Type Implementations
Represents a destination based configuration of policies so that individual destinations or wildcard hierarchies of destinations can be configured using different policies.
The org.apache.activemq.broker.region.policy.PendingMessageLimitStrategy Type Implementations
This PendingMessageLimitStrategy is configured to a constant value for all subscriptions.
This PendingMessageLimitStrategy sets the maximum pending message limit value to be a multiplier of the prefetch limit of the subscription.
The org.apache.activemq.broker.region.policy.SubscriptionRecoveryPolicy Type Implementations
This implementation of {@link SubscriptionRecoveryPolicy} will only keep the last message.
This implementation of {@link SubscriptionRecoveryPolicy} will keep a fixed amount of memory available in RAM for message history which is evicted in time order.
This implementation of {@link SubscriptionRecoveryPolicy} will only keep the last message.
This is the default Topic recovery policy which does not recover any messages.
This implementation of {@link SubscriptionRecoveryPolicy} will perform a user specific query mechanism to load any messages they may have missed.
This implementation of {@link SubscriptionRecoveryPolicy} will keep a timed buffer of messages around in memory and use that to recover new subscriptions.
The org.apache.activemq.store.jdbc.Statements Type Implementations
The org.apache.activemq.broker.jmx.ManagementContext Type Implementations
A Flow provides different dispatch policies within the NMR
The org.apache.activemq.store.PersistenceAdapterFactory Type Implementations
Creates a default persistence model using the Journal and JDBC
The org.apache.activemq.security.AuthorizationEntry Type Implementations
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.
The org.apache.activemq.broker.region.policy.DeadLetterStrategy Type Implementations
A {@link DeadLetterStrategy} where each destination has its own individual DLQ using the subject naming hierarchy.
A default implementation of {@link DeadLetterStrategy} which uses a constant destination.
The javax.jms.Topic Type Implementations
An ActiveMQ Topic Destination
The org.apache.activemq.store.PersistenceAdapter Type Implementations
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.
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.
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.
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.
The org.apache.activemq.broker.region.policy.PolicyEntry Type Implementations
Represents an entry in a {@link PolicyMap} for assigning policies to a specific destination or a hierarchical wildcard area of destinations.
The org.apache.activemq.network.DemandForwardingBridgeSupport Type Implementations
A demand forwarding bridge which works with multicast style transports where a single Transport could be communicating with multiple remote brokers
Forwards messages from the local broker to the remote broker based on demand.
The org.apache.activemq.network.jms.OutboundQueueBridge Type Implementations
Create an Outbound Queue Bridge
The org.apache.activemq.memory.UsageManager Type Implementations
Used 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.
The org.apache.activemq.store.jdbc.JDBCPersistenceAdapter Type Implementations
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.
The org.apache.activemq.command.ActiveMQDestination Type Implementations
An ActiveMQ Queue Destination
An ActiveMQ Topic Destination
The org.apache.activemq.network.jms.InboundTopicBridge Type Implementations
Create an Inbound Topic Bridge
The org.apache.activemq.network.jms.JmsConnector Type Implementations
A Bridge to other JMS Queue providers
A Bridge to other JMS Topic providers
The org.apache.activemq.security.AuthorizationMap Type Implementations
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.
An AuthorizationMap which is configured with individual DestinationMaps for each operation.
The org.apache.activemq.broker.region.policy.DispatchPolicy Type Implementations
Simple dispatch policy that sends a message to every subscription that matches the message.
Simple dispatch policy that sends a message to every subscription that matches the message.
Dispatch policy that causes every subscription to see messages in the same order.
The javax.jms.Queue Type Implementations
An ActiveMQ Queue Destination
The org.apache.activemq.broker.region.policy.MessageEvictionStrategy Type Implementations
An eviction strategy which evicts the oldest message first (which is the default).
An eviction strategy which evicts the oldest message with the lowest priority first.
The org.apache.activemq.network.jms.JmsMesageConvertor Type Implementations
Converts Message from one JMS to another
The org.apache.activemq.broker.region.DestinationInterceptor Type Implementations
Implements Virtual Topics.
The org.apache.activemq.network.jms.OutboundTopicBridge Type Implementations
Create an Outbound Topic Bridge
The org.apache.activemq.filter.DestinationMap Type Implementations
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.
Represents a destination based configuration of policies so that individual destinations or wildcard hierarchies of destinations can be configured using different policies.
The
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.
Properties
Property Name
Type
Description
admin
java.lang.String
adminACLs
java.util.Set
destination
org.apache.activemq.command.ActiveMQDestination
queue
java.lang.String
A helper method to set the destination from a configuration file
read
java.lang.String
readACLs
java.util.Set
topic
java.lang.String
A helper method to set the destination from a configuration file
write
java.lang.String
writeACLs
java.util.Set
The
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.
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.lang.Object)*
A helper method to allow the destination map to be populated from a dependency injection framework such as Spring
The
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
The
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.
Properties
Property Name
Type
Description
batchStatments
boolean
statements
org.apache.activemq.store.jdbc.Statements
useExternalMessageReferences
boolean
The
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: 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:
Properties
Property Name
Type
Description
batchStatments
boolean
statements
org.apache.activemq.store.jdbc.Statements
useExternalMessageReferences
boolean
The
An ActiveMQ Message Broker which consists of a number of transport connectors, network connectors and a persistence adaptor
Properties
Property Name
Type
Description
adminView
org.apache.activemq.broker.jmx.BrokerView
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.
advisorySupport
boolean
Allows the support of advisory messages to be disabled for performance reasons.
brokerName
java.lang.String
Sets the name of this broker; which must be unique in the network
brokerObjectName
javax.management.ObjectName
Sets the JMX ObjectName for this broker
dataDirectory
java.io.File
Sets the directory in which the data files will be stored by default for the JDBC and Journal persistence adaptors.
deleteAllMessagesOnStartup
boolean
Sets whether or not all messages are deleted on startup - mostly only useful for testing.
destinationInterceptors
(org.apache.activemq.broker.region.DestinationInterceptor)*
Sets the destination interceptors to use
destinationPolicy
org.apache.activemq.broker.region.policy.PolicyMap
Sets the destination specific policies available either for exact destinations or for wildcard areas of destinations.
destinations
(org.apache.activemq.command.ActiveMQDestination)*
Sets the destinations which should be loaded/created on startup
jmsBridgeConnectors
(org.apache.activemq.network.jms.JmsConnector)*
keepDurableSubsActive
boolean
managementContext
org.apache.activemq.broker.jmx.ManagementContext
masterConnectorURI
java.lang.String
memoryManager
org.apache.activemq.memory.UsageManager
messageAuthorizationPolicy
org.apache.activemq.security.MessageAuthorizationPolicy
Sets the policy used to decide if the current connection is authorized to consume a given message
networkConnectorURIs
(java.lang.String)*
networkConnectors
(java.lang.Object)*
Sets the network connectors which this broker will use to connect to other brokers in a federated network
persistenceAdapter
org.apache.activemq.store.PersistenceAdapter
Sets the persistence adaptor implementation to use for this broker
persistenceFactory
org.apache.activemq.store.PersistenceAdapterFactory
persistent
boolean
Sets whether or not persistence is enabled or disabled.
plugins
(org.apache.activemq.broker.BrokerPlugin)*
Sets a number of broker plugins to install such as for security authentication or authorization
populateJMSXUserID
boolean
Sets whether or not the broker should populate the JMSXUserID header.
proxyConnectors
(java.lang.Object)*
Sets the network connectors which this broker will use to connect to other brokers in a federated network
shutdownOnMasterFailure
boolean
start
boolean
Sets 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.
taskRunnerFactory
org.apache.activemq.thread.TaskRunnerFactory
transportConnectorURIs
(java.lang.String)*
transportConnectors
(java.lang.Object)*
Sets the transport connectors which this broker will listen on for new clients
useJmx
boolean
Sets whether or not the Broker's services should be exposed into JMX or not.
useLoggingForShutdownErrors
boolean
Sets whether or not we should use commons-logging when reporting errors when shutting down the broker
useShutdownHook
boolean
Sets 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.
useVirtualTopics
boolean
Sets whether or not Virtual Topics should be supported by default if they have not been explicitly configured.
vmConnectorURI
java.net.URI
The
This JDBCAdapter inserts and extracts BLOB data using the setBytes()/getBytes() operations. 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
The
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
decreaseNetworkConsumerPriority
boolean
dispatchAsync
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
localBrokerName
java.lang.String
name
java.lang.String
networkTTL
int
password
java.lang.String
prefetchSize
int
remoteBroker
org.apache.activemq.transport.Transport
staticallyIncludedDestinations
(org.apache.activemq.command.ActiveMQDestination)*
userName
java.lang.String
The
Represents a virtual queue 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. Defaults to true so that the forward destination is set as the destination of the message
forwardOnly
boolean
Sets 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).
forwardTo
java.util.Collection
Sets the list of destinations to forward to
name
java.lang.String
Sets the name of this composite destination
The
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. Defaults to true so that the forward destination is set as the destination of the message
forwardOnly
boolean
Sets 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).
forwardTo
java.util.Collection
Sets the list of destinations to forward to
name
java.lang.String
Sets the name of this composite destination
The
A DOT file creator plugin which creates a DOT file showing the current connections
Properties
Property Name
Type
Description
file
java.lang.String
Sets the destination file name to create the destination diagram
The
This PendingMessageLimitStrategy is configured to a constant value for all subscriptions.
Properties
Property Name
Type
Description
limit
int
The
Properties
Property Name
Type
Description
batchStatments
boolean
statements
org.apache.activemq.store.jdbc.Statements
useExternalMessageReferences
boolean
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 use this adapter are:
Properties
Property Name
Type
Description
batchStatments
boolean
statements
org.apache.activemq.store.jdbc.Statements
useExternalMessageReferences
boolean
The
Forwards messages from the local broker to the remote broker based on demand.
Properties
Property Name
Type
Description
decreaseNetworkConsumerPriority
boolean
dispatchAsync
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
localBrokerName
java.lang.String
name
java.lang.String
networkTTL
int
password
java.lang.String
prefetchSize
int
remoteBroker
org.apache.activemq.transport.Transport
staticallyIncludedDestinations
(org.apache.activemq.command.ActiveMQDestination)*
userName
java.lang.String
The
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
The
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
A helper method to set the destination from a configuration file
value
java.lang.Object
The
This implementation of {@link SubscriptionRecoveryPolicy} will only keep the last message.
Properties
Property Name
Type
Description
maximumSize
int
Sets the maximum number of messages that this destination will hold around in RAM
The
This implementation of {@link SubscriptionRecoveryPolicy} will keep a fixed amount of memory available in RAM for message history which is evicted in 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
The
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
prefetchSize
int
remoteBroker
org.apache.activemq.transport.Transport
The
Provides JDBCAdapter since that uses IMAGE datatype to hold binary data. The databases/JDBC drivers that use this adapter are:
- Sybase
- MS SQL
Properties
Property Name
Type
Description
batchStatments
boolean
statements
org.apache.activemq.store.jdbc.Statements
useExternalMessageReferences
boolean
The
Create an Inbound Queue Bridge
Properties
Property Name
Type
Description
consumer
javax.jms.MessageConsumer
consumerConnection
javax.jms.QueueConnection
consumerQueue
doHandleReplyTo
boolean
inboundQueueName
java.lang.String
jmsConnector
org.apache.activemq.network.jms.JmsConnector
jmsMessageConvertor
org.apache.activemq.network.jms.JmsMesageConvertor
producerConnection
javax.jms.QueueConnection
producerQueue
selector
java.lang.String
The
Create an Inbound Topic Bridge
Properties
Property Name
Type
Description
consumer
javax.jms.MessageConsumer
consumerConnection
javax.jms.TopicConnection
consumerName
java.lang.String
consumerTopic
doHandleReplyTo
boolean
inboundTopicName
java.lang.String
jmsConnector
org.apache.activemq.network.jms.JmsConnector
jmsMessageConvertor
org.apache.activemq.network.jms.JmsMesageConvertor
producerConnection
javax.jms.TopicConnection
producerTopic
selector
java.lang.String
The
A {@link DeadLetterStrategy} where each destination has its own individual DLQ using the subject naming hierarchy.
Properties
Property Name
Type
Description
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 DLQ. The default is to use a Queue
useQueueForTopicMessages
boolean
Sets whether a queue or topic should be used for topic messages sent to a DLQ. The default is to use a Queue
The
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.
Properties
Property Name
Type
Description
batchStatments
boolean
statements
org.apache.activemq.store.jdbc.Statements
useExternalMessageReferences
boolean
The
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. 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.
The
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.
Properties
Property Name
Type
Description
adapter
org.apache.activemq.store.jdbc.JDBCAdapter
brokerService
org.apache.activemq.broker.BrokerService
cleanupPeriod
int
dataDirectory
java.lang.String
dataDirectoryFile
java.io.File
dataSource
javax.sql.DataSource
databaseLocker
org.apache.activemq.store.jdbc.DatabaseLocker
Sets the database locker strategy to use to lock the database on startup
ds
javax.sql.DataSource
scheduledThreadPoolExecutor
edu.emory.mathcs.backport.java.util.concurrent.ScheduledThreadPoolExecutor
statements
org.apache.activemq.store.jdbc.Statements
usageManager
org.apache.activemq.memory.UsageManager
useDatabaseLock
boolean
useExternalMessageReferences
boolean
wireFormat
org.apache.activeio.command.WireFormat
The
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 BrokerService when the Connector is embedded
inboundMessageConvertor
org.apache.activemq.network.jms.JmsMesageConvertor
inboundQueueBridges
(org.apache.activemq.network.jms.InboundQueueBridge)*
jndiLocalTemplate
org.springframework.jndi.JndiTemplate
jndiOutboundTemplate
org.springframework.jndi.JndiTemplate
localConnectionFactoryName
java.lang.String
localPassword
java.lang.String
localQueueConnection
javax.jms.QueueConnection
localQueueConnectionFactory
javax.jms.QueueConnectionFactory
localUsername
java.lang.String
name
java.lang.String
outboundMessageConvertor
org.apache.activemq.network.jms.JmsMesageConvertor
outboundPassword
java.lang.String
outboundQueueBridges
(org.apache.activemq.network.jms.OutboundQueueBridge)*
outboundQueueConnection
javax.jms.QueueConnection
outboundQueueConnectionFactory
javax.jms.QueueConnectionFactory
outboundQueueConnectionFactoryName
java.lang.String
outboundUsername
java.lang.String
replyToDestinationCacheSize
int
The
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 BrokerService when the Connector is embedded
inboundMessageConvertor
org.apache.activemq.network.jms.JmsMesageConvertor
inboundTopicBridges
(org.apache.activemq.network.jms.InboundTopicBridge)*
jndiLocalTemplate
org.springframework.jndi.JndiTemplate
jndiOutboundTemplate
org.springframework.jndi.JndiTemplate
localConnectionFactoryName
java.lang.String
localPassword
java.lang.String
localTopicConnection
javax.jms.TopicConnection
localTopicConnectionFactory
javax.jms.TopicConnectionFactory
localUsername
java.lang.String
name
java.lang.String
outboundMessageConvertor
org.apache.activemq.network.jms.JmsMesageConvertor
outboundPassword
java.lang.String
outboundTopicBridges
(org.apache.activemq.network.jms.OutboundTopicBridge)*
outboundTopicConnection
javax.jms.TopicConnection
outboundTopicConnectionFactory
javax.jms.TopicConnectionFactory
outboundTopicConnectionFactoryName
java.lang.String
outboundUsername
java.lang.String
replyToDestinationCacheSize
int
The
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.
Properties
Property Name
Type
Description
journal
org.apache.activeio.journal.Journal
longTermPersistence
org.apache.activemq.store.PersistenceAdapter
maxCheckpointMessageAddSize
int
maxCheckpointWorkers
int
taskRunnerFactory
org.apache.activemq.thread.TaskRunnerFactory
usageManager
org.apache.activemq.memory.UsageManager
useExternalMessageReferences
boolean
The
Creates a default persistence model using the Journal and JDBC
Properties
Property Name
Type
Description
adapter
org.apache.activemq.store.jdbc.JDBCAdapter
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
journalLogFiles
int
statements
org.apache.activemq.store.jdbc.Statements
taskRunnerFactory
org.apache.activemq.thread.TaskRunnerFactory
useJournal
boolean
useQuickJournal
boolean
The
Properties
Property Name
Type
Description
dir
java.io.File
usageManager
org.apache.activemq.memory.UsageManager
useExternalMessageReferences
boolean
The
This implementation of {@link SubscriptionRecoveryPolicy} will only keep the last message.
The
A simple Broker interceptor which allows you to enable/disable logging.
Properties
Property Name
Type
Description
ackLog
org.apache.commons.logging.Log
adminConnectionContext
org.apache.activemq.broker.ConnectionContext
log
org.apache.commons.logging.Log
next
org.apache.activemq.broker.Broker
sendLog
org.apache.commons.logging.Log
The
A Flow provides different dispatch policies within the NMR
Properties
Property Name
Type
Description
MBeanServer
javax.management.MBeanServer
Get the MBeanServer
connectorPath
java.lang.String
connectorPort
int
createConnector
boolean
createMBeanServer
boolean
findTigerMbeanServer
boolean
Enables/disables the searching for the Java 5 platform MBeanServer
jmxDomainName
java.lang.String
server
javax.management.MBeanServer
useMBeanServer
boolean
The
Properties
Property Name
Type
Description
usageManager
org.apache.activemq.memory.UsageManager
useExternalMessageReferences
boolean
The
A 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.
Properties
Property Name
Type
Description
bridge
org.apache.activemq.network.DemandForwardingBridgeSupport
brokerName
java.lang.String
conduitSubscriptions
boolean
connectionFilter
org.apache.activemq.network.ConnectionFilter
decreaseNetworkConsumerPriority
boolean
dispatchAsync
boolean
durableDestinations
java.util.Set
dynamicOnly
boolean
dynamicallyIncludedDestinations
(java.lang.Object)*
excludedDestinations
(java.lang.Object)*
localTransport
org.apache.activemq.transport.Transport
localUri
java.net.URI
name
java.lang.String
networkTTL
int
password
java.lang.String
prefetchSize
int
remoteTransport
org.apache.activemq.transport.Transport
Sets the remote transport implementation
remoteURI
java.net.URI
Sets the remote transport URI to some group transport like multicast://address:port
staticallyIncludedDestinations
(java.lang.Object)*
userName
java.lang.String
The
A network connector which uses a discovery agent to detect the remote brokers available and setup a connection to each available remote broker
Properties
Property Name
Type
Description
brokerName
java.lang.String
conduitSubscriptions
boolean
connectionFilter
org.apache.activemq.network.ConnectionFilter
decreaseNetworkConsumerPriority
boolean
discoveryAgent
org.apache.activemq.transport.discovery.DiscoveryAgent
discoveryURI
java.net.URI
dispatchAsync
boolean
durableDestinations
java.util.Set
dynamicOnly
boolean
dynamicallyIncludedDestinations
(java.lang.Object)*
excludedDestinations
(java.lang.Object)*
failover
boolean
localUri
java.net.URI
name
java.lang.String
networkTTL
int
password
java.lang.String
prefetchSize
int
staticallyIncludedDestinations
(java.lang.Object)*
uri
java.net.URI
userName
java.lang.String
The
This is the default Topic recovery policy which does not recover any messages.
The
An eviction strategy which evicts the oldest message first (which is the default).
Properties
Property Name
Type
Description
evictExpiredMessagesHighWatermark
int
Sets the high water mark on which we will eagerly evict expired messages from RAM
The
An eviction strategy which evicts the oldest message with the lowest priority first.
Properties
Property Name
Type
Description
evictExpiredMessagesHighWatermark
int
Sets the high water mark on which we will eagerly evict expired messages from RAM
The
Implements 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:
Properties
Property Name
Type
Description
batchStatments
boolean
statements
org.apache.activemq.store.jdbc.Statements
useExternalMessageReferences
boolean
The
Create an Outbound Queue Bridge
Properties
Property Name
Type
Description
consumer
javax.jms.MessageConsumer
consumerConnection
javax.jms.QueueConnection
consumerQueue
doHandleReplyTo
boolean
jmsConnector
org.apache.activemq.network.jms.JmsConnector
jmsMessageConvertor
org.apache.activemq.network.jms.JmsMesageConvertor
outboundQueueName
java.lang.String
producerConnection
javax.jms.QueueConnection
producerQueue
selector
java.lang.String
The
Create an Outbound Topic Bridge
Properties
Property Name
Type
Description
consumer
javax.jms.MessageConsumer
consumerConnection
javax.jms.TopicConnection
consumerName
java.lang.String
consumerTopic
doHandleReplyTo
boolean
jmsConnector
org.apache.activemq.network.jms.JmsConnector
jmsMessageConvertor
org.apache.activemq.network.jms.JmsMesageConvertor
outboundTopicName
java.lang.String
producerConnection
javax.jms.TopicConnection
producerTopic
selector
java.lang.String
The
Represents an entry in a {@link PolicyMap} for assigning policies to a specific destination or a hierarchical wildcard area of destinations.
Properties
Property Name
Type
Description
deadLetterStrategy
org.apache.activemq.broker.region.policy.DeadLetterStrategy
Sets the policy used to determine which dead letter queue destination should be used
destination
org.apache.activemq.command.ActiveMQDestination
dispatchPolicy
org.apache.activemq.broker.region.policy.DispatchPolicy
memoryLimit
long
messageEvictionStrategy
org.apache.activemq.broker.region.policy.MessageEvictionStrategy
Sets the eviction strategy used to decide which message to evict when the slow consumer needs to discard messages
messageGroupHashBucketCount
int
Sets 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).
pendingMessageLimitStrategy
org.apache.activemq.broker.region.policy.PendingMessageLimitStrategy
Sets 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.
queue
java.lang.String
A helper method to set the destination from a configuration file
sendAdvisoryIfNoConsumers
boolean
Sends an advisory message if a non-persistent message is sent and there are no active consumers
subscriptionRecoveryPolicy
org.apache.activemq.broker.region.policy.SubscriptionRecoveryPolicy
topic
java.lang.String
A helper method to set the destination from a configuration file
The
Represents a destination based configuration of policies so that individual destinations or wildcard hierarchies of destinations can be configured using different policies.
Properties
Property Name
Type
Description
defaultEntry
org.apache.activemq.broker.region.policy.PolicyEntry
entries
(java.lang.Object)*
A helper method to allow the destination map to be populated from a dependency injection framework such as Spring
policyEntries
(java.lang.Object)*
Sets the individual entries on the policy map
The
This PendingMessageLimitStrategy sets the maximum pending message limit value to be a multiplier of the prefetch limit of the subscription.
Properties
Property Name
Type
Description
multiplier
double
Sets 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.
The
Properties
Property Name
Type
Description
bind
java.net.URI
localUri
java.net.URI
name
java.lang.String
remote
java.net.URI
server
org.apache.activemq.transport.TransportServer
The
This implementation of {@link SubscriptionRecoveryPolicy} will perform a user specific query mechanism to load any messages they may have missed.
Properties
Property Name
Type
Description
query
org.apache.activemq.broker.region.policy.MessageQuery
Sets the query strategy to load initial messages
The
An ActiveMQ Queue Destination
Properties
Property Name
Type
Description
compositeDestinations
(org.apache.activemq.command.ActiveMQDestination)*
name
java.lang.String
physicalName
java.lang.String
properties
java.util.Properties
Get the properties from this instance for storing in JNDI
The
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.
Properties
Property Name
Type
Description
journal
org.apache.activeio.journal.Journal
longTermPersistence
org.apache.activemq.store.PersistenceAdapter
maxCheckpointMessageAddSize
int
maxCheckpointWorkers
int
taskRunnerFactory
org.apache.activemq.thread.TaskRunnerFactory
usageManager
org.apache.activemq.memory.UsageManager
useExternalMessageReferences
boolean
The
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.
Properties
Property Name
Type
Description
journal
org.apache.activeio.journal.Journal
maxCheckpointMessageAddSize
int
maxCheckpointWorkers
int
taskRunnerFactory
org.apache.activemq.thread.TaskRunnerFactory
usageManager
org.apache.activemq.memory.UsageManager
useExternalMessageReferences
boolean
The
Simple dispatch policy that sends a message to every subscription that matches the message.
The
A default implementation of {@link DeadLetterStrategy} which uses a constant destination.
Properties
Property Name
Type
Description
deadLetterQueue
org.apache.activemq.command.ActiveMQDestination
The
Provides a simple authentication plugin configured with a map of user-passwords and a map of user-groups
Properties
Property Name
Type
Description
userGroups
java.util.Map
Sets the groups a user is in. The key is the user name and the value is a Set of groups
userPasswords
java.util.Map
Sets the map indexed by user name with the value the password
The
An AuthorizationMap which is configured with individual DestinationMaps for each operation.
Properties
Property Name
Type
Description
adminACLs
org.apache.activemq.filter.DestinationMap
readACLs
org.apache.activemq.filter.DestinationMap
writeACLs
org.apache.activemq.filter.DestinationMap
The
Simple dispatch policy that sends a message to every subscription that matches the message.
The
Converts Message from one JMS to another
Properties
Property Name
Type
Description
connection
javax.jms.Connection
The
Properties
Property Name
Type
Description
addMessageStatement
java.lang.String
binaryDataType
java.lang.String
containerNameDataType
java.lang.String
createDurableSubStatement
java.lang.String
createSchemaStatements
(java.lang.String)*
deleteOldMessagesStatement
java.lang.String
deleteSubscriptionStatement
java.lang.String
dropSchemaStatements
(java.lang.String)*
durableSubAcksTableName
java.lang.String
findAllDestinationsStatement
java.lang.String
findAllDurableSubMessagesStatement
java.lang.String
findAllDurableSubsStatement
java.lang.String
findAllMessagesStatement
java.lang.String
findDurableSubStatement
java.lang.String
findLastSequenceIdInAcksStatement
java.lang.String
findLastSequenceIdInMsgsStatement
java.lang.String
findMessageSequenceIdStatement
java.lang.String
findMessageStatement
java.lang.String
lockCreateStatement
java.lang.String
lockTableName
java.lang.String
lockUpdateStatement
java.lang.String
longDataType
java.lang.String
messageTableName
java.lang.String
msgIdDataType
java.lang.String
removeAllMessagesStatement
java.lang.String
removeAllSubscriptionsStatement
java.lang.String
removeMessageStatment
java.lang.String
sequenceDataType
java.lang.String
stringIdDataType
java.lang.String
tablePrefix
java.lang.String
updateLastAckOfDurableSubStatement
java.lang.String
updateMessageStatement
java.lang.String
useExternalMessageReferences
boolean
useLockCreateWhereClause
boolean
The
This JDBCAdapter inserts and extracts BLOB data using the setBinaryStream()/getBinaryStream() operations. The databases/JDBC drivers that use this adapter are:
- Axion
Properties
Property Name
Type
Description
batchStatments
boolean
statements
org.apache.activemq.store.jdbc.Statements
useExternalMessageReferences
boolean
The
Dispatch policy that causes every subscription to see messages in the same order.
The
This implementation of {@link SubscriptionRecoveryPolicy} will keep a timed buffer of messages around in memory and use that to recover new subscriptions.
Properties
Property Name
Type
Description
recoverDuration
long
The
An ActiveMQ Topic Destination
Properties
Property Name
Type
Description
compositeDestinations
(org.apache.activemq.command.ActiveMQDestination)*
name
java.lang.String
physicalName
java.lang.String
properties
java.util.Properties
Get the properties from this instance for storing in JNDI
The
Properties
Property Name
Type
Description
broker
org.apache.activemq.broker.Broker
brokerInfo
org.apache.activemq.command.BrokerInfo
brokerName
java.lang.String
connectUri
java.net.URI
disableAsyncDispatch
boolean
discoveryAgent
org.apache.activemq.transport.discovery.DiscoveryAgent
discoveryUri
java.net.URI
messageAuthorizationPolicy
org.apache.activemq.security.MessageAuthorizationPolicy
Sets the policy used to decide if the current connection is authorized to consume a given message
name
java.lang.String
server
org.apache.activemq.transport.TransportServer
taskRunnerFactory
org.apache.activemq.thread.TaskRunnerFactory
uri
java.net.URI
Sets 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
The
Used 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.
Properties
Property Name
Type
Description
limit
long
Sets the memory limit in bytes
limitKb
long
Sets the memory limit in kilobytes
limitMb
long
Sets the memory limit in megabytes
parent
org.apache.activemq.memory.UsageManager
percentUsage
int
percentUsageMinDelta
int
Sets the minimum number of percentage points the usage has to change before a UsageListener event is fired by the manager.
The
Implements Virtual Topics.
Properties
Property Name
Type
Description
virtualDestinations
(org.apache.activemq.broker.region.virtual.VirtualDestination)*
The
Creates 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.
Properties
Property Name
Type
Description
name
java.lang.String
postfix
java.lang.String
Sets any postix used to identify the queue consumers
prefix
java.lang.String
Sets the prefix wildcard used to identify the queue consumers for a given topic
Element Index
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.
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.
An authorization plugin where each operation on a destination is checked against an authorizationMap
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.
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: 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:
An ActiveMQ Message Broker which consists of a number of transport connectors, network connectors and a persistence adaptor
This JDBCAdapter inserts and extracts BLOB data using the setBytes()/getBytes() operations. The databases/JDBC drivers that use this adapter are:
A demand forwarding bridge which works with multicast style transports where a single Transport could be communicating with multiple remote brokers
Represents a virtual queue which forwards to a number of other destinations.
Represents a virtual topic which forwards to a number of other destinations.
A DOT file creator plugin which creates a DOT file showing the current connections
This PendingMessageLimitStrategy is configured to a constant value for all subscriptions.
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 use this adapter are:
Forwards messages from the local broker to the remote broker based on demand.
A DOT file creator plugin which creates a DOT file showing the current topic & queue hierarchies.
A default entry in a DestinationMap which holds a single value.
This implementation of {@link SubscriptionRecoveryPolicy} will only keep the last message.
This implementation of {@link SubscriptionRecoveryPolicy} will keep a fixed amount of memory available in RAM for message history which is evicted in time order.
Forwards all messages from the local broker to the remote broker.
Provides JDBCAdapter since that uses IMAGE datatype to hold binary data. The databases/JDBC drivers that use this adapter are:
- Sybase
- MS SQL
Create an Inbound Queue Bridge
Create an Inbound Topic Bridge
A {@link DeadLetterStrategy} where each destination has its own individual DLQ using the subject naming hierarchy.
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.
Provides a JAAS based authentication plugin
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.
A Bridge to other JMS Queue providers
A Bridge to other JMS Topic providers
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.
Creates a default persistence model using the Journal and JDBC
This implementation of {@link SubscriptionRecoveryPolicy} will only keep the last message.
A simple Broker interceptor which allows you to enable/disable logging.
A Flow provides different dispatch policies within the NMR
A 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.
A network connector which uses a discovery agent to detect the remote brokers available and setup a connection to each available remote broker
This is the default Topic recovery policy which does not recover any messages.
An eviction strategy which evicts the oldest message first (which is the default).
An eviction strategy which evicts the oldest message with the lowest priority first.
Implements 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:
Create an Outbound Queue Bridge
Create an Outbound Topic Bridge
Represents an entry in a {@link PolicyMap} for assigning policies to a specific destination or a hierarchical wildcard area of destinations.
Represents a destination based configuration of policies so that individual destinations or wildcard hierarchies of destinations can be configured using different policies.
This PendingMessageLimitStrategy sets the maximum pending message limit value to be a multiplier of the prefetch limit of the subscription.
This implementation of {@link SubscriptionRecoveryPolicy} will perform a user specific query mechanism to load any messages they may have missed.
An ActiveMQ Queue Destination
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.
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.
Simple dispatch policy that sends a message to every subscription that matches the message.
A default implementation of {@link DeadLetterStrategy} which uses a constant destination.
Provides a simple authentication plugin configured with a map of user-passwords and a map of user-groups
An AuthorizationMap which is configured with individual DestinationMaps for each operation.
Simple dispatch policy that sends a message to every subscription that matches the message.
Converts Message from one JMS to another
This JDBCAdapter inserts and extracts BLOB data using the setBinaryStream()/getBinaryStream() operations. The databases/JDBC drivers that use this adapter are:
- Axion
Dispatch policy that causes every subscription to see messages in the same order.
This implementation of {@link SubscriptionRecoveryPolicy} will keep a timed buffer of messages around in memory and use that to recover new subscriptions.
An ActiveMQ Topic Destination
Used 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.
Implements Virtual Topics.
Creates 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.