Package org.apache.camel.component.jms

Class JmsComponent

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HeaderFilterStrategyAware, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
    @Component("jms")
@Metadata(excludeProperties="bridgeErrorHandler")
public class JmsComponent
extends org.apache.camel.support.HeaderFilterStrategyComponent
    JMS component which uses Spring JMS.

    • Constructor Detail

      • JmsComponent

        public JmsComponent()

      • JmsComponent

        public JmsComponent​(org.apache.camel.CamelContext context)

    • Method Detail

      • jmsComponent

        public static JmsComponent jmsComponent()
        Static builder method

      • jmsComponent

        public static JmsComponent jmsComponent​(javax.jms.ConnectionFactory connectionFactory)
        Static builder method

      • jmsComponentClientAcknowledge

        public static JmsComponent jmsComponentClientAcknowledge​(javax.jms.ConnectionFactory connectionFactory)
        Static builder method

      • jmsComponentAutoAcknowledge

        public static JmsComponent jmsComponentAutoAcknowledge​(javax.jms.ConnectionFactory connectionFactory)
        Static builder method

      • jmsComponentTransacted

        public static JmsComponent jmsComponentTransacted​(javax.jms.ConnectionFactory connectionFactory)

      • jmsComponentTransacted

        public static JmsComponent jmsComponentTransacted​(javax.jms.ConnectionFactory connectionFactory,
                                                  org.springframework.transaction.PlatformTransactionManager transactionManager)

      • setConfiguration

        public void setConfiguration​(JmsConfiguration configuration)
        To use a shared JMS configuration

      • isAllowAutoWiredConnectionFactory

        public boolean isAllowAutoWiredConnectionFactory()
        Whether to auto-discover ConnectionFactory from the registry, if no connection factory has been configured. If only one instance of ConnectionFactory is found then it will be used. This is enabled by default.

      • setAllowAutoWiredConnectionFactory

        public void setAllowAutoWiredConnectionFactory​(boolean allowAutoWiredConnectionFactory)

      • isAllowAutoWiredDestinationResolver

        public boolean isAllowAutoWiredDestinationResolver()
        Whether to auto-discover DestinationResolver from the registry, if no destination resolver has been configured. If only one instance of DestinationResolver is found then it will be used. This is enabled by default.

      • setAllowAutoWiredDestinationResolver

        public void setAllowAutoWiredDestinationResolver​(boolean allowAutoWiredDestinationResolver)

      • setQueueBrowseStrategy

        public void setQueueBrowseStrategy​(QueueBrowseStrategy queueBrowseStrategy)
        To use a custom QueueBrowseStrategy when browsing queues

      • createInOutTemplate

        public org.springframework.jms.core.JmsOperations createInOutTemplate​(JmsEndpoint endpoint,
                                                                      boolean pubSubDomain,
                                                                      String destination,
                                                                      long requestTimeout)

      • createInOnlyTemplate

        public org.springframework.jms.core.JmsOperations createInOnlyTemplate​(JmsEndpoint endpoint,
                                                                       boolean pubSubDomain,
                                                                       String destination)

      • createMessageListenerContainer

        public org.springframework.jms.listener.AbstractMessageListenerContainer createMessageListenerContainer​(JmsEndpoint endpoint)

      • chooseMessageListenerContainerImplementation

        public org.springframework.jms.listener.AbstractMessageListenerContainer chooseMessageListenerContainerImplementation​(JmsEndpoint endpoint)

      • setConsumerType

        public void setConsumerType​(ConsumerType consumerType)

      • getReplyToConsumerType

        public ConsumerType getReplyToConsumerType()

      • setReplyToConsumerType

        public void setReplyToConsumerType​(ConsumerType replyToConsumerType)

      • getConnectionFactory

        public javax.jms.ConnectionFactory getConnectionFactory()

      • getOrCreateConnectionFactory

        public javax.jms.ConnectionFactory getOrCreateConnectionFactory()

      • setConnectionFactory

        public void setConnectionFactory​(javax.jms.ConnectionFactory connectionFactory)

      • getUsername

        public String getUsername()

      • setUsername

        public void setUsername​(String username)

      • getPassword

        public String getPassword()

      • setPassword

        public void setPassword​(String password)

      • getListenerConnectionFactory

        public javax.jms.ConnectionFactory getListenerConnectionFactory()

      • getOrCreateListenerConnectionFactory

        public javax.jms.ConnectionFactory getOrCreateListenerConnectionFactory()

      • setListenerConnectionFactory

        public void setListenerConnectionFactory​(javax.jms.ConnectionFactory listenerConnectionFactory)

      • getTemplateConnectionFactory

        public javax.jms.ConnectionFactory getTemplateConnectionFactory()

      • getOrCreateTemplateConnectionFactory

        public javax.jms.ConnectionFactory getOrCreateTemplateConnectionFactory()

      • setTemplateConnectionFactory

        public void setTemplateConnectionFactory​(javax.jms.ConnectionFactory templateConnectionFactory)

      • isAutoStartup

        public boolean isAutoStartup()

      • setAutoStartup

        public void setAutoStartup​(boolean autoStartup)

      • isAcceptMessagesWhileStopping

        public boolean isAcceptMessagesWhileStopping()

      • setAcceptMessagesWhileStopping

        public void setAcceptMessagesWhileStopping​(boolean acceptMessagesWhileStopping)

      • isAllowReplyManagerQuickStop

        public boolean isAllowReplyManagerQuickStop()

      • setAllowReplyManagerQuickStop

        public void setAllowReplyManagerQuickStop​(boolean allowReplyManagerQuickStop)

      • getClientId

        public String getClientId()

      • setClientId

        public void setClientId​(String consumerClientId)

      • getDurableSubscriptionName

        public String getDurableSubscriptionName()

      • setDurableSubscriptionName

        public void setDurableSubscriptionName​(String durableSubscriptionName)

      • getExceptionListener

        public javax.jms.ExceptionListener getExceptionListener()

      • setExceptionListener

        public void setExceptionListener​(javax.jms.ExceptionListener exceptionListener)

      • setErrorHandler

        public void setErrorHandler​(org.springframework.util.ErrorHandler errorHandler)

      • getErrorHandler

        public org.springframework.util.ErrorHandler getErrorHandler()

      • getErrorHandlerLoggingLevel

        public org.apache.camel.LoggingLevel getErrorHandlerLoggingLevel()

      • setErrorHandlerLoggingLevel

        public void setErrorHandlerLoggingLevel​(org.apache.camel.LoggingLevel errorHandlerLoggingLevel)

      • isErrorHandlerLogStackTrace

        public boolean isErrorHandlerLogStackTrace()

      • setErrorHandlerLogStackTrace

        public void setErrorHandlerLogStackTrace​(boolean errorHandlerLogStackTrace)

      • getAcknowledgementModeName

        public String getAcknowledgementModeName()

      • setAcknowledgementModeName

        public void setAcknowledgementModeName​(String consumerAcknowledgementMode)

      • isExposeListenerSession

        public boolean isExposeListenerSession()

      • setExposeListenerSession

        public void setExposeListenerSession​(boolean exposeListenerSession)

      • getTaskExecutor

        public org.springframework.core.task.TaskExecutor getTaskExecutor()

      • setTaskExecutor

        public void setTaskExecutor​(org.springframework.core.task.TaskExecutor taskExecutor)

      • isPubSubNoLocal

        public boolean isPubSubNoLocal()

      • setPubSubNoLocal

        public void setPubSubNoLocal​(boolean pubSubNoLocal)

      • getConcurrentConsumers

        public int getConcurrentConsumers()

      • setConcurrentConsumers

        public void setConcurrentConsumers​(int concurrentConsumers)

      • getReplyToConcurrentConsumers

        public int getReplyToConcurrentConsumers()

      • setReplyToConcurrentConsumers

        public void setReplyToConcurrentConsumers​(int replyToConcurrentConsumers)

      • getMaxMessagesPerTask

        public int getMaxMessagesPerTask()

      • setMaxMessagesPerTask

        public void setMaxMessagesPerTask​(int maxMessagesPerTask)

      • getCacheLevel

        public int getCacheLevel()

      • setCacheLevel

        public void setCacheLevel​(int cacheLevel)

      • getCacheLevelName

        public String getCacheLevelName()

      • setCacheLevelName

        public void setCacheLevelName​(String cacheName)

      • getRecoveryInterval

        public long getRecoveryInterval()

      • setRecoveryInterval

        public void setRecoveryInterval​(long recoveryInterval)

      • getReceiveTimeout

        public long getReceiveTimeout()

      • setReceiveTimeout

        public void setReceiveTimeout​(long receiveTimeout)

      • getTransactionManager

        public org.springframework.transaction.PlatformTransactionManager getTransactionManager()

      • getOrCreateTransactionManager

        public org.springframework.transaction.PlatformTransactionManager getOrCreateTransactionManager()

      • setTransactionManager

        public void setTransactionManager​(org.springframework.transaction.PlatformTransactionManager transactionManager)

      • getTransactionName

        public String getTransactionName()

      • setTransactionName

        public void setTransactionName​(String transactionName)

      • getTransactionTimeout

        public int getTransactionTimeout()

      • setTransactionTimeout

        public void setTransactionTimeout​(int transactionTimeout)

      • getIdleTaskExecutionLimit

        public int getIdleTaskExecutionLimit()

      • setIdleTaskExecutionLimit

        public void setIdleTaskExecutionLimit​(int idleTaskExecutionLimit)

      • getIdleConsumerLimit

        public int getIdleConsumerLimit()

      • setIdleConsumerLimit

        public void setIdleConsumerLimit​(int idleConsumerLimit)

      • getWaitForProvisionCorrelationToBeUpdatedCounter

        public int getWaitForProvisionCorrelationToBeUpdatedCounter()

      • setWaitForProvisionCorrelationToBeUpdatedCounter

        public void setWaitForProvisionCorrelationToBeUpdatedCounter​(int counter)

      • getWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime

        public long getWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime()

      • setWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime

        public void setWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime​(long sleepingTime)

      • getMaxConcurrentConsumers

        public int getMaxConcurrentConsumers()

      • setMaxConcurrentConsumers

        public void setMaxConcurrentConsumers​(int maxConcurrentConsumers)

      • getReplyToMaxConcurrentConsumers

        public int getReplyToMaxConcurrentConsumers()

      • setReplyToMaxConcurrentConsumers

        public void setReplyToMaxConcurrentConsumers​(int replyToMaxConcurrentConsumers)

      • getReplyToOnTimeoutMaxConcurrentConsumers

        public int getReplyToOnTimeoutMaxConcurrentConsumers()

      • setReplyToOnTimeoutMaxConcurrentConsumers

        public void setReplyToOnTimeoutMaxConcurrentConsumers​(int replyToOnTimeoutMaxConcurrentConsumers)

      • isExplicitQosEnabled

        public boolean isExplicitQosEnabled()

      • getExplicitQosEnabled

        public Boolean getExplicitQosEnabled()

      • setExplicitQosEnabled

        public void setExplicitQosEnabled​(boolean explicitQosEnabled)

      • isDeliveryPersistent

        public boolean isDeliveryPersistent()

      • setDeliveryPersistent

        public void setDeliveryPersistent​(boolean deliveryPersistent)

      • getDeliveryMode

        public Integer getDeliveryMode()

      • setDeliveryMode

        public void setDeliveryMode​(Integer deliveryMode)

      • isReplyToDeliveryPersistent

        public boolean isReplyToDeliveryPersistent()

      • setReplyToDeliveryPersistent

        public void setReplyToDeliveryPersistent​(boolean replyToDeliveryPersistent)

      • getTimeToLive

        public long getTimeToLive()

      • setTimeToLive

        public void setTimeToLive​(long timeToLive)

      • getMessageConverter

        public org.springframework.jms.support.converter.MessageConverter getMessageConverter()

      • setMessageConverter

        public void setMessageConverter​(org.springframework.jms.support.converter.MessageConverter messageConverter)

      • isMapJmsMessage

        public boolean isMapJmsMessage()

      • setMapJmsMessage

        public void setMapJmsMessage​(boolean mapJmsMessage)

      • isMessageIdEnabled

        public boolean isMessageIdEnabled()

      • setMessageIdEnabled

        public void setMessageIdEnabled​(boolean messageIdEnabled)

      • isMessageTimestampEnabled

        public boolean isMessageTimestampEnabled()

      • setMessageTimestampEnabled

        public void setMessageTimestampEnabled​(boolean messageTimestampEnabled)

      • getPriority

        public int getPriority()

      • setPriority

        public void setPriority​(int priority)

      • getAcknowledgementMode

        public int getAcknowledgementMode()

      • setAcknowledgementMode

        public void setAcknowledgementMode​(int consumerAcknowledgementMode)

      • isTransacted

        public boolean isTransacted()

      • setTransacted

        public void setTransacted​(boolean transacted)

      • isTransactedInOut

        public boolean isTransactedInOut()

      • setTransactedInOut

        public void setTransactedInOut​(boolean transacted)

      • isLazyCreateTransactionManager

        public boolean isLazyCreateTransactionManager()

      • setLazyCreateTransactionManager

        public void setLazyCreateTransactionManager​(boolean lazyCreating)

      • getEagerPoisonBody

        public String getEagerPoisonBody()

      • setEagerPoisonBody

        public void setEagerPoisonBody​(String eagerPoisonBody)

      • isEagerLoadingOfProperties

        public boolean isEagerLoadingOfProperties()

      • setEagerLoadingOfProperties

        public void setEagerLoadingOfProperties​(boolean eagerLoadingOfProperties)

      • isDisableReplyTo

        public boolean isDisableReplyTo()

      • setDisableReplyTo

        public void setDisableReplyTo​(boolean disableReplyTo)

      • setPreserveMessageQos

        public void setPreserveMessageQos​(boolean preserveMessageQos)

      • getJmsOperations

        public org.springframework.jms.core.JmsOperations getJmsOperations()

      • setJmsOperations

        public void setJmsOperations​(org.springframework.jms.core.JmsOperations jmsOperations)

      • getDestinationResolver

        public org.springframework.jms.support.destination.DestinationResolver getDestinationResolver()

      • setDestinationResolver

        public void setDestinationResolver​(org.springframework.jms.support.destination.DestinationResolver destinationResolver)

      • createDestinationResolver

        public static org.springframework.jms.support.destination.DestinationResolver createDestinationResolver​(DestinationEndpoint destinationEndpoint)

      • configureMessageListenerContainer

        public void configureMessageListenerContainer​(org.springframework.jms.listener.AbstractMessageListenerContainer container,
                                              JmsEndpoint endpoint)

      • defaultCacheLevel

        public int defaultCacheLevel​(JmsEndpoint endpoint)

      • createConnectionFactory

        public javax.jms.ConnectionFactory createConnectionFactory()

      • createListenerConnectionFactory

        public javax.jms.ConnectionFactory createListenerConnectionFactory()

      • createTemplateConnectionFactory

        public javax.jms.ConnectionFactory createTemplateConnectionFactory()

      • createTransactionManager

        public org.springframework.transaction.PlatformTransactionManager createTransactionManager()

      • isPreserveMessageQos

        public boolean isPreserveMessageQos()

      • configuredQoS

        public void configuredQoS()

      • isAlwaysCopyMessage

        public boolean isAlwaysCopyMessage()

      • setAlwaysCopyMessage

        public void setAlwaysCopyMessage​(boolean alwaysCopyMessage)

      • isUseMessageIDAsCorrelationID

        public boolean isUseMessageIDAsCorrelationID()

      • setUseMessageIDAsCorrelationID

        public void setUseMessageIDAsCorrelationID​(boolean useMessageIDAsCorrelationID)

      • getRequestTimeout

        public long getRequestTimeout()

      • setRequestTimeout

        public void setRequestTimeout​(long requestTimeout)

      • getRequestTimeoutCheckerInterval

        public long getRequestTimeoutCheckerInterval()

      • setRequestTimeoutCheckerInterval

        public void setRequestTimeoutCheckerInterval​(long requestTimeoutCheckerInterval)

      • getReplyTo

        public String getReplyTo()

      • setReplyTo

        public void setReplyTo​(String replyToDestination)

      • getReplyToDestinationSelectorName

        public String getReplyToDestinationSelectorName()

      • setReplyToDestinationSelectorName

        public void setReplyToDestinationSelectorName​(String replyToDestinationSelectorName)

      • getReplyToOverride

        public String getReplyToOverride()

      • setReplyToOverride

        public void setReplyToOverride​(String replyToDestination)

      • isReplyToSameDestinationAllowed

        public boolean isReplyToSameDestinationAllowed()

      • setReplyToSameDestinationAllowed

        public void setReplyToSameDestinationAllowed​(boolean replyToSameDestinationAllowed)

      • setJmsMessageType

        public void setJmsMessageType​(JmsMessageType jmsMessageType)

      • supportBlobMessage

        public boolean supportBlobMessage()

      • setJmsKeyFormatStrategy

        public void setJmsKeyFormatStrategy​(JmsKeyFormatStrategy jmsKeyFormatStrategy)

      • isTransferExchange

        public boolean isTransferExchange()

      • setTransferExchange

        public void setTransferExchange​(boolean transferExchange)

      • isAllowSerializedHeaders

        public boolean isAllowSerializedHeaders()

      • setAllowSerializedHeaders

        public void setAllowSerializedHeaders​(boolean allowSerializedHeaders)

      • isTransferException

        public boolean isTransferException()

      • setTransferException

        public void setTransferException​(boolean transferException)

      • isAsyncStartListener

        public boolean isAsyncStartListener()

      • setAsyncStartListener

        public void setAsyncStartListener​(boolean asyncStartListener)

      • isAsyncStopListener

        public boolean isAsyncStopListener()

      • setAsyncStopListener

        public void setAsyncStopListener​(boolean asyncStopListener)

      • isTestConnectionOnStartup

        public boolean isTestConnectionOnStartup()

      • setTestConnectionOnStartup

        public void setTestConnectionOnStartup​(boolean testConnectionOnStartup)

      • setForceSendOriginalMessage

        public void setForceSendOriginalMessage​(boolean forceSendOriginalMessage)

      • isForceSendOriginalMessage

        public boolean isForceSendOriginalMessage()

      • isDisableTimeToLive

        public boolean isDisableTimeToLive()

      • setDisableTimeToLive

        public void setDisableTimeToLive​(boolean disableTimeToLive)

      • setReplyToType

        public void setReplyToType​(ReplyToType replyToType)

      • isAsyncConsumer

        public boolean isAsyncConsumer()

      • setAsyncConsumer

        public void setAsyncConsumer​(boolean asyncConsumer)

      • setReplyToCacheLevelName

        public void setReplyToCacheLevelName​(String name)

      • getReplyToCacheLevelName

        public String getReplyToCacheLevelName()

      • isAllowNullBody

        public boolean isAllowNullBody()

      • setAllowNullBody

        public void setAllowNullBody​(boolean allowNullBody)

      • isIncludeSentJMSMessageID

        public boolean isIncludeSentJMSMessageID()

      • setIncludeSentJMSMessageID

        public void setIncludeSentJMSMessageID​(boolean includeSentJMSMessageID)

      • setDefaultTaskExecutorType

        public void setDefaultTaskExecutorType​(DefaultTaskExecutorType defaultTaskExecutorType)

      • isIncludeAllJMSXProperties

        public boolean isIncludeAllJMSXProperties()

      • setIncludeAllJMSXProperties

        public void setIncludeAllJMSXProperties​(boolean includeAllJMSXProperties)

      • getSelector

        public String getSelector()

      • setSelector

        public void setSelector​(String selector)

      • setCorrelationProperty

        public void setCorrelationProperty​(String correlationProperty)

      • getCorrelationProperty

        public String getCorrelationProperty()

      • getAllowAdditionalHeaders

        public String getAllowAdditionalHeaders()

      • setAllowAdditionalHeaders

        public void setAllowAdditionalHeaders​(String allowAdditionalHeaders)

      • isSubscriptionDurable

        public boolean isSubscriptionDurable()

      • setSubscriptionDurable

        public void setSubscriptionDurable​(boolean subscriptionDurable)

      • isSubscriptionShared

        public boolean isSubscriptionShared()

      • setSubscriptionShared

        public void setSubscriptionShared​(boolean subscriptionShared)

      • getSubscriptionName

        public String getSubscriptionName()

      • setSubscriptionName

        public void setSubscriptionName​(String subscriptionName)

      • isStreamMessageTypeEnabled

        public boolean isStreamMessageTypeEnabled()

      • setStreamMessageTypeEnabled

        public void setStreamMessageTypeEnabled​(boolean streamMessageTypeEnabled)

      • isFormatDateHeadersToIso8601

        public boolean isFormatDateHeadersToIso8601()

      • setFormatDateHeadersToIso8601

        public void setFormatDateHeadersToIso8601​(boolean formatDateHeadersToIso8601)

      • getDeliveryDelay

        public long getDeliveryDelay()

      • setDeliveryDelay

        public void setDeliveryDelay​(long deliveryDelay)

      • setMessageCreatedStrategy

        public void setMessageCreatedStrategy​(MessageCreatedStrategy messageCreatedStrategy)

      • isArtemisStreamingEnabled

        public boolean isArtemisStreamingEnabled()

      • setArtemisStreamingEnabled

        public void setArtemisStreamingEnabled​(boolean artemisStreamingEnabled)

      • setArtemisConsumerPriority

        public void setArtemisConsumerPriority​(int priority)

      • getArtemisConsumerPriority

        public int getArtemisConsumerPriority()

      • doInit

        protected void doInit()
               throws Exception
        Overrides:
        doInit in class org.apache.camel.support.DefaultComponent
        Throws:
        Exception

      • doShutdown

        protected void doShutdown()
                   throws Exception
        Overrides:
        doShutdown in class org.apache.camel.support.service.BaseService
        Throws:
        Exception

      • getAsyncStartStopExecutorService

        protected ExecutorService getAsyncStartStopExecutorService()

      • createEndpoint

        protected org.apache.camel.Endpoint createEndpoint​(String uri,
                                                   String remaining,
                                                   Map<String,​Object> parameters)
                                            throws Exception
        Specified by:
        createEndpoint in class org.apache.camel.support.DefaultComponent
        Throws:
        Exception

      • convertPathToActualDestination

        protected String convertPathToActualDestination​(String path,
                                                Map<String,​Object> parameters)
        A strategy method allowing the URI destination to be translated into the actual JMS destination name (say by looking up in JNDI or something)
        Parameters:
        path - the path to convert
        parameters - an optional, component specific, set of parameters
        Returns:
        the path as the actual destination

      • createConfiguration

        protected JmsConfiguration createConfiguration()
        Factory method to create the default configuration instance
        Returns:
        a newly created configuration object which can then be further customized