org.apache.activemq.camel.component

Class ActiveMQComponent

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultComponent

org.apache.camel.impl.UriEndpointComponent

org.apache.camel.impl.HeaderFilterStrategyComponent

org.apache.camel.component.jms.JmsComponent

org.apache.activemq.camel.component.ActiveMQComponent

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.EndpointCompleter, org.apache.camel.spi.HeaderFilterStrategyAware, org.apache.camel.StatefulService, org.apache.camel.SuspendableService, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class ActiveMQComponent
extends org.apache.camel.component.jms.JmsComponent
implements org.apache.camel.spi.EndpointCompleter

The ActiveMQ Component

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
ActiveMQComponent()
ActiveMQComponent(ActiveMQConfiguration configuration)
ActiveMQComponent(org.apache.camel.CamelContext context)

Method Summary

Modifier and Type	Method and Description
static ActiveMQComponent	activeMQComponent() Creates an ActiveMQ Component
static ActiveMQComponent	activeMQComponent(String brokerURL) Creates an ActiveMQ Component connecting to the given broker URL
protected void	addPooledConnectionFactoryService(Service pooledConnectionFactoryService)
protected void	addSingleConnectionFactory(org.springframework.jms.connection.SingleConnectionFactory singleConnectionFactory)
List<String>	completeEndpointPath(org.apache.camel.ComponentConfiguration componentConfiguration, String completionText)
protected String	convertPathToActualDestination(String path, Map<String,Object> parameters)
protected org.apache.camel.component.jms.JmsConfiguration	createConfiguration()
protected void	createDestinationSource()
protected void	doStart()
protected void	doStop()
boolean	isExposeAllQueues()
void	setBrokerURL(String brokerURL) Sets the broker URL to use to connect to ActiveMQ using the ActiveMQ URI format
void	setConfiguration(org.apache.camel.component.jms.JmsConfiguration configuration)
void	setExposeAllQueues(boolean exposeAllQueues) If enabled this will cause all Queues in the ActiveMQ broker to be eagerly populated into the CamelContext so that they can be easily browsed by any Camel tooling.
void	setTrustAllPackages(boolean trustAllPackages)
void	setUsePooledConnection(boolean usePooledConnection) Enables or disables whether a PooledConnectionFactory will be used so that when messages are sent to ActiveMQ from outside of a message consuming thread, pooling will be used rather than the default with the Spring JmsTemplate which will create a new connection, session, producer for each message then close them all down again.
void	setUserName(String userName) Deprecated. - use JmsComponent#setUsername(String)
void	setUseSingleConnection(boolean useSingleConnection) Enables or disables whether a Spring SingleConnectionFactory will be used so that when messages are sent to ActiveMQ from outside of a message consuming thread, pooling will be used rather than the default with the Spring JmsTemplate which will create a new connection, session, producer for each message then close them all down again.

Methods inherited from class org.apache.camel.component.jms.JmsComponent

createEndpoint, createQueueEndpoint, createTemporaryQueueEndpoint, createTemporaryTopicEndpoint, createTopicEndpoint, doShutdown, getAsyncStartStopExecutorService, getConfiguration, getMessageCreatedStrategy, getQueueBrowseStrategy, getWaitForProvisionCorrelationToBeUpdatedCounter, getWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime, isAllowAutoWiredConnectionFactory, isAllowAutoWiredDestinationResolver, jmsComponent, jmsComponent, jmsComponent, jmsComponentAutoAcknowledge, jmsComponentClientAcknowledge, jmsComponentTransacted, jmsComponentTransacted, setAcceptMessagesWhileStopping, setAcknowledgementMode, setAcknowledgementModeName, setAllowNullBody, setAllowReplyManagerQuickStop, setAlwaysCopyMessage, setApplicationContext, setAsyncConsumer, setAsyncStartListener, setAsyncStopListener, setAutoStartup, setCacheLevel, setCacheLevelName, setClientId, setConcurrentConsumers, setConnectionFactory, setCorrelationProperty, setDefaultTaskExecutorType, setDeliveryMode, setDeliveryPersistent, setDestinationResolver, setDurableSubscriptionName, setEagerLoadingOfProperties, setErrorHandler, setErrorHandlerLoggingLevel, setErrorHandlerLogStackTrace, setExceptionListener, setExplicitQosEnabled, setExposeListenerSession, setForceSendOriginalMessage, setIdleConsumerLimit, setIdleTaskExecutionLimit, setIncludeAllJMSXProperties, setIncludeSentJMSMessageID, setJmsKeyFormatStrategy, setJmsKeyFormatStrategy, setJmsOperations, setLazyCreateTransactionManager, setMapJmsMessage, setMaxConcurrentConsumers, setMaxMessagesPerTask, setMessageConverter, setMessageCreatedStrategy, setMessageIdEnabled, setMessageTimestampEnabled, setPassword, setPreserveMessageQos, setPriority, setPubSubNoLocal, setQueueBrowseStrategy, setReceiveTimeout, setRecoveryInterval, setReplyOnTimeoutToMaxConcurrentConsumers, setReplyToCacheLevelName, setReplyToConcurrentConsumers, setReplyToMaxConcurrentConsumers, setReplyToType, setRequestTimeout, setRequestTimeoutCheckerInterval, setSubscriptionDurable, setTaskExecutor, setTestConnectionOnStartup, setTimeToLive, setTransacted, setTransactionManager, setTransactionName, setTransactionTimeout, setTransferException, setTransferExchange, setTransferFault, setUseMessageIDAsCorrelationID, setUsername, setWaitForProvisionCorrelationToBeUpdatedCounter, setWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime

Methods inherited from class org.apache.camel.impl.HeaderFilterStrategyComponent

getHeaderFilterStrategy, setEndpointHeaderFilterStrategy, setHeaderFilterStrategy

Methods inherited from class org.apache.camel.impl.UriEndpointComponent

createComponentConfiguration, createParameterConfigurationMap, getEndpointClass, getParameterConfigurationMap, populateParameterConfigurationMap, setEndpointClass

Methods inherited from class org.apache.camel.impl.DefaultComponent

afterConfiguration, createConfiguration, createEndpoint, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, ifStartsWithReturnRemainder, isResolvePropertyPlaceholders, preProcessUri, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setCamelContext, setProperties, setProperties, setResolvePropertyPlaceholders, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActiveMQComponent

public ActiveMQComponent()

ActiveMQComponent

public ActiveMQComponent(org.apache.camel.CamelContext context)

ActiveMQComponent

public ActiveMQComponent(ActiveMQConfiguration configuration)

Method Detail

activeMQComponent

public static ActiveMQComponent activeMQComponent()

Creates an ActiveMQ Component

Returns:

the created component

activeMQComponent

public static ActiveMQComponent activeMQComponent(String brokerURL)

Creates an ActiveMQ Component connecting to the given broker URL

Parameters:

brokerURL - the URL to connect to

Returns:

the created component

setBrokerURL

public void setBrokerURL(String brokerURL)

Sets the broker URL to use to connect to ActiveMQ using the ActiveMQ URI format

setUserName

public void setUserName(String userName)

Deprecated. - use JmsComponent#setUsername(String)

See Also:

JmsComponent.setUsername(String)

setTrustAllPackages

public void setTrustAllPackages(boolean trustAllPackages)

isExposeAllQueues

public boolean isExposeAllQueues()

setExposeAllQueues

public void setExposeAllQueues(boolean exposeAllQueues)

If enabled this will cause all Queues in the ActiveMQ broker to be eagerly populated into the CamelContext so that they can be easily browsed by any Camel tooling. This option is disabled by default.

setUsePooledConnection

public void setUsePooledConnection(boolean usePooledConnection)

Enables or disables whether a PooledConnectionFactory will be used so that when messages are sent to ActiveMQ from outside of a message consuming thread, pooling will be used rather than the default with the Spring JmsTemplate which will create a new connection, session, producer for each message then close them all down again.

The default value is true. Note that this requires an extra dependency on commons-pool2.

setUseSingleConnection

public void setUseSingleConnection(boolean useSingleConnection)

Enables or disables whether a Spring SingleConnectionFactory will be used so that when messages are sent to ActiveMQ from outside of a message consuming thread, pooling will be used rather than the default with the Spring JmsTemplate which will create a new connection, session, producer for each message then close them all down again.

The default value is false and a pooled connection is used by default.

addPooledConnectionFactoryService

protected void addPooledConnectionFactoryService(Service pooledConnectionFactoryService)

addSingleConnectionFactory

protected void addSingleConnectionFactory(org.springframework.jms.connection.SingleConnectionFactory singleConnectionFactory)

convertPathToActualDestination

protected String convertPathToActualDestination(String path,
                                                Map<String,Object> parameters)

Overrides:

convertPathToActualDestination in class org.apache.camel.component.jms.JmsComponent

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.apache.camel.component.jms.JmsComponent

Throws:

Exception

createDestinationSource

protected void createDestinationSource()

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class org.apache.camel.impl.DefaultComponent

Throws:

Exception

setConfiguration

public void setConfiguration(org.apache.camel.component.jms.JmsConfiguration configuration)

Overrides:

setConfiguration in class org.apache.camel.component.jms.JmsComponent

createConfiguration

protected org.apache.camel.component.jms.JmsConfiguration createConfiguration()

Overrides:

createConfiguration in class org.apache.camel.component.jms.JmsComponent

completeEndpointPath

public List<String> completeEndpointPath(org.apache.camel.ComponentConfiguration componentConfiguration,
                                         String completionText)

Specified by:

completeEndpointPath in interface org.apache.camel.spi.EndpointCompleter