Elements By Type
| <broker> |
An ActiveMQ Message Broker which consists of a number of transport connectors, network connectors and a persistence adaptor |
| <blobJDBCAdapter> |
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: |
| <bytesJDBCAdapter> |
This JDBCAdapter inserts and extracts BLOB data using the setBytes()/getBytes() operations. The databases/JDBC drivers that use this adapter are: |
| <db2JDBCAdapter> |
|
| <defaultJDBCAdapter> |
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: |
| <imageBasedJDBCAdaptor> |
Provides JDBCAdapter since that uses IMAGE datatype to hold binary data. The databases/JDBC drivers that use this adapter are: |
| <oracleJDBCAdapter> |
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: |
| <streamJDBCAdapter> |
This JDBCAdapter inserts and extracts BLOB data using the setBinaryStream()/getBinaryStream() operations. The databases/JDBC drivers that use this adapter are: |
| <compositeQueue> |
Represents a virtual queue which forwards to a number of other destinations. |
| <compositeTopic> |
Represents a virtual topic which forwards to a number of other destinations. |
| <virtualTopic> |
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. |
| <policyMap> |
Represents a destination based configuration of policies so that individual destinations or wildcard hierarchies of destinations can be configured using different policies. |
| <journaledJDBC> |
Creates a default persistence model using the Journal and JDBC |
| <authorizationEntry> |
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. |
| <topic> |
An ActiveMQ Topic Destination |
| <jdbcPersistenceAdapter> |
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. |
| <journalPersistenceAdapter> |
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. |
| <kahaPersistenceAdapter> |
|
| <memoryPersistenceAdapter> |
|
| <quickJournalPersistenceAdapter> |
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. |
| <rapidPersistenceAdapter> |
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. |
| <policyEntry> |
Represents an entry in a {@link PolicyMap} for assigning policies to a specific destination or a hierarchical wildcard area of destinations. |
| <usageManager> |
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. |
| <jdbcPersistenceAdapter> |
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. |
| <queue> |
An ActiveMQ Queue Destination |
| <topic> |
An ActiveMQ Topic Destination |
| <authorizationMap> |
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. |
| <simpleAuthorizationMap> |
An AuthorizationMap which is configured with individual DestinationMaps for each operation. |
| <queue> |
An ActiveMQ Queue Destination |
| <authorizationMap> |
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. |
| <policyMap> |
Represents a destination based configuration of policies so that individual destinations or wildcard hierarchies of destinations can be configured using different policies. |
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 |
|
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 |
An authorization plugin where each operation on a destination is checked against an authorizationMap
Properties
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
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
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 |
|
This JDBCAdapter inserts and extracts BLOB data using the setBytes()/getBytes() operations. The databases/JDBC drivers that use this adapter are:
Properties
A demand forwarding bridge which works with multicast style transports where a single Transport could be communicating with multiple remote brokers
Properties
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 |
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 |
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 |
This PendingMessageLimitStrategy is configured to a constant value for all subscriptions.
Properties
| Property Name |
Type |
Description |
| limit |
int |
|
Properties
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
Forwards messages from the local broker to the remote broker based on demand.
Properties
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 |
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 |
|
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 |
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 |
|
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 |
|
Provides JDBCAdapter since that uses IMAGE datatype to hold binary data. The databases/JDBC drivers that use this adapter are:
Properties
Create an Inbound Queue Bridge
Properties
Create an Inbound Topic Bridge
Properties
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 |
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
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. |
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
A Bridge to other JMS Queue providers
Properties
A Bridge to other JMS Topic providers
Properties
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
Creates a default persistence model using the Journal and JDBC
Properties
Properties
This implementation of {@link SubscriptionRecoveryPolicy} will only keep the last message.
A simple Broker interceptor which allows you to enable/disable logging.