Added: websites/production/activemq/content/schema/core/activemq-core-5.14.4-schema.html ============================================================================== --- websites/production/activemq/content/schema/core/activemq-core-5.14.4-schema.html (added) +++ websites/production/activemq/content/schema/core/activemq-core-5.14.4-schema.html Thu Mar 2 18:42:59 2017 @@ -0,0 +1,3144 @@ +<!-- NOTE: this file is autogenerated by Apache XBean --> +<html> +<head> +<title>Schema for namespace: http://activemq.apache.org/schema/core</title> +<link rel='stylesheet' href='style.css' type='text/css'> +<link rel='stylesheet' href='http://activemq.org/style.css' type='text/css'> +<link rel='stylesheet' href='http://activemq.org/style-xb.css' type='text/css'> +</head> + +<body> + +<h1>Root Element</h1> +<table> + <tr><th>Element</th><th>Description</th><th>Class</th> + <tr><td><a href='#broker'>broker</a></td><td>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.</td><td>org.apache.activemq.xbean.XBeanBrokerService</td></tr> +</table> + +<h1>Element Summary</h1> +<table> + <tr><th>Element</th><th>Description</th><th>Class</th> + <tr><td><a href='#abortSlowAckConsumerStrategy'>abortSlowAckConsumerStrategy</a></td><td>Abort slow consumers when they reach the configured threshold of slowness, + +default is that a consumer that has not Ack'd a message for 30 seconds is slow.</td><td>org.apache.activemq.broker.region.policy.AbortSlowAckConsumerStrategy</td></tr> + <tr><td><a href='#abortSlowConsumerStrategy'>abortSlowConsumerStrategy</a></td><td>Abort slow consumers when they reach the configured threshold of slowness, default is slow for 30 seconds</td><td>org.apache.activemq.broker.region.policy.AbortSlowConsumerStrategy</td></tr> + <tr><td><a href='#authenticationUser'>authenticationUser</a></td><td>A helper object used to configure simple authentication plugin</td><td>org.apache.activemq.security.AuthenticationUser</td></tr> + <tr><td><a href='#authorizationEntry'>authorizationEntry</a></td><td>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.</td><td>org.apache.activemq.security.XBeanAuthorizationEntry</td></tr> + <tr><td><a href='#authorizationMap'>authorizationMap</a></td><td></td><td>org.apache.activemq.security.XBeanAuthorizationMap</td></tr> + <tr><td><a href='#authorizationPlugin'>authorizationPlugin</a></td><td>An authorization plugin where each operation on a destination is checked +against an authorizationMap</td><td>org.apache.activemq.security.AuthorizationPlugin</td></tr> + <tr><td><a href='#axionJDBCAdapter'>axionJDBCAdapter</a></td><td>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.</td><td>org.apache.activemq.store.jdbc.adapter.AxionJDBCAdapter</td></tr> + <tr><td><a href='#blobJDBCAdapter'>blobJDBCAdapter</a></td><td>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: +<ul> +<li></li> +</ul></td><td>org.apache.activemq.store.jdbc.adapter.BlobJDBCAdapter</td></tr> + <tr><td><a href='#broker'>broker</a></td><td>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.</td><td>org.apache.activemq.xbean.XBeanBrokerService</td></tr> + <tr><td><a href='#brokerService'>brokerService</a></td><td>Manages the life-cycle of an ActiveMQ Broker. A BrokerService 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.</td><td>org.apache.activemq.broker.BrokerService</td></tr> + <tr><td><a href='#bytesJDBCAdapter'>bytesJDBCAdapter</a></td><td>This JDBCAdapter inserts and extracts BLOB data using the +setBytes()/getBytes() operations. The databases/JDBC drivers that use this +adapter are:</td><td>org.apache.activemq.store.jdbc.adapter.BytesJDBCAdapter</td></tr> + <tr><td><a href='#cachedLDAPAuthorizationMap'>cachedLDAPAuthorizationMap</a></td><td>A {@link DefaultAuthorizationMap} implementation which uses LDAP to initialize and update authorization +policy.</td><td>org.apache.activemq.security.CachedLDAPAuthorizationMap</td></tr> + <tr><td><a href='#cachedMessageGroupMapFactory'>cachedMessageGroupMapFactory</a></td><td>A factory to create instances of {@link org.apache.activemq.broker.region.group.CachedMessageGroupMap} when implementing the +<a href="http://activemq.apache.org/message-groups.html";>Message Groups</a> functionality.</td><td>org.apache.activemq.broker.region.group.CachedMessageGroupMapFactory</td></tr> + <tr><td><a href='#camelEndpointLoader'>camelEndpointLoader</a></td><td>A helper bean which populates a {@link CamelContext} with ActiveMQ Queue endpoints</td><td>org.apache.activemq.camel.component.CamelEndpointLoader</td></tr> + <tr><td><a href='#camelRoutesBrokerPlugin'>camelRoutesBrokerPlugin</a></td><td>A CamelRoutesBrokerPlugin + +load camel routes dynamically from a routes.xml file located in same directory as ActiveMQ.xml</td><td>org.apache.activemq.camel.camelplugin.CamelRoutesBrokerPlugin</td></tr> + <tr><td><a href='#compositeDemandForwardingBridge'>compositeDemandForwardingBridge</a></td><td>A demand forwarding bridge which works with multicast style transports where +a single Transport could be communicating with multiple remote brokers</td><td>org.apache.activemq.network.CompositeDemandForwardingBridge</td></tr> + <tr><td><a href='#compositeQueue'>compositeQueue</a></td><td>Represents a virtual queue which forwards to a number of other destinations.</td><td>org.apache.activemq.broker.region.virtual.CompositeQueue</td></tr> + <tr><td><a href='#compositeTopic'>compositeTopic</a></td><td>Represents a virtual topic which forwards to a number of other destinations.</td><td>org.apache.activemq.broker.region.virtual.CompositeTopic</td></tr> + <tr><td><a href='#conditionalNetworkBridgeFilterFactory'>conditionalNetworkBridgeFilterFactory</a></td><td>implement conditional behavior for queue consumers, allows replaying back to +origin if no consumers are present on the local broker after a configurable +delay, irrespective of the TTL. Also allows rate limiting of messages +through the network, useful for static includes</td><td>org.apache.activemq.network.ConditionalNetworkBridgeFilterFactory</td></tr> + <tr><td><a href='#connectionDotFilePlugin'>connectionDotFilePlugin</a></td><td>A <a href="http://www.graphviz.org/";>DOT</a> file creator plugin which +creates a DOT file showing the current connections</td><td>org.apache.activemq.broker.view.ConnectionDotFilePlugin</td></tr> + <tr><td><a href='#connectionFactory'>connectionFactory</a></td><td>A <a href="http://www.springframework.org/";>Spring</a> 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 <a href="http://activemq.apache.org/jmx.html";>JMX</a>.</td><td>org.apache.activemq.spring.ActiveMQConnectionFactory</td></tr> + <tr><td><a href='#constantPendingMessageLimitStrategy'>constantPendingMessageLimitStrategy</a></td><td>This PendingMessageLimitStrategy is configured to a constant value for all subscriptions.</td><td>org.apache.activemq.broker.region.policy.ConstantPendingMessageLimitStrategy</td></tr> + <tr><td><a href='#database-locker'>database-locker</a></td><td>Represents an exclusive lock on a database to avoid multiple brokers running +against the same logical database.</td><td>org.apache.activemq.store.jdbc.DefaultDatabaseLocker</td></tr> + <tr><td><a href='#db2JDBCAdapter'>db2JDBCAdapter</a></td><td></td><td>org.apache.activemq.store.jdbc.adapter.DB2JDBCAdapter</td></tr> + <tr><td><a href='#defaultIOExceptionHandler'>defaultIOExceptionHandler</a></td><td></td><td>org.apache.activemq.util.DefaultIOExceptionHandler</td></tr> + <tr><td><a href='#defaultJDBCAdapter'>defaultJDBCAdapter</a></td><td>Implements all the default JDBC operations that are used by the JDBCPersistenceAdapter. <p/> sub-classing is +encouraged to override the default implementation of methods to account for differences in JDBC Driver +implementations. <p/> The JDBCAdapter inserts and extracts BLOB data using the getBytes()/setBytes() operations. <p/> +The databases/JDBC drivers that use this adapter are: +<ul> +<li></li> +</ul></td><td>org.apache.activemq.store.jdbc.adapter.DefaultJDBCAdapter</td></tr> + <tr><td><a href='#defaultNetworkBridgeFilterFactory'>defaultNetworkBridgeFilterFactory</a></td><td>implement default behavior, filter that will not allow re-send to origin +based on brokerPath and which respects networkTTL</td><td>org.apache.activemq.network.DefaultNetworkBridgeFilterFactory</td></tr> + <tr><td><a href='#defaultUsageCapacity'>defaultUsageCapacity</a></td><td>Identify if a limit has been reached</td><td>org.apache.activemq.usage.DefaultUsageCapacity</td></tr> + <tr><td><a href='#demandForwardingBridge'>demandForwardingBridge</a></td><td>Forwards messages from the local broker to the remote broker based on demand.</td><td>org.apache.activemq.network.DemandForwardingBridge</td></tr> + <tr><td><a href='#destinationDotFilePlugin'>destinationDotFilePlugin</a></td><td>A <a href="http://www.graphviz.org/";>DOT</a> +file creator plugin which creates a DOT file showing the current topic & queue hierarchies.</td><td>org.apache.activemq.broker.view.DestinationDotFilePlugin</td></tr> + <tr><td><a href='#destinationEntry'>destinationEntry</a></td><td>A default entry in a DestinationMap which holds a single value.</td><td>org.apache.activemq.filter.DefaultDestinationMapEntry</td></tr> + <tr><td><a href='#destinationPathSeparatorPlugin'>destinationPathSeparatorPlugin</a></td><td></td><td>org.apache.activemq.broker.util.DestinationPathSeparatorBroker</td></tr> + <tr><td><a href='#destinationsPlugin'>destinationsPlugin</a></td><td>A simple plugin that can be used to export/import runtime destinations. It's useful in security constrained +environments where you want to create destinations only through the management APIs and be able to +replicate them to another broker</td><td>org.apache.activemq.broker.util.DestinationsPlugin</td></tr> + <tr><td><a href='#discarding'>discarding</a></td><td>Dead Letter Strategy that discards all messages</td><td>org.apache.activemq.broker.region.policy.DiscardingDeadLetterStrategy</td></tr> + <tr><td><a href='#discardingDLQBrokerPlugin'>discardingDLQBrokerPlugin</a></td><td></td><td>org.apache.activemq.plugin.DiscardingDLQBrokerPlugin</td></tr> + <tr><td><a href='#fileCursor'>fileCursor</a></td><td>Pending messages</td><td>org.apache.activemq.broker.region.policy.FilePendingSubscriberMessageStoragePolicy</td></tr> + <tr><td><a href='#fileDurableSubscriberCursor'>fileDurableSubscriberCursor</a></td><td>Pending messages for durable subscribers</td><td>org.apache.activemq.broker.region.policy.FilePendingDurableSubscriberMessageStoragePolicy</td></tr> + <tr><td><a href='#fileQueueCursor'>fileQueueCursor</a></td><td>Pending</td><td>org.apache.activemq.broker.region.policy.FilePendingQueueMessageStoragePolicy</td></tr> + <tr><td><a href='#filteredDestination'>filteredDestination</a></td><td>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.</td><td>org.apache.activemq.broker.region.virtual.FilteredDestination</td></tr> + <tr><td><a href='#filteredKahaDB'>filteredKahaDB</a></td><td></td><td>org.apache.activemq.store.kahadb.FilteredKahaDBPersistenceAdapter</td></tr> + <tr><td><a href='#fixedCountSubscriptionRecoveryPolicy'>fixedCountSubscriptionRecoveryPolicy</a></td><td>This implementation of {@link SubscriptionRecoveryPolicy} will keep a fixed +count of last messages.</td><td>org.apache.activemq.broker.region.policy.FixedCountSubscriptionRecoveryPolicy</td></tr> + <tr><td><a href='#fixedSizedSubscriptionRecoveryPolicy'>fixedSizedSubscriptionRecoveryPolicy</a></td><td>This implementation of {@link SubscriptionRecoveryPolicy} will keep a fixed +amount of memory available in RAM for message history which is evicted in +time order.</td><td>org.apache.activemq.broker.region.policy.FixedSizedSubscriptionRecoveryPolicy</td></tr> + <tr><td><a href='#forcePersistencyModeBroker'>forcePersistencyModeBroker</a></td><td>A Plugin which allows to force every incoming message to be PERSISTENT or NON-PERSISTENT. + +Useful, if you have set the broker usage policy to process ONLY persistent or ONLY non-persistent +messages.</td><td>org.apache.activemq.plugin.ForcePersistencyModeBroker</td></tr> + <tr><td><a href='#forcePersistencyModeBrokerPlugin'>forcePersistencyModeBrokerPlugin</a></td><td>A Plugin which allows to force every incoming message to be PERSISTENT or +NON-PERSISTENT. + +Useful, if you have set the broker usage policy to process ONLY persistent or +ONLY non-persistent messages.</td><td>org.apache.activemq.plugin.ForcePersistencyModeBrokerPlugin</td></tr> + <tr><td><a href='#forwardingBridge'>forwardingBridge</a></td><td>Forwards all messages from the local broker to the remote broker.</td><td>org.apache.activemq.network.ForwardingBridge</td></tr> + <tr><td><a href='#hsqldb-jdbc-adapter'>hsqldb-jdbc-adapter</a></td><td></td><td>org.apache.activemq.store.jdbc.adapter.HsqldbJDBCAdapter</td></tr> + <tr><td><a href='#imageBasedJDBCAdaptor'>imageBasedJDBCAdaptor</a></td><td>Provides JDBCAdapter since that uses +IMAGE datatype to hold binary data. + +The databases/JDBC drivers that use this adapter are: +<ul> +<li>Sybase</li> +<li>MS SQL</li> +</ul></td><td>org.apache.activemq.store.jdbc.adapter.ImageBasedJDBCAdaptor</td></tr> + <tr><td><a href='#inboundQueueBridge'>inboundQueueBridge</a></td><td>Create an Inbound Queue Bridge. By default this class uses the sname name for +both the inbound and outbound queue. This behavior can be overridden however +by using the setter methods to configure both the inbound and outboud queue names +separately.</td><td>org.apache.activemq.network.jms.InboundQueueBridge</td></tr> + <tr><td><a href='#inboundTopicBridge'>inboundTopicBridge</a></td><td>Create an Inbound Topic Bridge. By default this class uses the topic name for +both the inbound and outbound topic. This behavior can be overridden however +by using the setter methods to configure both the inbound and outboud topic names +separately.</td><td>org.apache.activemq.network.jms.InboundTopicBridge</td></tr> + <tr><td><a href='#individualDeadLetterStrategy'>individualDeadLetterStrategy</a></td><td>A {@link DeadLetterStrategy} where each destination has its own individual +DLQ using the subject naming hierarchy.</td><td>org.apache.activemq.broker.region.policy.IndividualDeadLetterStrategy</td></tr> + <tr><td><a href='#informixJDBCAdapter'>informixJDBCAdapter</a></td><td>JDBC Adapter for Informix database. +Because Informix database restricts length of composite primary keys, length of +<i>container name</i> field and <i>subscription id</i> field must be reduced to 150 characters. +Therefore be sure not to use longer names for container name and subscription id than 150 characters.</td><td>org.apache.activemq.store.jdbc.adapter.InformixJDBCAdapter</td></tr> + <tr><td><a href='#jDBCIOExceptionHandler'>jDBCIOExceptionHandler</a></td><td></td><td>org.apache.activemq.store.jdbc.JDBCIOExceptionHandler</td></tr> + <tr><td><a href='#jaasAuthenticationPlugin'>jaasAuthenticationPlugin</a></td><td>Provides a JAAS based authentication plugin</td><td>org.apache.activemq.security.JaasAuthenticationPlugin</td></tr> + <tr><td><a href='#jaasCertificateAuthenticationPlugin'>jaasCertificateAuthenticationPlugin</a></td><td>Provides a JAAS based SSL certificate authentication plugin</td><td>org.apache.activemq.security.JaasCertificateAuthenticationPlugin</td></tr> + <tr><td><a href='#jaasDualAuthenticationPlugin'>jaasDualAuthenticationPlugin</a></td><td>Provides a JAAS based authentication plugin</td><td>org.apache.activemq.security.JaasDualAuthenticationPlugin</td></tr> + <tr><td><a href='#jdbcPersistenceAdapter'>jdbcPersistenceAdapter</a></td><td>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.</td><td>org.apache.activemq.store.jdbc.JDBCPersistenceAdapter</td></tr> + <tr><td><a href='#jmsQueueConnector'>jmsQueueConnector</a></td><td>A Bridge to other JMS Queue providers</td><td>org.apache.activemq.network.jms.JmsQueueConnector</td></tr> + <tr><td><a href='#jmsTopicConnector'>jmsTopicConnector</a></td><td>A Bridge to other JMS Topic providers</td><td>org.apache.activemq.network.jms.JmsTopicConnector</td></tr> + <tr><td><a href='#jobSchedulerUsage'>jobSchedulerUsage</a></td><td>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.</td><td>org.apache.activemq.usage.JobSchedulerUsage</td></tr> + <tr><td><a href='#journalPersistenceAdapter'>journalPersistenceAdapter</a></td><td>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.</td><td>org.apache.activemq.store.journal.JournalPersistenceAdapter</td></tr> + <tr><td><a href='#journalPersistenceAdapterFactory'>journalPersistenceAdapterFactory</a></td><td>Factory class that can create PersistenceAdapter objects.</td><td>org.apache.activemq.store.journal.JournalPersistenceAdapterFactory</td></tr> + <tr><td><a href='#journaledJDBC'>journaledJDBC</a></td><td>Creates a default persistence model using the Journal and JDBC</td><td>org.apache.activemq.store.PersistenceAdapterFactoryBean</td></tr> + <tr><td><a href='#kahaDB'>kahaDB</a></td><td>An implementation of {@link PersistenceAdapter} designed for use with +KahaDB - Embedded Lightweight Non-Relational Database</td><td>org.apache.activemq.store.kahadb.KahaDBPersistenceAdapter</td></tr> + <tr><td><a href='#lDAPAuthorizationMap'>lDAPAuthorizationMap</a></td><td>An {@link AuthorizationMap} which uses LDAP</td><td>org.apache.activemq.security.LDAPAuthorizationMap</td></tr> + <tr><td><a href='#lastImageSubscriptionRecoveryPolicy'>lastImageSubscriptionRecoveryPolicy</a></td><td>This implementation of {@link SubscriptionRecoveryPolicy} will only keep the +last message.</td><td>org.apache.activemq.broker.region.policy.LastImageSubscriptionRecoveryPolicy</td></tr> + <tr><td><a href='#ldapNetworkConnector'>ldapNetworkConnector</a></td><td>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.</td><td>org.apache.activemq.network.LdapNetworkConnector</td></tr> + <tr><td><a href='#lease-database-locker'>lease-database-locker</a></td><td>Represents an exclusive lease on a database to avoid multiple brokers running +against the same logical database.</td><td>org.apache.activemq.store.jdbc.LeaseDatabaseLocker</td></tr> + <tr><td><a href='#leaseLockerIOExceptionHandler'>leaseLockerIOExceptionHandler</a></td><td></td><td>org.apache.activemq.util.LeaseLockerIOExceptionHandler</td></tr> + <tr><td><a href='#levelDB'>levelDB</a></td><td>An implementation of {@link org.apache.activemq.store.PersistenceAdapter} designed for use with +LevelDB - Embedded Lightweight Non-Relational Database</td><td>org.apache.activemq.store.leveldb.LevelDBPersistenceAdapter</td></tr> + <tr><td><a href='#loggingBrokerPlugin'>loggingBrokerPlugin</a></td><td>A simple Broker intercepter which allows you to enable/disable logging.</td><td>org.apache.activemq.broker.util.LoggingBrokerPlugin</td></tr> + <tr><td><a href='#mKahaDB'>mKahaDB</a></td><td>An implementation of {@link org.apache.activemq.store.PersistenceAdapter} that supports +distribution of destinations across multiple kahaDB persistence adapters</td><td>org.apache.activemq.store.kahadb.MultiKahaDBPersistenceAdapter</td></tr> + <tr><td><a href='#managementContext'>managementContext</a></td><td>An abstraction over JMX mbean registration</td><td>org.apache.activemq.broker.jmx.ManagementContext</td></tr> + <tr><td><a href='#maxdb-jdbc-adapter'>maxdb-jdbc-adapter</a></td><td>JDBC Adapter for the MaxDB database.</td><td>org.apache.activemq.store.jdbc.adapter.MaxDBJDBCAdapter</td></tr> + <tr><td><a href='#memoryPersistenceAdapter'>memoryPersistenceAdapter</a></td><td></td><td>org.apache.activemq.store.memory.MemoryPersistenceAdapter</td></tr> + <tr><td><a href='#memoryUsage'>memoryUsage</a></td><td>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.</td><td>org.apache.activemq.usage.MemoryUsage</td></tr> + <tr><td><a href='#messageGroupHashBucketFactory'>messageGroupHashBucketFactory</a></td><td>A factory to create instances of {@link SimpleMessageGroupMap} when +implementing the <a +href="http://activemq.apache.org/message-groups.html";>Message +Groups</a> functionality.</td><td>org.apache.activemq.broker.region.group.MessageGroupHashBucketFactory</td></tr> + <tr><td><a href='#mirroredQueue'>mirroredQueue</a></td><td>Creates <a href="http://activemq.org/site/mirrored-queues.html";>Mirrored +Queue</a> using a prefix and postfix to define the topic name on which to mirror the queue to.</td><td>org.apache.activemq.broker.region.virtual.MirroredQueue</td></tr> + <tr><td><a href='#multicastNetworkConnector'>multicastNetworkConnector</a></td><td>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.</td><td>org.apache.activemq.network.MulticastNetworkConnector</td></tr> + <tr><td><a href='#multicastTraceBrokerPlugin'>multicastTraceBrokerPlugin</a></td><td>A Broker interceptor which allows you to trace all operations to a Multicast +socket.</td><td>org.apache.activemq.broker.util.MulticastTraceBrokerPlugin</td></tr> + <tr><td><a href='#mysql-jdbc-adapter'>mysql-jdbc-adapter</a></td><td></td><td>org.apache.activemq.store.jdbc.adapter.MySqlJDBCAdapter</td></tr> + <tr><td><a href='#networkConnector'>networkConnector</a></td><td>A network connector which uses a discovery agent to detect the remote brokers +available and setup a connection to each available remote broker</td><td>org.apache.activemq.network.DiscoveryNetworkConnector</td></tr> + <tr><td><a href='#noSubscriptionRecoveryPolicy'>noSubscriptionRecoveryPolicy</a></td><td>This SubscriptionRecoveryPolicy disable recovery of messages.</td><td>org.apache.activemq.broker.region.policy.NoSubscriptionRecoveryPolicy</td></tr> + <tr><td><a href='#oldestMessageEvictionStrategy'>oldestMessageEvictionStrategy</a></td><td>An eviction strategy which evicts the oldest message first (which is the +default).</td><td>org.apache.activemq.broker.region.policy.OldestMessageEvictionStrategy</td></tr> + <tr><td><a href='#oldestMessageWithLowestPriorityEvictionStrategy'>oldestMessageWithLowestPriorityEvictionStrategy</a></td><td>An eviction strategy which evicts the oldest message with the lowest priority first.</td><td>org.apache.activemq.broker.region.policy.OldestMessageWithLowestPriorityEvictionStrategy</td></tr> + <tr><td><a href='#oracleBlobJDBCAdapter'>oracleBlobJDBCAdapter</a></td><td>Implements all the default JDBC operations that are used +by the JDBCPersistenceAdapter. +<p/> +Subclassing is encouraged to override the default +implementation of methods to account for differences +in JDBC Driver implementations. +<p/> +The JDBCAdapter inserts and extracts BLOB data using the +getBytes()/setBytes() operations. +<p/> +The databases/JDBC drivers that use this adapter are: +<ul> +<li></li> +</ul></td><td>org.apache.activemq.store.jdbc.adapter.OracleBlobJDBCAdapter</td></tr> + <tr><td><a href='#oracleJDBCAdapter'>oracleJDBCAdapter</a></td><td>Implements all the default JDBC operations that are used +by the JDBCPersistenceAdapter. +<p/> +Subclassing is encouraged to override the default +implementation of methods to account for differences +in JDBC Driver implementations. +<p/></td><td>org.apache.activemq.store.jdbc.adapter.OracleJDBCAdapter</td></tr> + <tr><td><a href='#outboundQueueBridge'>outboundQueueBridge</a></td><td>Create an Outbound Queue Bridge. By default the bridge uses the same +name for both the inbound and outbound queues, however this can be altered +by using the public setter methods to configure both inbound and outbound +queue names.</td><td>org.apache.activemq.network.jms.OutboundQueueBridge</td></tr> + <tr><td><a href='#outboundTopicBridge'>outboundTopicBridge</a></td><td>Create an Outbound Topic Bridge. By default the bridge uses the same +name for both the inbound and outbound topics, however this can be altered +by using the public setter methods to configure both inbound and outbound +topic names.</td><td>org.apache.activemq.network.jms.OutboundTopicBridge</td></tr> + <tr><td><a href='#pListStoreImpl'>pListStoreImpl</a></td><td></td><td>org.apache.activemq.store.kahadb.plist.PListStoreImpl</td></tr> + <tr><td><a href='#partitionBrokerPlugin'>partitionBrokerPlugin</a></td><td>A BrokerPlugin which partitions client connections over a cluster of brokers.</td><td>org.apache.activemq.partition.PartitionBrokerPlugin</td></tr> + <tr><td><a href='#policyEntry'>policyEntry</a></td><td>Represents an entry in a {@link PolicyMap} for assigning policies to a +specific destination or a hierarchical wildcard area of destinations.</td><td>org.apache.activemq.broker.region.policy.PolicyEntry</td></tr> + <tr><td><a href='#policyMap'>policyMap</a></td><td>Represents a destination based configuration of policies so that individual +destinations or wildcard hierarchies of destinations can be configured using +different policies.</td><td>org.apache.activemq.broker.region.policy.PolicyMap</td></tr> + <tr><td><a href='#pooledConnectionFactory'>pooledConnectionFactory</a></td><td>Simple factory bean used to create a jencks connection pool. +Depending on the properties set, it will create a simple pool, +a transaction aware connection pool, or a jca aware connection pool. + +<pre class="code"> +<bean id="pooledConnectionFactory" class="javax.script.ScriptEngineFactory.PooledConnectionFactoryFactoryBean"> + <property name="connectionFactory" ref="connectionFactory" /> + <property name="transactionManager" ref="transactionManager" /> + <property name="resourceName" value="ResourceName" /> +</bean> +</pre> + +The <code>resourceName</code> property should be used along with the {@link org.apache.activemq.jms.pool.GenericResourceManager} and have +the same value than its <code>resourceName</code> property. This will make sure the transaction manager +maps correctly the connection factory to the recovery process.</td><td>org.apache.activemq.pool.PooledConnectionFactoryBean</td></tr> + <tr><td><a href='#postgresql-jdbc-adapter'>postgresql-jdbc-adapter</a></td><td>Implements all the default JDBC operations that are used +by the JDBCPersistenceAdapter. +<p/> +Subclassing is encouraged to override the default +implementation of methods to account for differences +in JDBC Driver implementations. +<p/> +The JDBCAdapter inserts and extracts BLOB data using the +getBytes()/setBytes() operations. +<p/> +The databases/JDBC drivers that use this adapter are: +<ul> +<li></li> +</ul></td><td>org.apache.activemq.store.jdbc.adapter.PostgresqlJDBCAdapter</td></tr> + <tr><td><a href='#prefetchPolicy'>prefetchPolicy</a></td><td>Defines the prefetch message policies for different types of consumers</td><td>org.apache.activemq.ActiveMQPrefetchPolicy</td></tr> + <tr><td><a href='#prefetchRatePendingMessageLimitStrategy'>prefetchRatePendingMessageLimitStrategy</a></td><td>This PendingMessageLimitStrategy sets the maximum pending message limit value to be +a multiplier of the prefetch limit of the subscription.</td><td>org.apache.activemq.broker.region.policy.PrefetchRatePendingMessageLimitStrategy</td></tr> + <tr><td><a href='#priorityDispatchPolicy'>priorityDispatchPolicy</a></td><td>Priority dispatch policy that sends a message to every subscription that +matches the message in consumer priority order.</td><td>org.apache.activemq.broker.region.policy.PriorityDispatchPolicy</td></tr> + <tr><td><a href='#priorityNetworkDispatchPolicy'>priorityNetworkDispatchPolicy</a></td><td>dispatch policy that ignores lower priority duplicate network consumers, +used in conjunction with network bridge suppresDuplicateTopicSubscriptions</td><td>org.apache.activemq.broker.region.policy.PriorityNetworkDispatchPolicy</td></tr> + <tr><td><a href='#proxyConnector'>proxyConnector</a></td><td></td><td>org.apache.activemq.proxy.ProxyConnector</td></tr> + <tr><td><a href='#publishedAddressPolicy'>publishedAddressPolicy</a></td><td>Policy object that controls how a TransportConnector publishes the connector's +address to the outside world. By default the connector will publish itself +using the resolved host name of the bound server socket.</td><td>org.apache.activemq.broker.PublishedAddressPolicy</td></tr> + <tr><td><a href='#queryBasedSubscriptionRecoveryPolicy'>queryBasedSubscriptionRecoveryPolicy</a></td><td>This implementation of {@link SubscriptionRecoveryPolicy} will perform a user +specific query mechanism to load any messages they may have missed.</td><td>org.apache.activemq.broker.region.policy.QueryBasedSubscriptionRecoveryPolicy</td></tr> + <tr><td><a href='#queue'>queue</a></td><td>An ActiveMQ Queue</td><td>org.apache.activemq.command.ActiveMQQueue</td></tr> + <tr><td><a href='#queueDispatchSelector'>queueDispatchSelector</a></td><td>Queue dispatch policy that determines if a message can be sent to a subscription</td><td>org.apache.activemq.broker.region.QueueDispatchSelector</td></tr> + <tr><td><a href='#reconnectionPolicy'>reconnectionPolicy</a></td><td>A policy object that defines how a {@link JmsConnector} deals with +reconnection of the local and foreign connections.</td><td>org.apache.activemq.network.jms.ReconnectionPolicy</td></tr> + <tr><td><a href='#redeliveryPlugin'>redeliveryPlugin</a></td><td>Replace regular DLQ handling with redelivery via a resend to the original destination +after a delay +A destination matching RedeliveryPolicy controls the quantity and delay for re-sends +If there is no matching policy or an existing policy limit is exceeded by default +regular DLQ processing resumes. This is controlled via sendToDlqIfMaxRetriesExceeded +and fallbackToDeadLetter</td><td>org.apache.activemq.broker.util.RedeliveryPlugin</td></tr> + <tr><td><a href='#redeliveryPolicy'>redeliveryPolicy</a></td><td>Configuration options for a messageConsumer used to control how messages are re-delivered when they +are rolled back. +May be used server side on a per destination basis via the Broker RedeliveryPlugin</td><td>org.apache.activemq.RedeliveryPolicy</td></tr> + <tr><td><a href='#redeliveryPolicyMap'>redeliveryPolicyMap</a></td><td>Represents a destination based configuration of policies so that individual +destinations or wildcard hierarchies of destinations can be configured using +different policies.</td><td>org.apache.activemq.broker.region.policy.RedeliveryPolicyMap</td></tr> + <tr><td><a href='#replicatedLevelDB'>replicatedLevelDB</a></td><td>An implementation of {@link org.apache.activemq.store.PersistenceAdapter} designed for use with +LevelDB - Embedded Lightweight Non-Relational Database</td><td>org.apache.activemq.store.leveldb.ReplicatedLevelDBPersistenceAdapter</td></tr> + <tr><td><a href='#retainedMessageSubscriptionRecoveryPolicy'>retainedMessageSubscriptionRecoveryPolicy</a></td><td>This implementation of {@link org.apache.activemq.broker.region.policy.SubscriptionRecoveryPolicy} will only keep the +last non-zero length message with the {@link org.apache.activemq.command.ActiveMQMessage}.RETAIN_PROPERTY.</td><td>org.apache.activemq.broker.region.policy.RetainedMessageSubscriptionRecoveryPolicy</td></tr> + <tr><td><a href='#roundRobinDispatchPolicy'>roundRobinDispatchPolicy</a></td><td>Simple dispatch policy that sends a message to every subscription that +matches the message.</td><td>org.apache.activemq.broker.region.policy.RoundRobinDispatchPolicy</td></tr> + <tr><td><a href='#runtimeConfigurationPlugin'>runtimeConfigurationPlugin</a></td><td>Broker plugin that will monitor the broker xml configuration for +changes and selectively apply those changes to the running broker.</td><td>org.apache.activemq.plugin.RuntimeConfigurationPlugin</td></tr> + <tr><td><a href='#shared-file-locker'>shared-file-locker</a></td><td>Represents an exclusive lock on a database to avoid multiple brokers running +against the same logical database.</td><td>org.apache.activemq.store.SharedFileLocker</td></tr> + <tr><td><a href='#sharedDeadLetterStrategy'>sharedDeadLetterStrategy</a></td><td>A default implementation of {@link DeadLetterStrategy} which uses +a constant destination.</td><td>org.apache.activemq.broker.region.policy.SharedDeadLetterStrategy</td></tr> + <tr><td><a href='#simpleAuthenticationPlugin'>simpleAuthenticationPlugin</a></td><td>Provides a simple authentication plugin</td><td>org.apache.activemq.security.SimpleAuthenticationPlugin</td></tr> + <tr><td><a href='#simpleAuthorizationMap'>simpleAuthorizationMap</a></td><td>An AuthorizationMap which is configured with individual DestinationMaps for +each operation.</td><td>org.apache.activemq.security.SimpleAuthorizationMap</td></tr> + <tr><td><a href='#simpleDispatchPolicy'>simpleDispatchPolicy</a></td><td>Simple dispatch policy that sends a message to every subscription that +matches the message.</td><td>org.apache.activemq.broker.region.policy.SimpleDispatchPolicy</td></tr> + <tr><td><a href='#simpleDispatchSelector'>simpleDispatchSelector</a></td><td>Simple dispatch policy that determines if a message can be sent to a subscription</td><td>org.apache.activemq.broker.region.policy.SimpleDispatchSelector</td></tr> + <tr><td><a href='#simpleJmsMessageConvertor'>simpleJmsMessageConvertor</a></td><td>Converts Message from one JMS to another</td><td>org.apache.activemq.network.jms.SimpleJmsMessageConvertor</td></tr> + <tr><td><a href='#simpleMessageGroupMapFactory'>simpleMessageGroupMapFactory</a></td><td>A factory to create instances of {@link SimpleMessageGroupMap} when implementing the +<a href="http://activemq.apache.org/message-groups.html";>Message Groups</a> functionality.</td><td>org.apache.activemq.broker.region.group.SimpleMessageGroupMapFactory</td></tr> + <tr><td><a href='#sslContext'>sslContext</a></td><td>Extends the SslContext so that it's easier to configure from spring.</td><td>org.apache.activemq.spring.SpringSslContext</td></tr> + <tr><td><a href='#statements'>statements</a></td><td></td><td>org.apache.activemq.store.jdbc.Statements</td></tr> + <tr><td><a href='#statisticsBrokerPlugin'>statisticsBrokerPlugin</a></td><td>A StatisticsBrokerPlugin +You can retrieve a Map Message for a Destination - or +Broker containing statistics as key-value pairs The message must contain a +replyTo Destination - else its ignored +To retrieve stats on the broker send a empty message to ActiveMQ.Statistics.Broker (Queue or Topic) +With a replyTo set to the destination you want the stats returned to. +To retrieve stats for a destination - e.g. foo - send an empty message to ActiveMQ.Statistics.Destination.foo +- this works with wildcards to - you get a message for each wildcard match on the replyTo destination. +The stats message is a MapMessage populated with statistics for the target</td><td>org.apache.activemq.plugin.StatisticsBrokerPlugin</td></tr> + <tr><td><a href='#storeCursor'>storeCursor</a></td><td>Pending messages</td><td>org.apache.activemq.broker.region.policy.StorePendingQueueMessageStoragePolicy</td></tr> + <tr><td><a href='#storeDurableSubscriberCursor'>storeDurableSubscriberCursor</a></td><td>Pending messages for a durable</td><td>org.apache.activemq.broker.region.policy.StorePendingDurableSubscriberMessageStoragePolicy</td></tr> + <tr><td><a href='#storeUsage'>storeUsage</a></td><td>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.</td><td>org.apache.activemq.usage.StoreUsage</td></tr> + <tr><td><a href='#streamJDBCAdapter'>streamJDBCAdapter</a></td><td>This JDBCAdapter inserts and extracts BLOB data using the +setBinaryStream()/getBinaryStream() operations. + +The databases/JDBC drivers that use this adapter are: +<ul> +<li>Axion</li> +</ul></td><td>org.apache.activemq.store.jdbc.adapter.StreamJDBCAdapter</td></tr> + <tr><td><a href='#strictOrderDispatchPolicy'>strictOrderDispatchPolicy</a></td><td>Dispatch policy that causes every subscription to see messages in the same +order.</td><td>org.apache.activemq.broker.region.policy.StrictOrderDispatchPolicy</td></tr> + <tr><td><a href='#sybase-jdbc-adapter'>sybase-jdbc-adapter</a></td><td>A JDBC Adapter for Sybase databases</td><td>org.apache.activemq.store.jdbc.adapter.SybaseJDBCAdapter</td></tr> + <tr><td><a href='#systemUsage'>systemUsage</a></td><td>Holder for Usage instances for memory, store and temp files Main use case is +manage memory usage.</td><td>org.apache.activemq.usage.SystemUsage</td></tr> + <tr><td><a href='#taskRunnerFactory'>taskRunnerFactory</a></td><td>Manages the thread pool for long running tasks. Long running tasks are not +always active but when they are active, they may need a few iterations of +processing for them to become idle. The manager ensures that each task is +processes but that no one task overtakes the system. This is somewhat like +cooperative multitasking.</td><td>org.apache.activemq.thread.TaskRunnerFactory</td></tr> + <tr><td><a href='#tempDestinationAuthorizationEntry'>tempDestinationAuthorizationEntry</a></td><td>Represents an entry in a {@link DefaultAuthorizationMap} for assigning +different operations (read, write, admin) of user roles to a temporary +destination</td><td>org.apache.activemq.security.TempDestinationAuthorizationEntry</td></tr> + <tr><td><a href='#tempQueue'>tempQueue</a></td><td>An ActiveMQ Temporary Queue Destination</td><td>org.apache.activemq.command.ActiveMQTempQueue</td></tr> + <tr><td><a href='#tempTopic'>tempTopic</a></td><td>An ActiveMQ Temporary Topic Destination</td><td>org.apache.activemq.command.ActiveMQTempTopic</td></tr> + <tr><td><a href='#tempUsage'>tempUsage</a></td><td>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.</td><td>org.apache.activemq.usage.TempUsage</td></tr> + <tr><td><a href='#timeStampingBrokerPlugin'>timeStampingBrokerPlugin</a></td><td>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. + +2 new attributes have been added which will allow the administrator some override control +over the expiration time for incoming messages: + +Attribute 'zeroExpirationOverride' can be used to apply an expiration +time to incoming messages with no expiration defined (messages that would never expire) + +Attribute 'ttlCeiling' can be used to apply a limit to the expiration time</td><td>org.apache.activemq.broker.util.TimeStampingBrokerPlugin</td></tr> + <tr><td><a href='#timedSubscriptionRecoveryPolicy'>timedSubscriptionRecoveryPolicy</a></td><td>This implementation of {@link SubscriptionRecoveryPolicy} will keep a timed +buffer of messages around in memory and use that to recover new +subscriptions.</td><td>org.apache.activemq.broker.region.policy.TimedSubscriptionRecoveryPolicy</td></tr> + <tr><td><a href='#topic'>topic</a></td><td>An ActiveMQ Topic</td><td>org.apache.activemq.command.ActiveMQTopic</td></tr> + <tr><td><a href='#traceBrokerPathPlugin'>traceBrokerPathPlugin</a></td><td>The TraceBrokerPathPlugin can be used in a network of Brokers. Each Broker +that has the plugin configured, will add it's brokerName to the content +of a JMS Property. If all Brokers have this property enabled, the path the +message actually took through the network can be seen in the defined property.</td><td>org.apache.activemq.broker.util.TraceBrokerPathPlugin</td></tr> + <tr><td><a href='#transact-database-locker'>transact-database-locker</a></td><td>Represents an exclusive lock on a database to avoid multiple brokers running +against the same logical database.</td><td>org.apache.activemq.store.jdbc.adapter.TransactDatabaseLocker</td></tr> + <tr><td><a href='#transact-jdbc-adapter'>transact-jdbc-adapter</a></td><td>A JDBC Adapter for Transact-SQL based databases such as SQL Server or Sybase</td><td>org.apache.activemq.store.jdbc.adapter.TransactJDBCAdapter</td></tr> + <tr><td><a href='#transportConnector'>transportConnector</a></td><td></td><td>org.apache.activemq.broker.TransportConnector</td></tr> + <tr><td><a href='#udpTraceBrokerPlugin'>udpTraceBrokerPlugin</a></td><td>A Broker interceptor which allows you to trace all operations to a UDP +socket.</td><td>org.apache.activemq.broker.util.UDPTraceBrokerPlugin</td></tr> + <tr><td><a href='#uniquePropertyMessageEvictionStrategy'>uniquePropertyMessageEvictionStrategy</a></td><td>An eviction strategy which evicts the oldest message within messages with the same property value</td><td>org.apache.activemq.broker.region.policy.UniquePropertyMessageEvictionStrategy</td></tr> + <tr><td><a href='#usageCapacity'>usageCapacity</a></td><td>Identify if a limit has been reached</td><td>org.apache.activemq.usage.UsageCapacity</td></tr> + <tr><td><a href='#virtualDestinationInterceptor'>virtualDestinationInterceptor</a></td><td>Implements <a +href="http://activemq.apache.org/virtual-destinations.html";>Virtual +Topics</a>.</td><td>org.apache.activemq.broker.region.virtual.VirtualDestinationInterceptor</td></tr> + <tr><td><a href='#virtualSelectorCacheBrokerPlugin'>virtualSelectorCacheBrokerPlugin</a></td><td>A plugin which allows the caching of the selector from a subscription queue. +<p/> +This stops the build-up of unwanted messages, especially when consumers may +disconnect from time to time when using virtual destinations. +<p/> +This is influenced by code snippets developed by Maciej Rakowicz</td><td>org.apache.activemq.plugin.SubQueueSelectorCacheBrokerPlugin</td></tr> + <tr><td><a href='#virtualTopic'>virtualTopic</a></td><td>Creates <a href="http://activemq.org/site/virtual-destinations.html";>Virtual +Topics</a> using a prefix and postfix. The virtual destination creates a +wildcard that is then used to look up all active queue subscriptions which +match.</td><td>org.apache.activemq.broker.region.virtual.VirtualTopic</td></tr> + <tr><td><a href='#vmCursor'>vmCursor</a></td><td>Pending messages held</td><td>org.apache.activemq.broker.region.policy.VMPendingSubscriberMessageStoragePolicy</td></tr> + <tr><td><a href='#vmDurableCursor'>vmDurableCursor</a></td><td>Pending</td><td>org.apache.activemq.broker.region.policy.VMPendingDurableSubscriberMessageStoragePolicy</td></tr> + <tr><td><a href='#vmQueueCursor'>vmQueueCursor</a></td><td>Pending messages</td><td>org.apache.activemq.broker.region.policy.VMPendingQueueMessageStoragePolicy</td></tr> + <tr><td><a href='#xaConnectionFactory'>xaConnectionFactory</a></td><td>A <a href="http://www.springframework.org/";>Spring</a> 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 <a href="http://activemq.apache.org/jmx.html";>JMX</a>.</td><td>org.apache.activemq.spring.ActiveMQXAConnectionFactory</td></tr> +</table> + + +<h1>Element Detail</h1> +<h2>Element: <a name='abortSlowAckConsumerStrategy'>abortSlowAckConsumerStrategy</a></h2> +<table> + <tr><th>Attribute</th><th>Type</th><th>Description</th> + <tr><td>abortConnection</td><td>xs:boolean</td><td>abort the consumers connection rather than sending a stop command to the remote consumer</td></tr> + <tr><td>checkPeriod</td><td>xs:long</td><td>time in milliseconds between checks for slow subscriptions</td></tr> + <tr><td>ignoreIdleConsumers</td><td>xs:boolean</td><td>Returns whether the strategy is configured to ignore consumers that are simply idle, i.e +consumers that have no pending acks (dispatch queue is empty).</td></tr> + <tr><td>ignoreNetworkConsumers</td><td>xs:boolean</td><td>Sets whether the strategy is configured to ignore consumers that are part of a network +connection to another broker. + +When configured to not ignore idle consumers this strategy acts not only on consumers +that are actually slow but also on any consumer that has not received any messages for +the maxTimeSinceLastAck. This allows for a way to evict idle consumers while also +aborting slow consumers however for a network subscription this can create a lot of +unnecessary churn and if the abort connection option is also enabled this can result +in the entire network connection being torn down and rebuilt for no reason.</td></tr> + <tr><td>maxSlowCount</td><td>xs:long</td><td>number of times a subscription can be deemed slow before triggering abort +effect depends on dispatch rate as slow determination is done on dispatch</td></tr> + <tr><td>maxSlowDuration</td><td>xs:long</td><td>time in milliseconds that a sub can remain slow before triggering +an abort.</td></tr> + <tr><td>maxTimeSinceLastAck</td><td>xs:long</td><td>Gets the maximum time since last Ack before a subscription is considered to be slow.</td></tr> + <tr><td>name</td><td>xs:string</td><td></td></tr> +</table> +<table> + <tr><th>Element</th><th>Type</th><th>Description</th> + <tr><td>brokerService</td><td><a href='#destinationPathSeparatorPlugin'>destinationPathSeparatorPlugin</a> | <a href='#destinationsPlugin'>destinationsPlugin</a> | <a href='#forcePersistencyModeBroker'>forcePersistencyModeBroker</a> | <a href='#loggingBrokerPlugin'>loggingBrokerPlugin</a> | <a href='#multicastTraceBrokerPlugin'>multicastTraceBrokerPlugin</a> | <a href='#redeliveryPlugin'>redeliveryPlugin</a> | <a href='#timeStampingBrokerPlugin'>timeStampingBrokerPlugin</a> | <a href='#traceBrokerPathPlugin'>traceBrokerPathPlugin</a> | <a href='#udpTraceBrokerPlugin'>udpTraceBrokerPlugin</a></td><td></td></tr> +</table> +<h2>Element: <a name='abortSlowConsumerStrategy'>abortSlowConsumerStrategy</a></h2> +<table> + <tr><th>Attribute</th><th>Type</th><th>Description</th> + <tr><td>abortConnection</td><td>xs:boolean</td><td>abort the consumers connection rather than sending a stop command to the remote consumer</td></tr> + <tr><td>checkPeriod</td><td>xs:long</td><td>time in milliseconds between checks for slow subscriptions</td></tr> + <tr><td>ignoreNetworkConsumers</td><td>xs:boolean</td><td>Sets whether the strategy is configured to ignore consumers that are part of a network +connection to another broker. + +When configured to not ignore idle consumers this strategy acts not only on consumers +that are actually slow but also on any consumer that has not received any messages for +the maxTimeSinceLastAck. This allows for a way to evict idle consumers while also +aborting slow consumers however for a network subscription this can create a lot of +unnecessary churn and if the abort connection option is also enabled this can result +in the entire network connection being torn down and rebuilt for no reason.</td></tr> + <tr><td>maxSlowCount</td><td>xs:long</td><td>number of times a subscription can be deemed slow before triggering abort +effect depends on dispatch rate as slow determination is done on dispatch</td></tr> + <tr><td>maxSlowDuration</td><td>xs:long</td><td>time in milliseconds that a sub can remain slow before triggering +an abort.</td></tr> + <tr><td>name</td><td>xs:string</td><td></td></tr> +</table> +<table> + <tr><th>Element</th><th>Type</th><th>Description</th> + <tr><td>brokerService</td><td><a href='#destinationPathSeparatorPlugin'>destinationPathSeparatorPlugin</a> | <a href='#destinationsPlugin'>destinationsPlugin</a> | <a href='#forcePersistencyModeBroker'>forcePersistencyModeBroker</a> | <a href='#loggingBrokerPlugin'>loggingBrokerPlugin</a> | <a href='#multicastTraceBrokerPlugin'>multicastTraceBrokerPlugin</a> | <a href='#redeliveryPlugin'>redeliveryPlugin</a> | <a href='#timeStampingBrokerPlugin'>timeStampingBrokerPlugin</a> | <a href='#traceBrokerPathPlugin'>traceBrokerPathPlugin</a> | <a href='#udpTraceBrokerPlugin'>udpTraceBrokerPlugin</a></td><td></td></tr> +</table> +<h2>Element: <a name='authenticationUser'>authenticationUser</a></h2> +<table> + <tr><th>Attribute</th><th>Type</th><th>Description</th> + <tr><td>groups</td><td>xs:string</td><td></td></tr> + <tr><td>password</td><td>xs:string</td><td></td></tr> + <tr><td>username</td><td>xs:string</td><td></td></tr> +</table> +<h2>Element: <a name='authorizationEntry'>authorizationEntry</a></h2> +<table> + <tr><th>Attribute</th><th>Type</th><th>Description</th> + <tr><td>admin</td><td>xs:string</td><td></td></tr> + <tr><td>groupClass</td><td>xs:string</td><td></td></tr> + <tr><td>queue</td><td>xs:string</td><td>A helper method to set the destination from a configuration file</td></tr> + <tr><td>read</td><td>xs:string</td><td></td></tr> + <tr><td>tempQueue</td><td>xs:boolean</td><td></td></tr> + <tr><td>tempTopic</td><td>xs:boolean</td><td></td></tr> + <tr><td>topic</td><td>xs:string</td><td>A helper method to set the destination from a configuration file</td></tr> + <tr><td>write</td><td>xs:string</td><td></td></tr> +</table> +<table> + <tr><th>Element</th><th>Type</th><th>Description</th> + <tr><td>adminACLs</td><td>(<spring:bean/>)*</td><td></td></tr> + <tr><td>destination</td><td><a href='#queue'>queue</a> | <a href='#tempQueue'>tempQueue</a> | <a href='#tempTopic'>tempTopic</a> | <a href='#topic'>topic</a></td><td></td></tr> + <tr><td>readACLs</td><td>(<spring:bean/>)*</td><td></td></tr> + <tr><td>writeACLs</td><td>(<spring:bean/>)*</td><td></td></tr> +</table> +<h2>Element: <a name='authorizationMap'>authorizationMap</a></h2> +<table> + <tr><th>Attribute</th><th>Type</th><th>Description</th> + <tr><td>groupClass</td><td>xs:string</td><td></td></tr> +</table> +<table> + <tr><th>Element</th><th>Type</th><th>Description</th> + <tr><td>authorizationEntries</td><td>(<spring:bean/>)*</td><td>Sets the individual entries on the authorization map</td></tr> + <tr><td>defaultEntry</td><td><a href='#authorizationEntry'>authorizationEntry</a> | <a href='#tempDestinationAuthorizationEntry'>tempDestinationAuthorizationEntry</a></td><td></td></tr> + <tr><td>entries</td><td>(<spring:bean/>)*</td><td>A helper method to allow the destination map to be populated from a +dependency injection framework such as Spring</td></tr> + <tr><td>tempDestinationAuthorizationEntry</td><td><a href='#tempDestinationAuthorizationEntry'>tempDestinationAuthorizationEntry</a></td><td></td></tr> +</table> +<h2>Element: <a name='authorizationPlugin'>authorizationPlugin</a></h2> +<table> + <tr><th>Element</th><th>Type</th><th>Description</th> + <tr><td>map</td><td><a href='#authorizationMap'>authorizationMap</a> | <a href='#cachedLDAPAuthorizationMap'>cachedLDAPAuthorizationMap</a> | <a href='#lDAPAuthorizationMap'>lDAPAuthorizationMap</a> | <a href='#simpleAuthorizationMap'>simpleAuthorizationMap</a></td><td></td></tr> +</table> +<h2>Element: <a name='axionJDBCAdapter'>axionJDBCAdapter</a></h2> +<table> + <tr><th>Attribute</th><th>Type</th><th>Description</th> + <tr><td>batchStatements</td><td>xs:boolean</td><td>Set the number of statements to process as a single batch DB update</td></tr> + <tr><td>batchStatments</td><td>xs:boolean</td><td>This value batchStatments is deprecated and will be removed in a future release. Use batchStatements instead (Note the 'e' in Statement)"</td></tr> + <tr><td>maxRows</td><td>xs:integer</td><td>the max value for statement maxRows, used to limit jdbc queries</td></tr> + <tr><td>useExternalMessageReferences</td><td>xs:boolean</td><td></td></tr> +</table> +<table> + <tr><th>Element</th><th>Type</th><th>Description</th> + <tr><td>statements</td><td><a href='#statements'>statements</a></td><td></td></tr> +</table> +<h2>Element: <a name='blobJDBCAdapter'>blobJDBCAdapter</a></h2> +<table> + <tr><th>Attribute</th><th>Type</th><th>Description</th> + <tr><td>batchStatements</td><td>xs:boolean</td><td>Set the number of statements to process as a single batch DB update</td></tr> + <tr><td>batchStatments</td><td>xs:boolean</td><td>This value batchStatments is deprecated and will be removed in a future release. Use batchStatements instead (Note the 'e' in Statement)"</td></tr> + <tr><td>maxRows</td><td>xs:integer</td><td>the max value for statement maxRows, used to limit jdbc queries</td></tr> + <tr><td>useExternalMessageReferences</td><td>xs:boolean</td><td></td></tr> +</table> +<table> + <tr><th>Element</th><th>Type</th><th>Description</th> + <tr><td>statements</td><td><a href='#statements'>statements</a></td><td></td></tr> +</table> +<h2>Element: <a name='broker'>broker</a></h2> +<table> + <tr><th>Attribute</th><th>Type</th><th>Description</th> + <tr><td>adjustUsageLimits</td><td>xs:boolean</td><td></td></tr> + <tr><td>advisorySupport</td><td>xs:string</td><td>Allows the support of advisory messages to be disabled for performance +reasons.</td></tr> + <tr><td>allowTempAutoCreationOnSend</td><td>xs:boolean</td><td>enable if temp destinations need to be propagated through a network when +advisorySupport==false. This is used in conjunction with the policy +gcInactiveDestinations for matching temps so they can get removed +when inactive</td></tr> + <tr><td>brokerId</td><td>xs:string</td><td></td></tr> + <tr><td>brokerName</td><td>xs:string</td><td></td></tr> + <tr><td>brokerObjectName</td><td>xs:string</td><td>Sets the JMX ObjectName for this broker</td></tr> + <tr><td>cacheTempDestinations</td><td>xs:boolean</td><td></td></tr> + <tr><td>consumerSystemUsagePortion</td><td>xs:integer</td><td></td></tr> + <tr><td>dataDirectory</td><td>xs:string</td><td>Sets the directory in which the data files will be stored by default for +the JDBC and Journal persistence adaptors.</td></tr> + <tr><td>dataDirectoryFile</td><td>xs:string</td><td>Sets the directory in which the data files will be stored by default for +the JDBC and Journal persistence adaptors.</td></tr> + <tr><td>dedicatedTaskRunner</td><td>xs:boolean</td><td></td></tr> + <tr><td>deleteAllMessagesOnStartup</td><td>xs:string</td><td>Sets whether or not all messages are deleted on startup - mostly only +useful for testing.</td></tr> + <tr><td>diskUsageCheckRegrowThreshold</td><td>xs:string</td><td></td></tr> + <tr><td>enableStatistics</td><td>xs:boolean</td><td>Sets whether or not the Broker's services enable statistics or not.</td></tr> + <tr><td>keepDurableSubsActive</td><td>xs:boolean</td><td></td></tr> + <tr><td>maxPurgedDestinationsPerSweep</td><td>xs:integer</td><td></td></tr> + <tr><td>mbeanInvocationTimeout</td><td>xs:long</td><td>Gets the time in Milliseconds that an invocation of an MBean method will wait before +failing. The default value is to wait forever (zero).</td></tr> + <tr><td>monitorConnectionSplits</td><td>xs:boolean</td><td></td></tr> + <tr><td>networkConnectorStartAsync</td><td>xs:boolean</td><td></td></tr> + <tr><td>offlineDurableSubscriberTaskSchedule</td><td>xs:long</td><td></td></tr> + <tr><td>offlineDurableSubscriberTimeout</td><td>xs:long</td><td></td></tr> + <tr><td>passiveSlave</td><td>xs:string</td><td>Get the passiveSlave</td></tr> + <tr><td>persistenceThreadPriority</td><td>xs:integer</td><td></td></tr> + <tr><td>persistent</td><td>xs:string</td><td>Sets whether or not persistence is enabled or disabled.</td></tr> + <tr><td>populateJMSXUserID</td><td>xs:boolean</td><td>Sets whether or not the broker should populate the JMSXUserID header.</td></tr> + <tr><td>populateUserNameInMBeans</td><td>xs:boolean</td><td>Should MBeans that support showing the Authenticated User Name information have this +value filled in or not.</td></tr> + <tr><td>producerSystemUsagePortion</td><td>xs:integer</td><td></td></tr> + <tr><td>rejectDurableConsumers</td><td>xs:boolean</td><td></td></tr> + <tr><td>restartAllowed</td><td>xs:boolean</td><td>Sets if the broker allowed to restart on shutdown.</td></tr> + <tr><td>rollbackOnlyOnAsyncException</td><td>xs:boolean</td><td></td></tr> + <tr><td>schedulePeriodForDestinationPurge</td><td>xs:integer</td><td></td></tr> + <tr><td>schedulePeriodForDiskUsageCheck</td><td>xs:integer</td><td></td></tr> + <tr><td>schedulerDirectory</td><td>xs:string</td><td></td></tr> + <tr><td>schedulerDirectoryFile</td><td>xs:string</td><td></td></tr> + <tr><td>schedulerSupport</td><td>xs:string</td><td></td></tr> + <tr><td>shutdownOnMasterFailure</td><td>xs:boolean</td><td></td></tr> + <tr><td>shutdownOnSlaveFailure</td><td>xs:string</td><td></td></tr> + <tr><td>splitSystemUsageForProducersConsumers</td><td>xs:boolean</td><td></td></tr> + <tr><td>start</td><td>xs:boolean</td><td>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.</td></tr> + <tr><td>startAsync</td><td>xs:boolean</td><td></td></tr> + <tr><td>storeOpenWireVersion</td><td>xs:integer</td><td></td></tr> + <tr><td>systemExitOnShutdown</td><td>xs:string</td><td></td></tr> + <tr><td>systemExitOnShutdownExitCode</td><td>xs:integer</td><td></td></tr> + <tr><td>taskRunnerPriority</td><td>xs:integer</td><td></td></tr> + <tr><td>timeBeforePurgeTempDestinations</td><td>xs:integer</td><td></td></tr> + <tr><td>tmpDataDirectory</td><td>xs:string</td><td></td></tr> + <tr><td>useAuthenticatedPrincipalForJMSXUserID</td><td>xs:boolean</td><td></td></tr> + <tr><td>useJmx</td><td>xs:string</td><td>Sets whether or not the Broker's services should be exposed into JMX or +not.</td></tr> + <tr><td>useLocalHostBrokerName</td><td>xs:boolean</td><td></td></tr> + <tr><td>useLoggingForShutdownErrors</td><td>xs:boolean</td><td>Sets whether or not we should use commons-logging when reporting errors +when shutting down the broker</td></tr> + <tr><td>useMirroredQueues</td><td>xs:boolean</td><td>Sets whether or not <a +href="http://activemq.apache.org/mirrored-queues.html";>Mirrored +Queues</a> should be supported by default if they have not been +explicitly configured.</td></tr> + <tr><td>useShutdownHook</td><td>xs:boolean</td><td>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.</td></tr> + <tr><td>useTempMirroredQueues</td><td>xs:boolean</td><td></td></tr> + <tr><td>useVirtualDestSubs</td><td>xs:boolean</td><td></td></tr> + <tr><td>useVirtualDestSubsOnCreation</td><td>xs:boolean</td><td></td></tr> + <tr><td>useVirtualTopics</td><td>xs:boolean</td><td>Sets whether or not <a +href="http://activemq.apache.org/virtual-destinations.html";>Virtual +Topics</a> should be supported by default if they have not been +explicitly configured.</td></tr> + <tr><td>vmConnectorURI</td><td>xs:string</td><td></td></tr> + <tr><td>waitForSlave</td><td>xs:string</td><td></td></tr> + <tr><td>waitForSlaveTimeout</td><td>xs:long</td><td></td></tr> +</table> +<table> + <tr><th>Element</th><th>Type</th><th>Description</th> + <tr><td>adminView</td><td><spring:bean/></td><td>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.</td></tr> + <tr><td>brokerContext</td><td><spring:bean/></td><td></td></tr> + <tr><td>consumerSystemUsage</td><td><a href='#systemUsage'>systemUsage</a></td><td></td></tr> + <tr><td>destinationFactory</td><td><spring:bean/></td><td></td></tr> + <tr><td>destinationInterceptors</td><td>(<a href='#mirroredQueue'>mirroredQueue</a> | <a href='#virtualDestinationInterceptor'>virtualDestinationInterceptor</a>)*</td><td>Sets the destination interceptors to use</td></tr> + <tr><td>destinationPolicy</td><td><a href='#policyMap'>policyMap</a></td><td>Sets the destination specific policies available either for exact +destinations or for wildcard areas of destinations.</td></tr> + <tr><td>destinations</td><td>(<a href='#queue'>queue</a> | <a href='#tempQueue'>tempQueue</a> | <a href='#tempTopic'>tempTopic</a> | <a href='#topic'>topic</a>)*</td><td>Sets the destinations which should be loaded/created on startup</td></tr> + <tr><td>ioExceptionHandler</td><td><a href='#defaultIOExceptionHandler'>defaultIOExceptionHandler</a> | <a href='#jDBCIOExceptionHandler'>jDBCIOExceptionHandler</a> | <a href='#leaseLockerIOExceptionHandler'>leaseLockerIOExceptionHandler</a></td><td>override the Default IOException handler, called when persistence adapter +has experiences File or JDBC I/O Exceptions</td></tr> + <tr><td>jmsBridgeConnectors</td><td>(<a href='#jmsQueueConnector'>jmsQueueConnector</a> | <a href='#jmsTopicConnector'>jmsTopicConnector</a>)*</td><td></td></tr> + <tr><td>jobSchedulerStore</td><td><spring:bean/></td><td></td></tr> + <tr><td>managementContext</td><td><a href='#managementContext'>managementContext</a></td><td></td></tr> + <tr><td>messageAuthorizationPolicy</td><td><spring:bean/></td><td>Sets the policy used to decide if the current connection is authorized to +consume a given message</td></tr> + <tr><td>networkConnectorURIs</td><td>(<spring:bean/>)*</td><td></td></tr> + <tr><td>networkConnectors</td><td>(<a href='#ldapNetworkConnector'>ldapNetworkConnector</a> | <a href='#multicastNetworkConnector'>multicastNetworkConnector</a> | <a href='#networkConnector'>networkConnector</a>)*</td><td>Sets the network connectors which this broker will use to connect to +other brokers in a federated network</td></tr> + <tr><td>persistenceAdapter</td><td><a href='#jdbcPersistenceAdapter'>jdbcPersistenceAdapter</a> | <a href='#journalPersistenceAdapter'>journalPersistenceAdapter</a> | <a href='#kahaDB'>kahaDB</a> | <a href='#levelDB'>levelDB</a> | <a href='#mKahaDB'>mKahaDB</a> | <a href='#memoryPersistenceAdapter'>memoryPersistenceAdapter</a> | <a href='#replicatedLevelDB'>replicatedLevelDB</a></td><td>Sets the persistence adaptor implementation to use for this broker</td></tr> + <tr><td>persistenceFactory</td><td><a href='#journalPersistenceAdapterFactory'>journalPersistenceAdapterFactory</a> | <a href='#journaledJDBC'>journaledJDBC</a></td><td></td></tr> + <tr><td>persistenceTaskRunnerFactory</td><td><a href='#taskRunnerFactory'>taskRunnerFactory</a></td><td></td></tr> + <tr><td>plugins</td><td>(<a href='#authorizationPlugin'>authorizationPlugin</a> | <a href='#camelRoutesBrokerPlugin'>camelRoutesBrokerPlugin</a> | <a href='#connectionDotFilePlugin'>connectionDotFilePlugin</a> | <a href='#destinationDotFilePlugin'>destinationDotFilePlugin</a> | <a href='#destinationPathSeparatorPlugin'>destinationPathSeparatorPlugin</a> | <a href='#destinationsPlugin'>destinationsPlugin</a> | <a href='#discardingDLQBrokerPlugin'>discardingDLQBrokerPlugin</a> | <a href='#forcePersistencyModeBrokerPlugin'>forcePersistencyModeBrokerPlugin</a> | <a href='#jaasAuthenticationPlugin'>jaasAuthenticationPlugin</a> | <a href='#jaasCertificateAuthenticationPlugin'>jaasCertificateAuthenticationPlugin</a> | <a href='#jaasDualAuthenticationPlugin'>jaasDualAuthenticationPlugin</a> | <a href='#loggingBrokerPlugin'>loggingBrokerPlugin</a> | <a href='#multicastTraceBrokerPlugin'>multicastTraceBrokerPlugin</a> | <a href='#partitionBrokerPlugin'>partitionBrokerPlugin</a> | <a href='# redeliveryPlugin'>redeliveryPlugin</a> | <a href='#runtimeConfigurationPlugin'>runtimeConfigurationPlugin</a> | <a href='#simpleAuthenticationPlugin'>simpleAuthenticationPlugin</a> | <a href='#statisticsBrokerPlugin'>statisticsBrokerPlugin</a> | <a href='#timeStampingBrokerPlugin'>timeStampingBrokerPlugin</a> | <a href='#traceBrokerPathPlugin'>traceBrokerPathPlugin</a> | <a href='#udpTraceBrokerPlugin'>udpTraceBrokerPlugin</a> | <a href='#virtualSelectorCacheBrokerPlugin'>virtualSelectorCacheBrokerPlugin</a>)*</td><td>Sets a number of broker plugins to install such as for security +authentication or authorization</td></tr> + <tr><td>producerSystemUsage</td><td><a href='#systemUsage'>systemUsage</a></td><td></td></tr> + <tr><td>proxyConnectors</td><td>(<spring:bean/>)*</td><td>Sets the network connectors which this broker will use to connect to +other brokers in a federated network</td></tr> + <tr><td>regionBroker</td><td><a href='#destinationPathSeparatorPlugin'>destinationPathSeparatorPlugin</a> | <a href='#destinationsPlugin'>destinationsPlugin</a> | <a href='#forcePersistencyModeBroker'>forcePersistencyModeBroker</a> | <a href='#loggingBrokerPlugin'>loggingBrokerPlugin</a> | <a href='#multicastTraceBrokerPlugin'>multicastTraceBrokerPlugin</a> | <a href='#redeliveryPlugin'>redeliveryPlugin</a> | <a href='#timeStampingBrokerPlugin'>timeStampingBrokerPlugin</a> | <a href='#traceBrokerPathPlugin'>traceBrokerPathPlugin</a> | <a href='#udpTraceBrokerPlugin'>udpTraceBrokerPlugin</a></td><td></td></tr> + <tr><td>services</td><td>(<a href='#broker'>broker</a> | <a href='#brokerService'>brokerService</a> | <a href='#database-locker'>database-locker</a> | <a href='#forwardingBridge'>forwardingBridge</a> | <a href='#inboundQueueBridge'>inboundQueueBridge</a> | <a href='#inboundTopicBridge'>inboundTopicBridge</a> | <a href='#jdbcPersistenceAdapter'>jdbcPersistenceAdapter</a> | <a href='#jmsQueueConnector'>jmsQueueConnector</a> | <a href='#jmsTopicConnector'>jmsTopicConnector</a> | <a href='#jobSchedulerUsage'>jobSchedulerUsage</a> | <a href='#journalPersistenceAdapterFactory'>journalPersistenceAdapterFactory</a> | <a href='#journaledJDBC'>journaledJDBC</a> | <a href='#kahaDB'>kahaDB</a> | <a href='#ldapNetworkConnector'>ldapNetworkConnector</a> | <a href='#lease-database-locker'>lease-database-locker</a> | <a href='#levelDB'>levelDB</a> | <a href='#mKahaDB'>mKahaDB</a> | <a href='#managementContext'>managementContext</a> | <a href='#memoryUsage'>memoryUsage</a> | <a href='#multicastNet workConnector'>multicastNetworkConnector</a> | <a href='#networkConnector'>networkConnector</a> | <a href='#outboundQueueBridge'>outboundQueueBridge</a> | <a href='#outboundTopicBridge'>outboundTopicBridge</a> | <a href='#pListStoreImpl'>pListStoreImpl</a> | <a href='#proxyConnector'>proxyConnector</a> | <a href='#replicatedLevelDB'>replicatedLevelDB</a> | <a href='#shared-file-locker'>shared-file-locker</a> | <a href='#storeUsage'>storeUsage</a> | <a href='#systemUsage'>systemUsage</a> | <a href='#tempUsage'>tempUsage</a> | <a href='#transact-database-locker'>transact-database-locker</a>)*</td><td>Sets the services associated with this broker.</td></tr> + <tr><td>shutdownHooks</td><td>(<spring:bean/>)*</td><td>Sets hooks to be executed when broker shut down</td></tr> + <tr><td>sslContext</td><td><a href='#sslContext'>sslContext</a></td><td></td></tr> + <tr><td>startException</td><td><spring:bean/></td><td></td></tr> + <tr><td>systemUsage</td><td><a href='#systemUsage'>systemUsage</a></td><td></td></tr> + <tr><td>taskRunnerFactory</td><td><a href='#taskRunnerFactory'>taskRunnerFactory</a></td><td></td></tr> + <tr><td>tempDataStore</td><td><a href='#levelDB'>levelDB</a> | <a href='#pListStoreImpl'>pListStoreImpl</a> | <a href='#replicatedLevelDB'>replicatedLevelDB</a></td><td></td></tr> + <tr><td>transportConnectorURIs</td><td>(<spring:bean/>)*</td><td></td></tr> + <tr><td>transportConnectors</td><td>(<a href='#transportConnector'>transportConnector</a>)*</td><td>Sets the transport connectors which this broker will listen on for new +clients</td></tr> +</table> +<h2>Element: <a name='brokerService'>brokerService</a></h2> +<table> + <tr><th>Attribute</th><th>Type</th><th>Description</th> + <tr><td>adjustUsageLimits</td><td>xs:boolean</td><td></td></tr> + <tr><td>advisorySupport</td><td>xs:string</td><td>Allows the support of advisory messages to be disabled for performance +reasons.</td></tr> + <tr><td>allowTempAutoCreationOnSend</td><td>xs:boolean</td><td>enable if temp destinations need to be propagated through a network when +advisorySupport==false. This is used in conjunction with the policy +gcInactiveDestinations for matching temps so they can get removed +when inactive</td></tr> + <tr><td>brokerId</td><td>xs:string</td><td></td></tr> + <tr><td>brokerName</td><td>xs:string</td><td></td></tr> + <tr><td>brokerObjectName</td><td>xs:string</td><td>Sets the JMX ObjectName for this broker</td></tr> + <tr><td>cacheTempDestinations</td><td>xs:boolean</td><td></td></tr> + <tr><td>consumerSystemUsagePortion</td><td>xs:integer</td><td></td></tr> + <tr><td>dataDirectory</td><td>xs:string</td><td>Sets the directory in which the data files will be stored by default for +the JDBC and Journal persistence adaptors.</td></tr> + <tr><td>dataDirectoryFile</td><td>xs:string</td><td>Sets the directory in which the data files will be stored by default for +the JDBC and Journal persistence adaptors.</td></tr> + <tr><td>dedicatedTaskRunner</td><td>xs:boolean</td><td></td></tr> + <tr><td>deleteAllMessagesOnStartup</td><td>xs:string</td><td>Sets whether or not all messages are deleted on startup - mostly only +useful for testing.</td></tr> + <tr><td>diskUsageCheckRegrowThreshold</td><td>xs:string</td><td></td></tr> + <tr><td>enableStatistics</td><td>xs:boolean</td><td>Sets whether or not the Broker's services enable statistics or not.</td></tr> + <tr><td>keepDurableSubsActive</td><td>xs:boolean</td><td></td></tr> + <tr><td>maxPurgedDestinationsPerSweep</td><td>xs:integer</td><td></td></tr> + <tr><td>mbeanInvocationTimeout</td><td>xs:long</td><td>Gets the time in Milliseconds that an invocation of an MBean method will wait before +failing. The default value is to wait forever (zero).</td></tr> + <tr><td>monitorConnectionSplits</td><td>xs:boolean</td><td></td></tr> + <tr><td>networkConnectorStartAsync</td><td>xs:boolean</td><td></td></tr> + <tr><td>offlineDurableSubscriberTaskSchedule</td><td>xs:long</td><td></td></tr> + <tr><td>offlineDurableSubscriberTimeout</td><td>xs:long</td><td></td></tr> + <tr><td>passiveSlave</td><td>xs:string</td><td>Get the passiveSlave</td></tr> + <tr><td>persistenceThreadPriority</td><td>xs:integer</td><td></td></tr> + <tr><td>persistent</td><td>xs:string</td><td>Sets whether or not persistence is enabled or disabled.</td></tr> + <tr><td>populateJMSXUserID</td><td>xs:boolean</td><td>Sets whether or not the broker should populate the JMSXUserID header.</td></tr> + <tr><td>populateUserNameInMBeans</td><td>xs:boolean</td><td>Should MBeans that support showing the Authenticated User Name information have this +value filled in or not.</td></tr> + <tr><td>producerSystemUsagePortion</td><td>xs:integer</td><td></td></tr> + <tr><td>rejectDurableConsumers</td><td>xs:boolean</td><td></td></tr> + <tr><td>restartAllowed</td><td>xs:boolean</td><td>Sets if the broker allowed to restart on shutdown.</td></tr> + <tr><td>rollbackOnlyOnAsyncException</td><td>xs:boolean</td><td></td></tr> + <tr><td>schedulePeriodForDestinationPurge</td><td>xs:integer</td><td></td></tr> + <tr><td>schedulePeriodForDiskUsageCheck</td><td>xs:integer</td><td></td></tr> + <tr><td>schedulerDirectory</td><td>xs:string</td><td></td></tr> + <tr><td>schedulerDirectoryFile</td><td>xs:string</td><td></td></tr> + <tr><td>schedulerSupport</td><td>xs:string</td><td></td></tr> + <tr><td>shutdownOnMasterFailure</td><td>xs:boolean</td><td></td></tr> + <tr><td>shutdownOnSlaveFailure</td><td>xs:string</td><td></td></tr> + <tr><td>splitSystemUsageForProducersConsumers</td><td>xs:boolean</td><td></td></tr> + <tr><td>startAsync</td><td>xs:boolean</td><td></td></tr> + <tr><td>storeOpenWireVersion</td><td>xs:integer</td><td></td></tr> + <tr><td>systemExitOnShutdown</td><td>xs:string</td><td></td></tr> + <tr><td>systemExitOnShutdownExitCode</td><td>xs:integer</td><td></td></tr> + <tr><td>taskRunnerPriority</td><td>xs:integer</td><td></td></tr> + <tr><td>timeBeforePurgeTempDestinations</td><td>xs:integer</td><td></td></tr> + <tr><td>tmpDataDirectory</td><td>xs:string</td><td></td></tr> + <tr><td>useAuthenticatedPrincipalForJMSXUserID</td><td>xs:boolean</td><td></td></tr> + <tr><td>useJmx</td><td>xs:string</td><td>Sets whether or not the Broker's services should be exposed into JMX or +not.</td></tr> + <tr><td>useLocalHostBrokerName</td><td>xs:boolean</td><td></td></tr> + <tr><td>useLoggingForShutdownErrors</td><td>xs:boolean</td><td>Sets whether or not we should use commons-logging when reporting errors +when shutting down the broker</td></tr> + <tr><td>useMirroredQueues</td><td>xs:boolean</td><td>Sets whether or not <a +href="http://activemq.apache.org/mirrored-queues.html";>Mirrored +Queues</a> should be supported by default if they have not been +explicitly configured.</td></tr> + <tr><td>useShutdownHook</td><td>xs:boolean</td><td>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.</td></tr> + <tr><td>useTempMirroredQueues</td><td>xs:boolean</td><td></td></tr> + <tr><td>useVirtualDestSubs</td><td>xs:boolean</td><td></td></tr> + <tr><td>useVirtualDestSubsOnCreation</td><td>xs:boolean</td><td></td></tr> + <tr><td>useVirtualTopics</td><td>xs:boolean</td><td>Sets whether or not <a +href="http://activemq.apache.org/virtual-destinations.html";>Virtual +Topics</a> should be supported by default if they have not been +explicitly configured.</td></tr> + <tr><td>vmConnectorURI</td><td>xs:string</td><td></td></tr> + <tr><td>waitForSlave</td><td>xs:string</td><td></td></tr> + <tr><td>waitForSlaveTimeout</td><td>xs:long</td><td></td></tr> +</table> +<table> + <tr><th>Element</th><th>Type</th><th>Description</th> + <tr><td>adminView</td><td><spring:bean/></td><td>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.</td></tr> + <tr><td>brokerContext</td><td><spring:bean/></td><td></td></tr> + <tr><td>consumerSystemUsage</td><td><a href='#systemUsage'>systemUsage</a></td><td></td></tr> + <tr><td>destinationFactory</td><td><spring:bean/></td><td></td></tr> + <tr><td>destinationInterceptors</td><td>(<a href='#mirroredQueue'>mirroredQueue</a> | <a href='#virtualDestinationInterceptor'>virtualDestinationInterceptor</a>)*</td><td>Sets the destination interceptors to use</td></tr> + <tr><td>destinationPolicy</td><td><a href='#policyMap'>policyMap</a></td><td>Sets the destination specific policies available either for exact +destinations or for wildcard areas of destinations.</td></tr> + <tr><td>destinations</td><td>(<a href='#queue'>queue</a> | <a href='#tempQueue'>tempQueue</a> | <a href='#tempTopic'>tempTopic</a> | <a href='#topic'>topic</a>)*</td><td>Sets the destinations which should be loaded/created on startup</td></tr> + <tr><td>ioExceptionHandler</td><td><a href='#defaultIOExceptionHandler'>defaultIOExceptionHandler</a> | <a href='#jDBCIOExceptionHandler'>jDBCIOExceptionHandler</a> | <a href='#leaseLockerIOExceptionHandler'>leaseLockerIOExceptionHandler</a></td><td>override the Default IOException handler, called when persistence adapter +has experiences File or JDBC I/O Exceptions</td></tr> + <tr><td>jmsBridgeConnectors</td><td>(<a href='#jmsQueueConnector'>jmsQueueConnector</a> | <a href='#jmsTopicConnector'>jmsTopicConnector</a>)*</td><td></td></tr> + <tr><td>jobSchedulerStore</td><td><spring:bean/></td><td></td></tr> + <tr><td>managementContext</td><td><a href='#managementContext'>managementContext</a></td><td></td></tr> + <tr><td>messageAuthorizationPolicy</td><td><spring:bean/></td><td>Sets the policy used to decide if the current connection is authorized to +consume a given message</td></tr> + <tr><td>networkConnectorURIs</td><td>(<spring:bean/>)*</td><td></td></tr> + <tr><td>networkConnectors</td><td>(<a href='#ldapNetworkConnector'>ldapNetworkConnector</a> | <a href='#multicastNetworkConnector'>multicastNetworkConnector</a> | <a href='#networkConnector'>networkConnector</a>)*</td><td>Sets the network connectors which this broker will use to connect to +other brokers in a federated network</td></tr> + <tr><td>persistenceAdapter</td><td><a href='#jdbcPersistenceAdapter'>jdbcPersistenceAdapter</a> | <a href='#journalPersistenceAdapter'>journalPersistenceAdapter</a> | <a href='#kahaDB'>kahaDB</a> | <a href='#levelDB'>levelDB</a> | <a href='#mKahaDB'>mKahaDB</a> | <a href='#memoryPersistenceAdapter'>memoryPersistenceAdapter</a> | <a href='#replicatedLevelDB'>replicatedLevelDB</a></td><td>Sets the persistence adaptor implementation to use for this broker</td></tr> + <tr><td>persistenceFactory</td><td><a href='#journalPersistenceAdapterFactory'>journalPersistenceAdapterFactory</a> | <a href='#journaledJDBC'>journaledJDBC</a></td><td></td></tr> + <tr><td>persistenceTaskRunnerFactory</td><td><a href='#taskRunnerFactory'>taskRunnerFactory</a></td><td></td></tr> + <tr><td>plugins</td><td>(<a href='#authorizationPlugin'>authorizationPlugin</a> | <a href='#camelRoutesBrokerPlugin'>camelRoutesBrokerPlugin</a> | <a href='#connectionDotFilePlugin'>connectionDotFilePlugin</a> | <a href='#destinationDotFilePlugin'>destinationDotFilePlugin</a> | <a href='#destinationPathSeparatorPlugin'>destinationPathSeparatorPlugin</a> | <a href='#destinationsPlugin'>destinationsPlugin</a> | <a href='#discardingDLQBrokerPlugin'>discardingDLQBrokerPlugin</a> | <a href='#forcePersistencyModeBrokerPlugin'>forcePersistencyModeBrokerPlugin</a> | <a href='#jaasAuthenticationPlugin'>jaasAuthenticationPlugin</a> | <a href='#jaasCertificateAuthenticationPlugin'>jaasCertificateAuthenticationPlugin</a> | <a href='#jaasDualAuthenticationPlugin'>jaasDualAuthenticationPlugin</a> | <a href='#loggingBrokerPlugin'>loggingBrokerPlugin</a> | <a href='#multicastTraceBrokerPlugin'>multicastTraceBrokerPlugin</a> | <a href='#partitionBrokerPlugin'>partitionBrokerPlugin</a> | <a href='# redeliveryPlugin'>redeliveryPlugin</a> | <a href='#runtimeConfigurationPlugin'>runtimeConfigurationPlugin</a> | <a href='#simpleAuthenticationPlugin'>simpleAuthenticationPlugin</a> | <a href='#statisticsBrokerPlugin'>statisticsBrokerPlugin</a> | <a href='#timeStampingBrokerPlugin'>timeStampingBrokerPlugin</a> | <a href='#traceBrokerPathPlugin'>traceBrokerPathPlugin</a> | <a href='#udpTraceBrokerPlugin'>udpTraceBrokerPlugin</a> | <a href='#virtualSelectorCacheBrokerPlugin'>virtualSelectorCacheBrokerPlugin</a>)*</td><td>Sets a number of broker plugins to install such as for security +authentication or authorization</td></tr> + <tr><td>producerSystemUsage</td><td><a href='#systemUsage'>systemUsage</a></td><td></td></tr> + <tr><td>proxyConnectors</td><td>(<spring:bean/>)*</td><td>Sets the network connectors which this broker will use to connect to +other brokers in a federated network</td></tr> + <tr><td>regionBroker</td><td><a href='#destinationPathSeparatorPlugin'>destinationPathSeparatorPlugin</a> | <a href='#destinationsPlugin'>destinationsPlugin</a> | <a href='#forcePersistencyModeBroker'>forcePersistencyModeBroker</a> | <a href='#loggingBrokerPlugin'>loggingBrokerPlugin</a> | <a href='#multicastTraceBrokerPlugin'>multicastTraceBrokerPlugin</a> | <a href='#redeliveryPlugin'>redeliveryPlugin</a> | <a href='#timeStampingBrokerPlugin'>timeStampingBrokerPlugin</a> | <a href='#traceBrokerPathPlugin'>traceBrokerPathPlugin</a> | <a href='#udpTraceBrokerPlugin'>udpTraceBrokerPlugin</a></td><td></td></tr> + <tr><td>services</td><td>(<a href='#broker'>broker</a> | <a href='#brokerService'>brokerService</a> | <a href='#database-locker'>database-locker</a> | <a href='#forwardingBridge'>forwardingBridge</a> | <a href='#inboundQueueBridge'>inboundQueueBridge</a> | <a href='#inboundTopicBridge'>inboundTopicBridge</a> | <a href='#jdbcPersistenceAdapter'>jdbcPersistenceAdapter</a> | <a href='#jmsQueueConnector'>jmsQueueConnector</a> | <a href='#jmsTopicConnector'>jmsTopicConnector</a> | <a href='#jobSchedulerUsage'>jobSchedulerUsage</a> | <a href='#journalPersistenceAdapterFactory'>journalPersistenceAdapterFactory</a> | <a href='#journaledJDBC'>journaledJDBC</a> | <a href='#kahaDB'>kahaDB</a> | <a href='#ldapNetworkConnector'>ldapNetworkConnector</a> | <a href='#lease-database-locker'>lease-database-locker</a> | <a href='#levelDB'>levelDB</a> | <a href='#mKahaDB'>mKahaDB</a> | <a href='#managementContext'>managementContext</a> | <a href='#memoryUsage'>memoryUsage</a> | <a href='#multicastNet workConnector'>multicastNetworkConnector</a> | <a href='#networkConnector'>networkConnector</a> | <a href='#outboundQueueBridge'>outboundQueueBridge</a> | <a href='#outboundTopicBridge'>outboundTopicBridge</a> | <a href='#pListStoreImpl'>pListStoreImpl</a> | <a href='#proxyConnector'>proxyConnector</a> | <a href='#replicatedLevelDB'>replicatedLevelDB</a> | <a href='#shared-file-locker'>shared-file-locker</a> | <a href='#storeUsage'>storeUsage</a> | <a href='#systemUsage'>systemUsage</a> | <a href='#tempUsage'>tempUsage</a> | <a href='#transact-database-locker'>transact-database-locker</a>)*</td><td>Sets the services associated with this broker.</td></tr> + <tr><td>shutdownHooks</td><td>(<spring:bean/>)*</td><td>Sets hooks to be executed when broker shut down</td></tr> + <tr><td>sslContext</td><td><a href='#sslContext'>sslContext</a></td><td></td></tr> + <tr><td>startException</td><td><spring:bean/></td><td></td></tr> + <tr><td>systemUsage</td><td><a href='#systemUsage'>systemUsage</a></td><td></td></tr> + <tr><td>taskRunnerFactory</td><td><a href='#taskRunnerFactory'>taskRunnerFactory</a></td><td></td></tr> + <tr><td>tempDataStore</td><td><a href='#levelDB'>levelDB</a> | <a href='#pListStoreImpl'>pListStoreImpl</a> | <a href='#replicatedLevelDB'>replicatedLevelDB</a></td><td></td></tr> + <tr><td>transportConnectorURIs</td><td>(<spring:bean/>)*</td><td></td></tr> + <tr><td>transportConnectors</td><td>(<a href='#transportConnector'>transportConnector</a>)*</td><td>Sets the transport connectors which this broker will listen on for new +clients</td></tr> +</table> +<h2>Element: <a name='bytesJDBCAdapter'>bytesJDBCAdapter</a></h2> +<table> + <tr><th>Attribute</th><th>Type</th><th>Description</th> + <tr><td>batchStatements</td><td>xs:boolean</td><td>Set the number of statements to process as a single batch DB update</td></tr> + <tr><td>batchStatments</td><td>xs:boolean</td><td>This value batchStatments is deprecated and will be removed in a future release. Use batchStatements instead (Note the 'e' in Statement)"</td></tr> + <tr><td>maxRows</td><td>xs:integer</td><td>the max value for statement maxRows, used to limit jdbc queries</td></tr> + <tr><td>useExternalMessageReferences</td><td>xs:boolean</td><td></td></tr> +</table> +<table> + <tr><th>Element</th><th>Type</th><th>Description</th> + <tr><td>statements</td><td><a href='#statements'>statements</a></td><td></td></tr> +</table> +<h2>Element: <a name='cachedLDAPAuthorizationMap'>cachedLDAPAuthorizationMap</a></h2> +<table> + <tr><th>Attribute</th><th>Type</th><th>Description</th> + <tr><td>adminPermissionGroupSearchFilter</td><td>xs:string</td><td></td></tr> + <tr><td>authentication</td><td>xs:string</td><td></td></tr> + <tr><td>connectionPassword</td><td>xs:string</td><td></td></tr> + <tr><td>connectionProtocol</td><td>xs:string</td><td></td></tr> + <tr><td>connectionURL</td><td>xs:string</td><td></td></tr> + <tr><td>connectionUsername</td><td>xs:string</td><td></td></tr> + <tr><td>groupClass</td><td>xs:string</td><td></td></tr> + <tr><td>groupNameAttribute</td><td>xs:string</td><td></td></tr> + <tr><td>groupObjectClass</td><td>xs:string</td><td></td></tr> + <tr><td>legacyGroupMapping</td><td>xs:boolean</td><td></td></tr> + <tr><td>permissionGroupMemberAttribute</td><td>xs:string</td><td></td></tr> + <tr><td>queueSearchBase</td><td>xs:string</td><td></td></tr> + <tr><td>readPermissionGroupSearchFilter</td><td>xs:string</td><td></td></tr> + <tr><td>refreshDisabled</td><td>xs:boolean</td><td></td></tr> + <tr><td>refreshInterval</td><td>xs:integer</td><td></td></tr> + <tr><td>tempSearchBase</td><td>xs:string</td><td></td></tr> + <tr><td>topicSearchBase</td><td>xs:string</td><td></td></tr> + <tr><td>userNameAttribute</td><td>xs:string</td><td></td></tr> + <tr><td>userObjectClass</td><td>xs:string</td><td></td></tr> + <tr><td>writePermissionGroupSearchFilter</td><td>xs:string</td><td></td></tr> +</table> +<h2>Element: <a name='cachedMessageGroupMapFactory'>cachedMessageGroupMapFactory</a></h2> +<table> + <tr><th>Attribute</th><th>Type</th><th>Description</th> + <tr><td>cacheSize</td><td>xs:integer</td><td></td></tr> +</table> +<h2>Element: <a name='camelEndpointLoader'>camelEndpointLoader</a></h2> +<table> + <tr><th>Element</th><th>Type</th><th>Description</th> + <tr><td>camelContext</td><td><spring:bean/></td><td></td></tr> + <tr><td>component</td><td><spring:bean/></td><td></td></tr> + <tr><td>source</td><td><spring:bean/></td><td></td></tr> +</table> +<h2>Element: <a name='camelRoutesBrokerPlugin'>camelRoutesBrokerPlugin</a></h2> +<table> + <tr><th>Attribute</th><th>Type</th><th>Description</th> + <tr><td>checkPeriod</td><td>xs:integer</td><td></td></tr> + <tr><td>routesFile</td><td>xs:string</td><td></td></tr> +</table> +<h2>Element: <a name='compositeDemandForwardingBridge'>compositeDemandForwardingBridge</a></h2> +<table> + <tr><th>Attribute</th><th>Type</th><th>Description</th> + <tr><td>createdByDuplex</td><td>xs:boolean</td><td></td></tr> + <tr><td>mbeanObjectName</td><td>xs:string</td><td></td></tr> +</table> +<table> + <tr><th>Element</th><th>Type</th><th>Description</th> + <tr><td>brokerService</td><td><a href='#broker'>broker</a> | <a href='#brokerService'>brokerService</a></td><td></td></tr> + <tr><td>configuration</td><td><a href='#ldapNetworkConnector'>ldapNetworkConnector</a> | <a href='#multicastNetworkConnector'>multicastNetworkConnector</a> | <a href='#networkConnector'>networkConnector</a></td><td></td></tr> + <tr><td>durableDestinations</td><td>(<a href='#queue'>queue</a> | <a href='#tempQueue'>tempQueue</a> | <a href='#tempTopic'>tempTopic</a> | <a href='#topic'>topic</a>)*</td><td></td></tr> + <tr><td>dynamicallyIncludedDestinations</td><td>(<a href='#queue'>queue</a> | <a href='#tempQueue'>tempQueue</a> | <a href='#tempTopic'>tempTopic</a> | <a href='#topic'>topic</a>)*</td><td></td></tr> + <tr><td>excludedDestinations</td><td>(<a href='#queue'>queue</a> | <a href='#tempQueue'>tempQueue</a> | <a href='#tempTopic'>tempTopic</a> | <a href='#topic'>topic</a>)*</td><td></td></tr> + <tr><td>localBroker</td><td><spring:bean/></td><td></td></tr> + <tr><td>networkBridgeListener</td><td><spring:bean/></td><td></td></tr> + <tr><td>remoteBroker</td><td><spring:bean/></td><td></td></tr> + <tr><td>staticallyIncludedDestinations</td><td>(<a href='#queue'>queue</a> | <a href='#tempQueue'>tempQueue</a> | <a href='#tempTopic'>tempTopic</a> | <a href='#topic'>topic</a>)*</td><td></td></tr> +</table> +<h2>Element: <a name='compositeQueue'>compositeQueue</a></h2> +<table> + <tr><th>Attribute</th><th>Type</th><th>Description</th> + <tr><td>concurrentSend</td><td>xs:boolean</td><td>when true, sends are done in parallel with the broker executor</td></tr> + <tr><td>copyMessage</td><td>xs:boolean</td><td>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</td></tr> + <tr><td>forwardOnly</td><td>xs:boolean</td><td>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
[... 2271 lines stripped ...]
