Added: incubator/activemq/site/xbean-xml-reference-41.html URL: http://svn.apache.org/viewvc/incubator/activemq/site/xbean-xml-reference-41.html?rev=429671&view=auto ============================================================================== --- incubator/activemq/site/xbean-xml-reference-41.html (added) +++ incubator/activemq/site/xbean-xml-reference-41.html Tue Aug 8 07:50:56 2006 @@ -0,0 +1,3809 @@ + + + + + + + + +XBean XML Reference 4.1 + + + + + +
+ + + + + + +
+ + + +
+ +
+ + + + + + +
+ + + +
+ + +
+ + +

Elements By Type

+

+

The org.apache.activemq.network.jms.InboundQueueBridge Type Implementations

+ + + + + +
<inboundQueueBridge> Create an Inbound Queue Bridge
+ +

+

The org.apache.activemq.broker.BrokerService Type Implementations

+ + + + + +
<broker> An ActiveMQ Message Broker which consists of a number of transport connectors, network connectors and a persistence adaptor
+ +

+

The org.apache.activemq.broker.BrokerPlugin Type Implementations

+ + + + + + + + + + + + + + + + + + + + + + + + + +
<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
<loggingBrokerPlugin> A simple Broker interceptor which allows you to enable/disable logging.
<simpleAuthenticationPlugin> Provides a simple authentication plugin configured with a map of user-passwords and a map of user-groups
+ +

+

The org.apache.activemq.store.jdbc.JDBCAdapter Type Implementations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
<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:
  • Sybase
  • MS SQL
<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:
  • Axion
+ +

+

The org.apache.activemq.broker.region.virtual.VirtualDestination Type Implementations

+ + + + + + + + + + + + + +
<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.
+ +

+

The org.apache.activemq.broker.region.policy.PolicyMap Type Implementations

+ + + + + +
<policyMap> Represents a destination based configuration of policies so that individual destinations or wildcard hierarchies of destinations can be configured using different policies.
+ +

+

The org.apache.activemq.broker.region.policy.PendingMessageLimitStrategy Type Implementations

+ + + + + + + + + +
<constantPendingMessageLimitStrategy> This PendingMessageLimitStrategy is configured to a constant value for all subscriptions.
<prefetchRatePendingMessageLimitStrategy> This PendingMessageLimitStrategy sets the maximum pending message limit value to be a multiplier of the prefetch limit of the subscription.
+ +

+

The org.apache.activemq.broker.region.policy.SubscriptionRecoveryPolicy Type Implementations

+ + + + + + + + + + + + + + + + + + + + + + + + + +
<fixedCountSubscriptionRecoveryPolicy> This implementation of {@link SubscriptionRecoveryPolicy} will only keep the last message.
<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.
<lastImageSubscriptionRecoveryPolicy> This implementation of {@link SubscriptionRecoveryPolicy} will only keep the last message.
<noSubscriptionRecoveryPolicy> This is the default Topic recovery policy which does not recover any messages.
<queryBasedSubscriptionRecoveryPolicy> This implementation of {@link SubscriptionRecoveryPolicy} will perform a user specific query mechanism to load any messages they may have missed.
<timedSubscriptionRecoveryPolicy> This implementation of {@link SubscriptionRecoveryPolicy} will keep a timed buffer of messages around in memory and use that to recover new subscriptions.
+ +

+

The org.apache.activemq.store.jdbc.Statements Type Implementations

+ + + + + +
<statements>  
+ +

+

The org.apache.activemq.broker.jmx.ManagementContext Type Implementations

+ + + + + +
<managementContext> A Flow provides different dispatch policies within the NMR
+ +

+

The org.apache.activemq.store.PersistenceAdapterFactory Type Implementations

+ + + + + +
<journaledJDBC> Creates a default persistence model using the Journal and JDBC
+ +

+

The org.apache.activemq.security.AuthorizationEntry Type Implementations

+ + + + + +
<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.
+ +

+

The org.apache.activemq.broker.region.policy.DeadLetterStrategy Type Implementations

+ + + + + + + + + +
<individualDeadLetterStrategy> A {@link DeadLetterStrategy} where each destination has its own individual DLQ using the subject naming hierarchy.
<sharedDeadLetterStrategy> A default implementation of {@link DeadLetterStrategy} which uses a constant destination.
+ +

+

The javax.jms.Topic Type Implementations

+ + + + + +
<topic> An ActiveMQ Topic Destination
+ +

+

The org.apache.activemq.store.PersistenceAdapter Type Implementations

+ + + + + + + + + + + + + + + + + + + + + + + + + +
<jdbcPersistenceAdapter> A {@link PersistenceAdapter} implementation using JDBC for persistence storage. This persistence adapter will correctly remember prepared XA transactions, but it will not keep track of local transaction commits so that operations performed against the Message store are done as a single uow.
<journalPersistenceAdapter> An implementation of {@link PersistenceAdapter} designed for use with a {@link Journal} and then check pointing asynchronously on a timeout with some other long term persistent storage.
<kahaPersistenceAdapter>  
<memoryPersistenceAdapter>  
<quickJournalPersistenceAdapter> An implementation of {@link PersistenceAdapter} designed for use with a {@link Journal} and then check pointing asynchronously on a timeout with some other long term persistent storage.
<rapidPersistenceAdapter> An implementation of {@link PersistenceAdapter} designed for use with a {@link Journal} and then check pointing asynchronously on a timeout with some other long term persistent storage.
+ +

+

The org.apache.activemq.broker.region.policy.PolicyEntry Type Implementations

+ + + + + +
<policyEntry> Represents an entry in a {@link PolicyMap} for assigning policies to a specific destination or a hierarchical wildcard area of destinations.
+ +

+

The org.apache.activemq.network.DemandForwardingBridgeSupport Type Implementations

+ + + + + + + + + +
<compositeDemandForwardingBridge> A demand forwarding bridge which works with multicast style transports where a single Transport could be communicating with multiple remote brokers
<demandForwardingBridge> Forwards messages from the local broker to the remote broker based on demand.
+ +

+

The org.apache.activemq.network.jms.OutboundQueueBridge Type Implementations

+ + + + + +
<outboundQueueBridge> Create an Outbound Queue Bridge
+ +

+

The org.apache.activemq.memory.UsageManager Type Implementations

+ + + + + +
<usageManager> Used to keep track of how much of something is being used so that a productive working set usage can be controlled. Main use case is manage memory usage.
+ +

+

The org.apache.activemq.store.jdbc.JDBCPersistenceAdapter Type Implementations

+ + + + + +
<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.
+ +

+

The org.apache.activemq.command.ActiveMQDestination Type Implementations

+ + + + + + + + + +
<queue> An ActiveMQ Queue Destination
<topic> An ActiveMQ Topic Destination
+ +

+

The org.apache.activemq.network.jms.InboundTopicBridge Type Implementations

+ + + + + +
<inboundTopicBridge> Create an Inbound Topic Bridge
+ +

+

The org.apache.activemq.network.jms.JmsConnector Type Implementations

+ + + + + + + + + +
<jmsQueueConnector> A Bridge to other JMS Queue providers
<jmsTopicConnector> A Bridge to other JMS Topic providers
+ +

+

The org.apache.activemq.security.AuthorizationMap Type Implementations

+ + + + + + + + + +
<authorizationMap> Represents a destination based configuration of policies so that individual destinations or wildcard hierarchies of destinations can be configured using different policies. Each entry in the map represents the authorization ACLs for each operation.
<simpleAuthorizationMap> An AuthorizationMap which is configured with individual DestinationMaps for each operation.
+ +

+

The org.apache.activemq.broker.region.policy.DispatchPolicy Type Implementations

+ + + + + + + + + + + + + +
<roundRobinDispatchPolicy> Simple dispatch policy that sends a message to every subscription that matches the message.
<simpleDispatchPolicy> Simple dispatch policy that sends a message to every subscription that matches the message.
<strictOrderDispatchPolicy> Dispatch policy that causes every subscription to see messages in the same order.
+ +

+

The javax.jms.Queue Type Implementations

+ + + + + +
<queue> An ActiveMQ Queue Destination
+ +

+

The org.apache.activemq.broker.region.policy.MessageEvictionStrategy Type Implementations

+ + + + + + + + + +
<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.
+ +

+

The org.apache.activemq.network.jms.JmsMesageConvertor Type Implementations

+ + + + + +
<simpleJmsMessageConvertor> Converts Message from one JMS to another
+ +

+

The org.apache.activemq.broker.region.DestinationInterceptor Type Implementations

+ + + + + +
<virtualDestinationInterceptor> Implements Virtual Topics.
+ +

+

The org.apache.activemq.network.jms.OutboundTopicBridge Type Implementations

+ + + + + +
<outboundTopicBridge> Create an Outbound Topic Bridge
+ +

+

The org.apache.activemq.filter.DestinationMap Type Implementations

+ + + + + + + + + +
<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.
+ + +

+

The <authorizationEntry> Element

+ Represents an entry in a {@link DefaultAuthorizationMap} for assigning different operations (read, write, admin) of user roles to a specific destination or a hierarchical wildcard area of destinations. +

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Property Name Type Description
admin java.lang.String  
adminACLs java.util.Set  
destination org.apache.activemq.command.ActiveMQDestination  
queue java.lang.String A helper method to set the destination from a configuration file
read java.lang.String  
readACLs java.util.Set  
topic java.lang.String A helper method to set the destination from a configuration file
write java.lang.String  
writeACLs java.util.Set  
+ +

+

The <authorizationMap> Element

+ Represents a destination based configuration of policies so that individual destinations or wildcard hierarchies of destinations can be configured using different policies. Each entry in the map represents the authorization ACLs for each operation. +

Properties

+ + + + + + + + + + + + + + + + + + + + + +
Property Name Type Description
authorizationEntries (java.lang.Object)* Sets the individual entries on the authorization map
defaultEntry org.apache.activemq.security.AuthorizationEntry  
entries (java.lang.Object)* A helper method to allow the destination map to be populated from a dependency injection framework such as Spring
+ +

+

The <authorizationPlugin> Element

+ An authorization plugin where each operation on a destination is checked against an authorizationMap +

Properties

+ + + + + + + + + + + +
Property Name Type Description
map org.apache.activemq.security.AuthorizationMap  
+ +

+

The <axionJDBCAdapter> Element

+ Axion specific Adapter. Axion does not seem to support ALTER statements or sub-selects. This means: - We cannot auto upgrade the schema was we roll out new versions of ActiveMQ - We cannot delete durable sub messages that have be acknowledged by all consumers. +

Properties

+ + + + + + + + + + + + + + + + + + + + + +
Property Name Type Description
batchStatments boolean  
statements org.apache.activemq.store.jdbc.Statements  
useExternalMessageReferences boolean  
+ +

+

The <blobJDBCAdapter> Element

+ This JDBCAdapter inserts and extracts BLOB data using the getBlob()/setBlob() operations. This is a little more involved since to insert a blob you have to: 1: insert empty blob. 2: select the blob 3: finally update the blob with data value. The databases/JDBC drivers that use this adapter are:
+

Properties

+ + + + + + + + + + + + + + + + + + + + + +
Property Name Type Description
batchStatments boolean  
statements org.apache.activemq.store.jdbc.Statements  
useExternalMessageReferences boolean  
+ +

+

The <broker> Element

+ An ActiveMQ Message Broker which consists of a number of transport connectors, network connectors and a persistence adaptor +

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Property Name Type Description
adminView org.apache.activemq.broker.jmx.BrokerView Returns the administration view of the broker; used to create and destroy resources such as queues and topics. Note this method returns null if JMX is disabled.
advisorySupport boolean Allows the support of advisory messages to be disabled for performance reasons.
brokerName java.lang.String Sets the name of this broker; which must be unique in the network
brokerObjectName javax.management.ObjectName Sets the JMX ObjectName for this broker
dataDirectory java.io.File Sets the directory in which the data files will be stored by default for the JDBC and Journal persistence adaptors.
deleteAllMessagesOnStartup boolean Sets whether or not all messages are deleted on startup - mostly only useful for testing.
destinationInterceptors (org.apache.activemq.broker.region.DestinationInterceptor)* Sets the destination interceptors to use
destinationPolicy org.apache.activemq.broker.region.policy.PolicyMap Sets the destination specific policies available either for exact destinations or for wildcard areas of destinations.
destinations (org.apache.activemq.command.ActiveMQDestination)* Sets the destinations which should be loaded/created on startup
jmsBridgeConnectors (org.apache.activemq.network.jms.JmsConnector)*  
keepDurableSubsActive boolean  
managementContext org.apache.activemq.broker.jmx.ManagementContext  
masterConnectorURI java.lang.String  
memoryManager org.apache.activemq.memory.UsageManager  
messageAuthorizationPolicy org.apache.activemq.security.MessageAuthorizationPolicy Sets the policy used to decide if the current connection is authorized to consume a given message
networkConnectorURIs (java.lang.String)*  
networkConnectors (java.lang.Object)* Sets the network connectors which this broker will use to connect to other brokers in a federated network
persistenceAdapter org.apache.activemq.store.PersistenceAdapter Sets the persistence adaptor implementation to use for this broker
persistenceFactory org.apache.activemq.store.PersistenceAdapterFactory  
persistent boolean Sets whether or not persistence is enabled or disabled.
plugins (org.apache.activemq.broker.BrokerPlugin)* Sets a number of broker plugins to install such as for security authentication or authorization
populateJMSXUserID boolean Sets whether or not the broker should populate the JMSXUserID header.
proxyConnectors (java.lang.Object)* Sets the network connectors which this broker will use to connect to other brokers in a federated network
shutdownOnMasterFailure boolean  
start boolean Sets whether or not the broker is started along with the ApplicationContext it is defined within. Normally you would want the broker to start up along with the ApplicationContext but sometimes when working with JUnit tests you may wish to start and stop the broker explicitly yourself.
taskRunnerFactory org.apache.activemq.thread.TaskRunnerFactory  
transportConnectorURIs (java.lang.String)*  
transportConnectors (java.lang.Object)* Sets the transport connectors which this broker will listen on for new clients
useJmx boolean Sets whether or not the Broker's services should be exposed into JMX or not.
useLoggingForShutdownErrors boolean Sets whether or not we should use commons-logging when reporting errors when shutting down the broker
useShutdownHook boolean Sets whether or not we should use a shutdown handler to close down the broker cleanly if the JVM is terminated. It is recommended you leave this enabled.
useVirtualTopics boolean Sets whether or not Virtual Topics should be supported by default if they have not been explicitly configured.
vmConnectorURI java.net.URI  
+ +

+

The <bytesJDBCAdapter> Element

+ This JDBCAdapter inserts and extracts BLOB data using the setBytes()/getBytes() operations. The databases/JDBC drivers that use this adapter are: +

Properties

+ + + + + + + + + + + + + + + + + + + + + +
Property Name Type Description
batchStatments boolean  
statements org.apache.activemq.store.jdbc.Statements  
useExternalMessageReferences boolean  
+ +

+

The <compositeDemandForwardingBridge> Element

+ A demand forwarding bridge which works with multicast style transports where a single Transport could be communicating with multiple remote brokers +

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Property Name Type Description
decreaseNetworkConsumerPriority boolean  
dispatchAsync boolean  
durableDestinations (org.apache.activemq.command.ActiveMQDestination)*  
dynamicallyIncludedDestinations (org.apache.activemq.command.ActiveMQDestination)*  
excludedDestinations (org.apache.activemq.command.ActiveMQDestination)*  
localBroker org.apache.activemq.transport.Transport  
localBrokerName java.lang.String  
name java.lang.String  
networkTTL int  
password java.lang.String  
prefetchSize int  
remoteBroker org.apache.activemq.transport.Transport  
staticallyIncludedDestinations (org.apache.activemq.command.ActiveMQDestination)*  
userName java.lang.String  
+ +

+

The <compositeQueue> Element

+ Represents a virtual queue which forwards to a number of other destinations. +

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Property Name Type Description
copyMessage boolean Sets whether a copy of the message will be sent to each destination. Defaults to true so that the forward destination is set as the destination of the message
forwardOnly boolean Sets if the virtual destination is forward only (and so there is no physical queue to match the virtual queue) or if there is also a physical queue with the same name).
forwardTo java.util.Collection Sets the list of destinations to forward to
name java.lang.String Sets the name of this composite destination
+ +

+

The <compositeTopic> Element

+ Represents a virtual topic which forwards to a number of other destinations. +

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Property Name Type Description
copyMessage boolean Sets whether a copy of the message will be sent to each destination. Defaults to true so that the forward destination is set as the destination of the message
forwardOnly boolean Sets if the virtual destination is forward only (and so there is no physical queue to match the virtual queue) or if there is also a physical queue with the same name).
forwardTo java.util.Collection Sets the list of destinations to forward to
name java.lang.String Sets the name of this composite destination
+ +

+

The <connectionDotFilePlugin> Element

+ A DOT file creator plugin which creates a DOT file showing the current connections +

Properties

+ + + + + + + + + [... 2602 lines stripped ...]
Property Name Type Description
file java.lang.String