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
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 |
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.
Properties
| Property Name | Type | Description |
|---|
| alwaysSessionAsync | boolean | If this flag is set then a separate thread is not used for dispatching
messages for each Session in the Connection. However, a separate thread
is always used if there is more than one session, or the session isn't in
auto acknowledge or duplicates ok mode |
| alwaysSyncSend | boolean | Set true if always require messages to be sync sent |
| beanName | java.lang.String | |
| blobTransferPolicy | org.apache.activemq.blob.BlobTransferPolicy | Sets the policy used to describe how out-of-band BLOBs (Binary Large
OBjects) are transferred from producers to brokers to consumers |
| brokerURL | java.lang.String | Sets the connection
URL used to connect to the ActiveMQ broker. |
| clientID | java.lang.String | Sets the JMS clientID to use for the created connection. Note that this
can only be used by one connection at once so generally its a better idea
to set the clientID on a Connection |
| clientIDPrefix | java.lang.String | Sets the prefix used by autogenerated JMS Client ID values which are used
if the JMS client does not explicitly specify on. |
| clientIdGenerator | org.apache.activemq.util.IdGenerator | |
| closeTimeout | int | Sets the timeout before a close is considered complete. Normally a
close() on a connection waits for confirmation from the broker; this
allows that operation to timeout to save the client hanging if there is
no broker |
| copyMessageOnSend | boolean | Should a JMS message be copied to a new JMS Message object as part of the
send() method in JMS. This is enabled by default to be compliant with the
JMS specification. You can disable it if you do not mutate JMS messages
after they are sent for a performance boost |
| disableTimeStampsByDefault | boolean | Sets whether or not timestamps on messages should be disabled or not. If
you disable them it adds a small performance boost. |
| dispatchAsync | boolean | Enables or disables the default setting of whether or not consumers have
their messages dispatched
synchronously or asynchronously by the broker. For non-durable
topics for example we typically dispatch synchronously by default to
minimize context switches which boost performance. However sometimes its
better to go slower to ensure that a single blocked consumer socket does
not block delivery to other consumers. |
| exclusiveConsumer | boolean | Enables or disables whether or not queue consumers should be exclusive or
not for example to preserve ordering when not using Message Groups |
| nestedMapAndListEnabled | boolean | Enables/disables whether or not Message properties and MapMessage entries
support Nested
Structures of Map and List objects |
| objectMessageSerializationDefered | boolean | When an object is set on an ObjectMessage, the JMS spec requires the
object to be serialized by that set method. Enabling this flag causes the
object to not get serialized. The object may subsequently get serialized
if the message needs to be sent over a socket or stored to disk. |
| optimizeAcknowledge | boolean | |
| optimizedMessageDispatch | boolean | If this flag is set then an larger prefetch limit is used - only
applicable for durable topic subscribers. |
| password | java.lang.String | Sets the JMS password used for connections created from this factory |
| prefetchPolicy | org.apache.activemq.ActiveMQPrefetchPolicy | Sets the prefetch
policy for consumers created by this connection. |
| producerWindowSize | int | |
| properties | java.util.Properties | Get the properties from this instance for storing in JNDI |
| redeliveryPolicy | org.apache.activemq.RedeliveryPolicy | Sets the global redelivery policy to be used when a message is delivered
but the session is rolled back |
| statsEnabled | boolean | |
| transformer | org.apache.activemq.MessageTransformer | Sets the transformer used to transform messages before they are sent on
to the JMS bus or when they are received from the bus but before they are
delivered to the JMS client |
| transportListener | org.apache.activemq.transport.TransportListener | Allows a listener to be configured on the ConnectionFactory so that when this factory is used
with frameworks which don't expose the Connection such as Spring JmsTemplate, you can still register
a transport listener. |
| useAsyncSend | boolean | Forces the use of Async Sends which
adds a massive performance boost; but means that the send() method will
return immediately whether the message has been sent or not which could
lead to message loss. |
| useBeanNameAsClientIdPrefix | boolean | |
| useCompression | boolean | Enables the use of compression of the message bodies |
| useRetroactiveConsumer | boolean | Sets whether or not retroactive consumers are enabled. Retroactive
consumers allow non-durable topic subscribers to receive old messages
that were published before the non-durable subscriber started. |
| userName | java.lang.String | Sets the JMS userName used by connections created by this factory |
| warnAboutUnstartedConnectionTimeout | long | Enables the timeout from a connection creation to when a warning is
generated if the connection is not properly started via
{@link Connection#start()} and a message is received by a consumer. It is
a very common gotcha to forget to start
the connection so this option makes the default case to create a
warning if the user forgets. To disable the warning just set the value to <
0 (say -1). |
| watchTopicAdvisories | boolean | |
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
Identify if a limit has been reached
Properties
| Property Name | Type | Description |
|---|
| limit | long | |
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 | |
Pending messages
Pending messages for durable subscribers
Pending
Represents a destination which is filtered using some predicate such as a selector
so that messages are only dispatched to the destination if they match the filter.
Properties
| Property Name | Type | Description |
|---|
| destination | org.apache.activemq.command.ActiveMQDestination | The destination to send messages to if they match the filter |
| filter | org.apache.activemq.filter.BooleanExpression | |
| queue | java.lang.String | Sets the destination property to the given queue name |
| selector | java.lang.String | Sets the JMS selector used to filter messages before forwarding them to this destination |
| topic | java.lang.String | Sets the destination property to the given topic name |
This implementation of {@link SubscriptionRecoveryPolicy} will keep a fixed
count of last messages.
Properties
| Property Name | Type | Description |
|---|
| maximumSize | int | Sets the maximum number of messages that this destination will hold
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 | |
| networkBridgeFailedListener | org.apache.activemq.network.NetworkBridgeListener | |
| 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 |
|---|
| processExpired | boolean | |
| processNonPersistent | boolean | |
| queuePrefix | java.lang.String | Sets the prefix to use for all dead letter queues for queue messages |
| topicPrefix | java.lang.String | Sets the prefix to use for all dead letter queues for topic messages |
| useQueueForQueueMessages | boolean | Sets whether a queue or topic should be used for queue messages sent to a
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. |
Provides a JAAS based SSL certificate authentication plugin
Properties
| Property Name | Type | Description |
|---|
| configuration | java.lang.String | Sets the JAAS configuration domain name used |
| discoverLoginConfig | boolean | Enables or disables the auto-discovery of the login.config file for JAAS to initialize itself.
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
| Property Name | Type | Description |
|---|
| adapter | org.apache.activemq.store.jdbc.JDBCAdapter | |
| brokerName | java.lang.String | |
| brokerService | org.apache.activemq.broker.BrokerService | |
| cleanupPeriod | int | Sets the number of milliseconds until the database is attempted to be
cleaned up for durable topics |
| createTablesOnStartup | boolean | Sets whether or not tables are created on startup |
| 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 |
| directory | java.io.File | |
| ds | javax.sql.DataSource | |
| scheduledThreadPoolExecutor | java.util.concurrent.ScheduledThreadPoolExecutor | |
| statements | org.apache.activemq.store.jdbc.Statements | |
| usageManager | org.apache.activemq.usage.SystemUsage | |
| useDatabaseLock | boolean | Sets whether or not an exclusive database lock should be used to enable
JDBC Master/Slave. Enabled by default. |
| useExternalMessageReferences | boolean | |
| wireFormat | org.apache.activemq.wireformat.WireFormat | |
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
| Property Name | Type | Description |
|---|
| adapter | org.apache.activemq.store.jdbc.JDBCAdapter | |
| createTablesOnStartup | boolean | Sets whether or not tables are created on startup |
| dataDirectory | java.lang.String | |
| dataDirectoryFile | java.io.File | |
| dataSource | javax.sql.DataSource | |
| jdbcAdapter | org.apache.activemq.store.jdbc.JDBCPersistenceAdapter | |
| journal | org.apache.activeio.journal.Journal | |
| journalArchiveDirectory | java.io.File | |
| journalLogFileSize | int | Sets the size of the journal log files |
| journalLogFiles | int | Sets the number of journal log files to use |
| journalThreadPriority | int | Sets the thread priority of the journal thread |
| statements | org.apache.activemq.store.jdbc.Statements | |
| taskRunnerFactory | org.apache.activemq.thread.TaskRunnerFactory | |
| useDatabaseLock | boolean | Sets whether or not an exclusive database lock should be used to enable
JDBC Master/Slave. Enabled by default. |
| useJournal | boolean | Enables or disables the use of the journal. The default is to use the
journal |
| useQuickJournal | boolean | Enables or disables the use of quick journal, which keeps messages in the
journal and just stores a reference to the messages in JDBC. Defaults to
false so that messages actually reside long term in the JDBC database. |
Properties
| Property Name | Type | Description |
|---|
| brokerName | java.lang.String | |
| directory | java.io.File | |
| maxDataFileLength | long | |
| persistentIndex | boolean | |
| size | java.util.concurrent.atomic.AtomicLong | |
| usageManager | org.apache.activemq.usage.SystemUsage | |
An {@link AuthorizationMap} which uses LDAP
Properties
| Property Name | Type | Description |
|---|
| adminAttribute | java.lang.String | |
| adminBase | java.lang.String | |
| authentication | java.lang.String | |
| connectionPassword | java.lang.String | |
| connectionProtocol | java.lang.String | |
| connectionURL | java.lang.String | |
| connectionUsername | java.lang.String | |
| context | javax.naming.directory.DirContext | |
| initialContextFactory | java.lang.String | |
| options | java.util.Map | |
| queueSearchMatchingFormat | java.text.MessageFormat | |
| queueSearchSubtreeBool | boolean | |
| readAttribute | java.lang.String | |
| readBase | java.lang.String | |
| topicSearchMatchingFormat | java.text.MessageFormat | |
| topicSearchSubtreeBool | boolean | |
| writeAttribute | java.lang.String | |
| writeBase | java.lang.String | |
This implementation of {@link SubscriptionRecoveryPolicy} will only keep the
last message.
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.
Properties
| Property Name | Type | Description |
|---|
| base | java.lang.String | sets the base LDAP dn used for lookup operations |
| bridgeTempDestinations | boolean | |
| brokerName | java.lang.String | |
| brokerService | org.apache.activemq.broker.BrokerService | |
| conduitSubscriptions | boolean | |
| connectionFilter | org.apache.activemq.network.ConnectionFilter | |
| decreaseNetworkConsumerPriority | boolean | |
| destinationFilter | java.lang.String | |
| dispatchAsync | boolean | |
| duplex | boolean | |
| durableDestinations | (java.lang.Object)* | |
| dynamicOnly | boolean | |
| dynamicallyIncludedDestinations | (java.lang.Object)* | |
| excludedDestinations | (java.lang.Object)* | |
| localUri | java.net.URI | |
| name | java.lang.String | |
| networkTTL | int | |
| objectName | javax.management.ObjectName | |
| password | java.lang.String | sets the LDAP password for access credentials |
| prefetchSize | int | |
| searchFilter | java.lang.String | sets the LDAP search filter as defined in RFC 2254 |
| searchScope | java.lang.String | sets the LDAP search scope |
| staticallyIncludedDestinations | (java.lang.Object)* | |
| uri | java.net.URI | sets the LDAP server URI |
| user | java.lang.String | sets the LDAP user for access credentials |
| userName | java.lang.String | |
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 | |
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 | |
| rmiServerPort | int | |
| server | javax.management.MBeanServer | |
| useMBeanServer | boolean | |
Connects a Slave Broker to a Master when using
Master Slave for High
Availability of messages.
Properties
| Property Name | Type | Description |
|---|
| brokerService | org.apache.activemq.broker.BrokerService | |
| localURI | java.net.URI | |
| password | java.lang.String | |
| remoteURI | java.net.URI | |
| remoteUri | java.lang.String | |
| userName | java.lang.String | |
Properties
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. Setting the limit in bytes will set the
usagePortion to 0 since the UsageManager is not going to be portion based
off the parent. When set using XBean, you can use values such as: "20
mb", "1024 kb", or "1 gb" |
| limiter | org.apache.activemq.usage.UsageCapacity | |
| name | java.lang.String | |
| parent | T | |
| 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. |
| pollingTime | int | |
| portion | float | |
| usage | long | |
| usagePortion | float | |
A factory to create instances of {@link SimpleMessageGroupMap} when
implementing the
Message
Groups functionality.
Properties
| Property Name | Type | Description |
|---|
| bucketCount | 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). |
Creates
Mirrored
Queue using a prefix and postfix to define the topic name on which to mirror the queue to.
Properties
| Property Name | Type | Description |
|---|
| brokerService | org.apache.activemq.broker.BrokerService | |
| 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 |
| 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 |
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 | |
| bridgeTempDestinations | boolean | |
| brokerName | java.lang.String | |
| brokerService | org.apache.activemq.broker.BrokerService | |
| conduitSubscriptions | boolean | |
| connectionFilter | org.apache.activemq.network.ConnectionFilter | |
| decreaseNetworkConsumerPriority | boolean | |
| destinationFilter | java.lang.String | |
| dispatchAsync | boolean | |
| duplex | boolean | |
| durableDestinations | (java.lang.Object)* | |
| 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 | |
| objectName | javax.management.ObjectName | |
| 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 | |
A Broker interceptor which allows you to trace all operations to a Multicast
socket.
Properties
| Property Name | Type | Description |
|---|
| address | java.net.SocketAddress | |
| adminConnectionContext | org.apache.activemq.broker.ConnectionContext | |
| broadcast | boolean | |
| destination | java.net.URI | |
| maxTraceDatagramSize | int | |
| next | org.apache.activemq.broker.Broker | |
| timeToLive | int | |
| wireFormat | org.apache.activemq.wireformat.WireFormat | |
| wireFormatFactory | org.apache.activemq.wireformat.WireFormatFactory | |
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 |
|---|
| bridgeTempDestinations | boolean | |
| brokerName | java.lang.String | |
| brokerService | org.apache.activemq.broker.BrokerService | |
| conduitSubscriptions | boolean | |
| connectionFilter | org.apache.activemq.network.ConnectionFilter | |
| decreaseNetworkConsumerPriority | boolean | |
| destinationFilter | java.lang.String | |
| discoveryAgent | org.apache.activemq.transport.discovery.DiscoveryAgent | |
| discoveryURI | java.net.URI | |
| dispatchAsync | boolean | |
| duplex | boolean | |
| durableDestinations | (java.lang.Object)* | |
| dynamicOnly | boolean | |
| dynamicallyIncludedDestinations | (java.lang.Object)* | |
| excludedDestinations | (java.lang.Object)* | |
| localUri | java.net.URI | |
| name | java.lang.String | |
| networkTTL | int | |
| objectName | javax.management.ObjectName | |
| password | java.lang.String | |
| prefetchSize | int | |
| staticallyIncludedDestinations | (java.lang.Object)* | |
| uri | java.net.URI | |
| userName | java.lang.String | |
This SubscriptionRecoveryPolicy disable recovery of messages.
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 |
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 |
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
Create an Outbound Queue Bridge
Properties
Create an Outbound Topic Bridge
Properties
Represents an entry in a {@link PolicyMap} for assigning policies to a
specific destination or a hierarchical wildcard area of destinations.
Properties
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 |
Defines the prefetch message policies for different types of consumers
Properties
| Property Name | Type | Description |
|---|
| all | int | |
| durableTopicPrefetch | int | |
| inputStreamPrefetch | int | |
| maximumPendingMessageLimit | int | Sets how many messages a broker will keep around, above the prefetch
limit, for non-durable topics before starting to discard older messages. |
| optimizeDurableTopicPrefetch | int | |
| queueBrowserPrefetch | int | |
| queuePrefetch | int | |
| topicPrefetch | int | |
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. |
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 | |
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 |
An ActiveMQ Queue
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 |
Configuration options used to control how messages are re-delivered when they
are rolled back.
Properties
| Property Name | Type | Description |
|---|
| backOffMultiplier | short | |
| collisionAvoidancePercent | short | |
| initialRedeliveryDelay | long | |
| maximumRedeliveries | int | |
| useCollisionAvoidance | boolean | |
| useExponentialBackOff | boolean | |
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.
Properties
Provides a simple authentication plugin
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 |
| users | (java.lang.Object)* | Sets individual users for authentication |
An AuthorizationMap which is configured with individual DestinationMaps for
each operation.
Properties
Simple dispatch policy that sends a message to every subscription that
matches the message.
Converts Message from one JMS to another
Properties
| Property Name | Type | Description |
|---|
| connection | javax.jms.Connection | |
A factory to create instances of {@link SimpleMessageGroupMap} when implementing the
Message Groups functionality.
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 | |
| destinationMessageCountStatement | java.lang.String | |
| dropSchemaStatements | (java.lang.String)* | |
| durableSubAcksTableName | java.lang.String | |
| durableSubscriberMessageCountStatement | java.lang.String | |
| findAllDestinationsStatement | java.lang.String | |
| findAllDurableSubMessagesStatement | java.lang.String | |
| findAllDurableSubsStatement | java.lang.String | |
| findAllMessagesStatement | java.lang.String | |
| findDurableSubMessagesStatement | java.lang.String | |
| findDurableSubStatement | java.lang.String | |
| findLastSequenceIdInAcksStatement | java.lang.String | |
| findLastSequenceIdInMsgsStatement | java.lang.String | |
| findMessageSequenceIdStatement | java.lang.String | |
| findMessageStatement | java.lang.String | |
| findNextMessagesStatement | java.lang.String | |
| lastAckedDurableSubscriberMessageStatement | 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 | |
| nextDurableSubscriberMessageStatement | 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 | |
Pending messages
Pending messages for a durable
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. Setting the limit in bytes will set the
usagePortion to 0 since the UsageManager is not going to be portion based
off the parent. When set using XBean, you can use values such as: "20
mb", "1024 kb", or "1 gb" |
| limiter | org.apache.activemq.usage.UsageCapacity | |
| name | java.lang.String | |
| parent | T | |
| 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. |
| pollingTime | int | |
| store | org.apache.activemq.store.PersistenceAdapter | |
| usagePortion | float | |
This JDBCAdapter inserts and extracts BLOB data using the
setBinaryStream()/getBinaryStream() operations.
The databases/JDBC drivers that use this adapter are:
Properties
Dispatch policy that causes every subscription to see messages in the same
order.
Holder for Usage instances for memory, store and temp files Main use case is
manage memory usage.
Properties
Represents an entry in a {@link DefaultAuthorizationMap} for assigning
different operations (read, write, admin) of user roles to a temporary
destination
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)* | |
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. Setting the limit in bytes will set the
usagePortion to 0 since the UsageManager is not going to be portion based
off the parent. When set using XBean, you can use values such as: "20
mb", "1024 kb", or "1 gb" |
| limiter | org.apache.activemq.usage.UsageCapacity | |
| name | java.lang.String | |
| parent | T | |
| 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. |
| pollingTime | int | |
| store | org.apache.activemq.kaha.Store | |
| usagePortion | float | |
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.
Properties
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 | |
An ActiveMQ Topic
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 |
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 | |
| enableStatusMonitor | boolean | |
| 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 |
A Broker interceptor which allows you to trace all operations to a UDP
socket.
Properties
| Property Name | Type | Description |
|---|
| address | java.net.SocketAddress | |
| adminConnectionContext | org.apache.activemq.broker.ConnectionContext | |
| broadcast | boolean | |
| destination | java.net.URI | |
| maxTraceDatagramSize | int | |
| next | org.apache.activemq.broker.Broker | |
| wireFormat | org.apache.activemq.wireformat.WireFormat | |
| wireFormatFactory | org.apache.activemq.wireformat.WireFormatFactory | |
Identify if a limit has been reached
Properties
| Property Name | Type | Description |
|---|
| limit | long | |
Implements
Virtual Topics.
Properties
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 |
Pending messages held
Pending
Pending messages
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.
Properties
| Property Name | Type | Description |
|---|
| alwaysSessionAsync | boolean | If this flag is set then a separate thread is not used for dispatching
messages for each Session in the Connection. However, a separate thread
is always used if there is more than one session, or the session isn't in
auto acknowledge or duplicates ok mode |
| alwaysSyncSend | boolean | Set true if always require messages to be sync sent |
| beanName | java.lang.String | |
| blobTransferPolicy | org.apache.activemq.blob.BlobTransferPolicy | Sets the policy used to describe how out-of-band BLOBs (Binary Large
OBjects) are transferred from producers to brokers to consumers |
| brokerURL | java.lang.String | Sets the connection
URL used to connect to the ActiveMQ broker. |
| clientID | java.lang.String | Sets the JMS clientID to use for the created connection. Note that this
can only be used by one connection at once so generally its a better idea
to set the clientID on a Connection |
| clientIDPrefix | java.lang.String | Sets the prefix used by autogenerated JMS Client ID values which are used
if the JMS client does not explicitly specify on. |
| clientIdGenerator | org.apache.activemq.util.IdGenerator | |
| closeTimeout | int | Sets the timeout before a close is considered complete. Normally a
close() on a connection waits for confirmation from the broker; this
allows that operation to timeout to save the client hanging if there is
no broker |
| copyMessageOnSend | boolean | Should a JMS message be copied to a new JMS Message object as part of the
send() method in JMS. This is enabled by default to be compliant with the
JMS specification. You can disable it if you do not mutate JMS messages
after they are sent for a performance boost |
| disableTimeStampsByDefault | boolean | Sets whether or not timestamps on messages should be disabled or not. If
you disable them it adds a small performance boost. |
| dispatchAsync | boolean | Enables or disables the default setting of whether or not consumers have
their messages dispatched
synchronously or asynchronously by the broker. For non-durable
topics for example we typically dispatch synchronously by default to
minimize context switches which boost performance. However sometimes its
better to go slower to ensure that a single blocked consumer socket does
not block delivery to other consumers. |
| exclusiveConsumer | boolean | Enables or disables whether or not queue consumers should be exclusive or
not for example to preserve ordering when not using Message Groups |
| nestedMapAndListEnabled | boolean | Enables/disables whether or not Message properties and MapMessage entries
support Nested
Structures of Map and List objects |
| objectMessageSerializationDefered | boolean | When an object is set on an ObjectMessage, the JMS spec requires the
object to be serialized by that set method. Enabling this flag causes the
object to not get serialized. The object may subsequently get serialized
if the message needs to be sent over a socket or stored to disk. |
| optimizeAcknowledge | boolean | |
| optimizedMessageDispatch | boolean | If this flag is set then an larger prefetch limit is used - only
applicable for durable topic subscribers. |
| password | java.lang.String | Sets the JMS password used for connections created from this factory |
| prefetchPolicy | org.apache.activemq.ActiveMQPrefetchPolicy | Sets the prefetch
policy for consumers created by this connection. |
| producerWindowSize | int | |
| properties | java.util.Properties | Get the properties from this instance for storing in JNDI |
| redeliveryPolicy | org.apache.activemq.RedeliveryPolicy | Sets the global redelivery policy to be used when a message is delivered
but the session is rolled back |
| statsEnabled | boolean | |
| transformer | org.apache.activemq.MessageTransformer | Sets the transformer used to transform messages before they are sent on
to the JMS bus or when they are received from the bus but before they are
delivered to the JMS client |
| transportListener | org.apache.activemq.transport.TransportListener | Allows a listener to be configured on the ConnectionFactory so that when this factory is used
with frameworks which don't expose the Connection such as Spring JmsTemplate, you can still register
a transport listener. |
| useAsyncSend | boolean | Forces the use of Async Sends which
adds a massive performance boost; but means that the send() method will
return immediately whether the message has been sent or not which could
lead to message loss. |
| useBeanNameAsClientIdPrefix | boolean | |
| useCompression | boolean | Enables the use of compression of the message bodies |
| useRetroactiveConsumer | boolean | Sets whether or not retroactive consumers are enabled. Retroactive
consumers allow non-durable topic subscribers to receive old messages
that were published before the non-durable subscriber started. |
| userName | java.lang.String | Sets the JMS userName used by connections created by this factory |
| warnAboutUnstartedConnectionTimeout | long | Enables the timeout from a connection creation to when a warning is
generated if the connection is not properly started via
{@link Connection#start()} and a message is received by a consumer. It is
a very common gotcha to forget to start
the connection so this option makes the default case to create a
warning if the user forgets. To disable the warning just set the value to <
0 (say -1). |
| watchTopicAdvisories | boolean | |
Element Index
| <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. |
| <amqPersistenceAdapterFactory> | An implementation of {@link PersistenceAdapterFactory} |
| <authenticationUser> | A helper object used to configure simple authentiaction plugin |
| <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. |
| <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. |
| <authorizationPlugin> | An authorization plugin where each operation on a destination is checked
against an authorizationMap |
| <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:
|
| <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. |
| <bytesJDBCAdapter> | This JDBCAdapter inserts and extracts BLOB data using the
setBytes()/getBytes() operations. The databases/JDBC drivers that use this
adapter are: |
| <commandAgent> | An agent which listens to commands on a JMS destination |
| <compositeDemandForwardingBridge> | A demand forwarding bridge which works with multicast style transports where
a single Transport could be communicating with multiple remote brokers |
| <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. |
| <connectionDotFilePlugin> | A DOT file creator plugin which
creates a DOT file showing the current connections |
| <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. |
| <constantPendingMessageLimitStrategy> | This PendingMessageLimitStrategy is configured to a constant value for all subscriptions. |
| <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:
|
| <defaultUsageCapacity> | Identify if a limit has been reached |
| <demandForwardingBridge> | Forwards messages from the local broker to the remote broker based on demand. |
| <destinationDotFilePlugin> | A DOT
file creator plugin which creates a DOT file showing the current topic & queue hierarchies. |
| <destinationEntry> | A default entry in a DestinationMap which holds a single value. |
| <fileCursor> | Pending messages |
| <fileDurableSubscriberCursor> | Pending messages for durable subscribers |
| <fileQueueCursor> | Pending |
| <filteredDestination> | Represents a destination which is filtered using some predicate such as a selector
so that messages are only dispatched to the destination if they match the filter. |
| <fixedCountSubscriptionRecoveryPolicy> | This implementation of {@link SubscriptionRecoveryPolicy} will keep a fixed
count of last messages. |
| <fixedSizedSubscriptionRecoveryPolicy> | This implementation of {@link SubscriptionRecoveryPolicy} will keep a fixed
amount of memory available in RAM for message history which is evicted in
time order. |
| <forwardingBridge> | Forwards all messages from the local broker to the remote broker. |
| <imageBasedJDBCAdaptor> | Provides JDBCAdapter since that uses
IMAGE datatype to hold binary data.
The databases/JDBC drivers that use this adapter are:
|
| <inboundQueueBridge> | Create an Inbound Queue Bridge |
| <inboundTopicBridge> | Create an Inbound Topic Bridge |
| <individualDeadLetterStrategy> | A {@link DeadLetterStrategy} where each destination has its own individual
DLQ using the subject naming hierarchy. |
| <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. |
| <jaasAuthenticationPlugin> | Provides a JAAS based authentication plugin |
| <jaasCertificateAuthenticationPlugin> | Provides a JAAS based SSL certificate authentication plugin |
| <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. |
| <jmsQueueConnector> | A Bridge to other JMS Queue providers |
| <jmsTopicConnector> | A Bridge to other JMS Topic providers |
| <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. |
| <journaledJDBC> | Creates a default persistence model using the Journal and JDBC |
| <kahaPersistenceAdapter> | |
| <lDAPAuthorizationMap> | An {@link AuthorizationMap} which uses LDAP |
| <lastImageSubscriptionRecoveryPolicy> | This implementation of {@link SubscriptionRecoveryPolicy} will only keep the
last message. |
| <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. |
| <loggingBrokerPlugin> | A simple Broker interceptor which allows you to enable/disable logging. |
| <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. |
| <memoryPersistenceAdapter> | |
| <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. |
| <messageGroupHashBucketFactory> | A factory to create instances of {@link SimpleMessageGroupMap} when
implementing the Message
Groups functionality. |
| <mirroredQueue> | Creates Mirrored
Queue using a prefix and postfix to define the topic name on which to mirror the queue to. |
| <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. |
| <multicastTraceBrokerPlugin> | A Broker interceptor which allows you to trace all operations to a Multicast
socket. |
| <networkConnector> | A network connector which uses a discovery agent to detect the remote brokers
available and setup a connection to each available remote broker |
| <noSubscriptionRecoveryPolicy> | This SubscriptionRecoveryPolicy disable recovery of messages. |
| <oldestMessageEvictionStrategy> | An eviction strategy which evicts the oldest message first (which is the
default). |
| <oldestMessageWithLowestPriorityEvictionStrategy> | An eviction strategy which evicts the oldest message with the lowest priority first. |
| <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:
|
| <outboundQueueBridge> | Create an Outbound Queue Bridge |
| <outboundTopicBridge> | Create an Outbound Topic Bridge |
| <policyEntry> | Represents an entry in a {@link PolicyMap} for assigning policies to a
specific destination or a hierarchical wildcard area of destinations. |
| <policyMap> | Represents a destination based configuration of policies so that individual
destinations or wildcard hierarchies of destinations can be configured using
different policies. |
| <prefetchPolicy> | Defines the prefetch message policies for different types of consumers |
| <prefetchRatePendingMessageLimitStrategy> | This PendingMessageLimitStrategy sets the maximum pending message limit value to be
a multiplier of the prefetch limit of the subscription. |
| <proxyConnector> | |
| <queryBasedSubscriptionRecoveryPolicy> | This implementation of {@link SubscriptionRecoveryPolicy} will perform a user
specific query mechanism to load any messages they may have missed. |
| <queue> | An ActiveMQ Queue |
| <redeliveryPolicy> | Configuration options used to control how messages are re-delivered when they
are rolled back. |
| <roundRobinDispatchPolicy> | Simple dispatch policy that sends a message to every subscription that
matches the message. |
| <sharedDeadLetterStrategy> | A default implementation of {@link DeadLetterStrategy} which uses
a constant destination. |
| <simpleAuthenticationPlugin> | Provides a simple authentication plugin |
| <simpleAuthorizationMap> | An AuthorizationMap which is configured with individual DestinationMaps for
each operation. |
| <simpleDispatchPolicy> | Simple dispatch policy that sends a message to every subscription that
matches the message. |
| <simpleJmsMessageConvertor> | Converts Message from one JMS to another |
| <simpleMessageGroupMapFactory> | A factory to create instances of {@link SimpleMessageGroupMap} when implementing the
Message Groups functionality. |
| <statements> | |
| <storeCursor> | Pending messages |
| <storeDurableSubscriberCursor> | Pending messages for a durable |
| <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. |
| <streamJDBCAdapter> | This JDBCAdapter inserts and extracts BLOB data using the
setBinaryStream()/getBinaryStream() operations.
The databases/JDBC drivers that use this adapter are:
|
| <strictOrderDispatchPolicy> | Dispatch policy that causes every subscription to see messages in the same
order. |
| <systemUsage> | Holder for Usage instances for memory, store and temp files Main use case is
manage memory usage. |
| <tempDestinationAuthorizationEntry> | Represents an entry in a {@link DefaultAuthorizationMap} for assigning
different operations (read, write, admin) of user roles to a temporary
destination |
| <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. |
| <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. |
| <timedSubscriptionRecoveryPolicy> | This implementation of {@link SubscriptionRecoveryPolicy} will keep a timed
buffer of messages around in memory and use that to recover new
subscriptions. |
| <topic> | An ActiveMQ Topic |
| <transportConnector> | |
| <udpTraceBrokerPlugin> | A Broker interceptor which allows you to trace all operations to a UDP
socket. |
| <usageCapacity> | Identify if a limit has been reached |
| <virtualDestinationInterceptor> | Implements Virtual Topics. |
| <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. |
| <vmCursor> | Pending messages held |
| <vmDurableCursor> | Pending |
| <vmQueueCursor> | Pending messages |
| <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. |