Elements By Type
| <ldapNetworkConnector> |
class to create dynamic network connectors listed in an directory
server using the LDAP v3 protocol as defined in RFC 2251, the
entries listed in the directory server must implement the ipHost
and ipService objectClasses as defined in RFC 2307. |
| <multicastNetworkConnector> |
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. |
| <networkConnector> |
A network connector which uses a discovery agent to detect the remote brokers
available and setup a connection to each available remote broker |
| <broker> |
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. |
| <tempUsage> |
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. |
| <memoryUsage> |
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. |
| <authorizationPlugin> |
An authorization plugin where each operation on a destination is checked
against an authorizationMap |
| <connectionDotFilePlugin> |
A DOT file creator plugin which
creates a DOT file showing the current connections |
| <destinationDotFilePlugin> |
A DOT
file creator plugin which creates a DOT file showing the current topic & queue hierarchies. |
| <jaasAuthenticationPlugin> |
Provides a JAAS based authentication plugin |
| <jaasCertificateAuthenticationPlugin> |
Provides a JAAS based SSL certificate authentication plugin |
| <loggingBrokerPlugin> |
A simple Broker interceptor which allows you to enable/disable logging. |
| <multicastTraceBrokerPlugin> |
A Broker interceptor which allows you to trace all operations to a Multicast
socket. |
| <simpleAuthenticationPlugin> |
Provides a simple authentication plugin |
| <timeStampingBrokerPlugin> |
A Broker interceptor which updates a JMS Client's timestamp on the message
with a broker timestamp. Useful when the clocks on client machines are known
to not be correct and you can only trust the time set on the broker machines.
Enabling this plugin will break JMS compliance since the timestamp that the
producer sees on the messages after as send() will be different from the
timestamp the consumer will observe when he receives the message. This plugin
is not enabled in the default ActiveMQ configuration. |
| <udpTraceBrokerPlugin> |
A Broker interceptor which allows you to trace all operations to a UDP
socket. |
| <axionJDBCAdapter> |
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. |
| <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:
|
| <informixJDBCAdapter> |
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. |
| <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:
|
| <connectionFactory> |
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. |
| <xaConnectionFactory> |
A Spring enhanced XA connection
factory which will automatically use the Spring bean name as the clientIDPrefix property
so that connections created have client IDs related to your Spring.xml file for
easier comprehension from JMX. |
| <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. |
| <systemUsage> |
Holder for Usage instances for memory, store and temp files Main use case is
manage memory usage. |
| <connectionFactory> |
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. |
| <xaConnectionFactory> |
A Spring enhanced XA connection
factory which will automatically use the Spring bean name as the clientIDPrefix property
so that connections created have client IDs related to your Spring.xml file for
easier comprehension from JMX. |
| <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. |
| <tempDestinationAuthorizationEntry> |
Represents an entry in a {@link DefaultAuthorizationMap} for assigning
different operations (read, write, admin) of user roles to a temporary
destination |
| <storeUsage> |
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. |
| <prefetchPolicy> |
Defines the prefetch message policies for different types of consumers |
| <loggingBrokerPlugin> |
A simple Broker interceptor which allows you to enable/disable logging. |
| <multicastTraceBrokerPlugin> |
A Broker interceptor which allows you to trace all operations to a Multicast
socket. |
| <timeStampingBrokerPlugin> |
A Broker interceptor which updates a JMS Client's timestamp on the message
with a broker timestamp. Useful when the clocks on client machines are known
to not be correct and you can only trust the time set on the broker machines.
Enabling this plugin will break JMS compliance since the timestamp that the
producer sees on the messages after as send() will be different from the
timestamp the consumer will observe when he receives the message. This plugin
is not enabled in the default ActiveMQ configuration. |
| <udpTraceBrokerPlugin> |
A Broker interceptor which allows you to trace all operations to a UDP
socket. |
| <amqPersistenceAdapter> |
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. |
| <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> |
|
| <policyEntry> |
Represents an entry in a {@link PolicyMap} for assigning policies to a
specific destination or a hierarchical wildcard area of destinations. |
| <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. |
| <redeliveryPolicy> |
Configuration options used to control how messages are re-delivered when they
are rolled back. |
| <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. |
| <lDAPAuthorizationMap> |
An {@link AuthorizationMap} which uses LDAP |
| <simpleAuthorizationMap> |
An AuthorizationMap which is configured with individual DestinationMaps for
each operation. |
| <tempDestinationAuthorizationEntry> |
Represents an entry in a {@link DefaultAuthorizationMap} for assigning
different operations (read, write, admin) of user roles to a temporary
destination |
| <connectionFactory> |
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. |
| <xaConnectionFactory> |
A Spring enhanced XA connection
factory which will automatically use the Spring bean name as the clientIDPrefix property
so that connections created have client IDs related to your Spring.xml file for
easier comprehension from JMX. |
| <broker> |
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. |
| <commandAgent> |
An agent which listens to commands on a JMS destination |
| <forwardingBridge> |
Forwards all messages from the local broker to the remote broker. |
| <inboundQueueBridge> |
Create an Inbound Queue Bridge |
| <inboundTopicBridge> |
Create an Inbound Topic Bridge |
| <jmsQueueConnector> |
A Bridge to other JMS Queue providers |
| <jmsTopicConnector> |
A Bridge to other JMS Topic providers |
| <ldapNetworkConnector> |
class to create dynamic network connectors listed in an directory
server using the LDAP v3 protocol as defined in RFC 2251, the
entries listed in the directory server must implement the ipHost
and ipService objectClasses as defined in RFC 2307. |
| <managementContext> |
A Flow provides different dispatch policies within the NMR |
| <masterConnector> |
Connects a Slave Broker to a Master when using Master Slave for High
Availability of messages. |
| <memoryUsage> |
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. |
| <multicastNetworkConnector> |
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. |
| <networkConnector> |
A network connector which uses a discovery agent to detect the remote brokers
available and setup a connection to each available remote broker |
| <outboundQueueBridge> |
Create an Outbound Queue Bridge |
| <outboundTopicBridge> |
Create an Outbound Topic Bridge |
| <proxyConnector> |
|
| <storeUsage> |
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. |
| <systemUsage> |
Holder for Usage instances for memory, store and temp files Main use case is
manage memory usage. |
| <tempUsage> |
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. |
| <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. |
| <ldapNetworkConnector> |
class to create dynamic network connectors listed in an directory
server using the LDAP v3 protocol as defined in RFC 2251, the
entries listed in the directory server must implement the ipHost
and ipService objectClasses as defined in RFC 2307. |
| <multicastNetworkConnector> |
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. |
| <networkConnector> |
A network connector which uses a discovery agent to detect the remote brokers
available and setup a connection to each available remote broker |
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 |
| 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
mb", "1024 kb", or "1 gb" |
| maxCheckpointMessageAddSize |
int |
When set using XBean, you can use values such as: "20
mb", "1024 kb", or "1 gb" |
| maxFileLength |
int |
When set using XBean, you can use values such as: "20
mb", "1024 kb", or "1 gb" |
| persistentIndex |
boolean |
|
| referenceStoreAdapter |
org.apache.activemq.store.ReferenceStoreAdapter |
|
| syncOnWrite |
boolean |
|
| taskRunnerFactory |
org.apache.activemq.thread.TaskRunnerFactory |
|
| usageManager |
org.apache.activemq.usage.SystemUsage |
|
| useNio |
boolean |
|
| wireFormat |
org.apache.activemq.wireformat.WireFormat |
|
An implementation of {@link PersistenceAdapterFactory}
Properties
| 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 |
|
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 |
|
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.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 |
java.lang.String |
A helper method to set the destination from a configuration file |
| write |
java.lang.String |
|
| writeACLs |
(java.lang.Object)* |
|
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
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. 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.
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 |
| clustered |
boolean |
|
| consumerSystemUsage |
org.apache.activemq.usage.SystemUsage |
|
| dataDirectory |
java.lang.String |
Sets the directory in which the data files will be stored by default for
the JDBC and Journal persistence adaptors. |
| dataDirectoryFile |
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. |
| destinationFactory |
org.apache.activemq.broker.region.DestinationFactory |
|
| 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 |
| enableStatistics |
boolean |
Sets whether or not the Broker's services enable statistics or not. |
| jmsBridgeConnectors |
(org.apache.activemq.network.jms.JmsConnector)* |
|
| keepDurableSubsActive |
boolean |
|
| managementContext |
org.apache.activemq.broker.jmx.ManagementContext |
|
| masterConnectorURI |
java.lang.String |
|
| 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 |
(org.apache.activemq.network.NetworkConnector)* |
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 |
|
| persistenceTaskRunnerFactory |
org.apache.activemq.thread.TaskRunnerFactory |
|
| persistenceThreadPriority |
int |
|
| 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. |
| producerSystemUsage |
org.apache.activemq.usage.SystemUsage |
|
| proxyConnectors |
(java.lang.Object)* |
Sets the network connectors which this broker will use to connect to
other brokers in a federated network |
| services |
(org.apache.activemq.Service)* |
Sets the services associated with this broker such as a
{@link MasterConnector} |
| 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. |
| supportFailOver |
boolean |
|
| systemUsage |
org.apache.activemq.usage.SystemUsage |
|
| taskRunnerFactory |
org.apache.activemq.thread.TaskRunnerFactory |
|
| tempDataStore |
org.apache.activemq.kaha.Store |
|
| tmpDataDirectory |
java.io.File |
|
| transportConnectorURIs |
(java.lang.String)* |
|
| transportConnectors |
(org.apache.activemq.broker.TransportConnector)* |
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. |
| useLocalHostBrokerName |
boolean |
|
| useLoggingForShutdownErrors |
boolean |
Sets whether or not we should use commons-logging when reporting errors
when shutting down the broker |
| useMirroredQueues |
boolean |
Sets whether or not Mirrored
Queues should be supported by default if they have not been
explicitly configured. |
| 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
An agent which listens to commands on a JMS destination
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.lang.Object)* |
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.lang.Object)* |
Sets the list of destinations to forward to |
| name |
java.lang.String |
Sets the name of this composite destination |
A
