Package org.apache.camel.component.jms

Class JmsEndpoint

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.AsyncEndpoint, org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.MultipleConsumersSupport, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.spi.HeaderFilterStrategyAware, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
    Direct Known Subclasses:
    JmsQueueEndpoint, JmsTemporaryTopicEndpoint
    @ManagedResource(description="Managed JMS Endpoint")
@UriEndpoint(firstVersion="1.0.0",
             scheme="jms",
             title="JMS",
             syntax="jms:destinationType:destinationName",
             category=MESSAGING,
             headersClass=JmsConstants.class)
@Metadata(excludeProperties="bridgeErrorHandler")
public class JmsEndpoint
extends org.apache.camel.support.DefaultEndpoint
implements org.apache.camel.AsyncEndpoint, org.apache.camel.spi.HeaderFilterStrategyAware, org.apache.camel.MultipleConsumersSupport, org.apache.camel.Service
    Sent and receive messages to/from a JMS Queue or Topic. This component uses Spring JMS and supports JMS 1.1 and 2.0 API.

    • Constructor Detail

      • JmsEndpoint

        public JmsEndpoint()

      • JmsEndpoint

        public JmsEndpoint​(String endpointUri,
                   String destinationName,
                   boolean pubSubDomain)

      • JmsEndpoint

        public JmsEndpoint​(String endpointUri,
                   String destinationName)
        Creates a pub-sub endpoint with the given destination

    • Method Detail

      • createProducer

        public org.apache.camel.Producer createProducer()
                                         throws Exception
        Specified by:
        createProducer in interface org.apache.camel.Endpoint
        Throws:
        Exception

      • createConsumer

        public JmsConsumer createConsumer​(org.apache.camel.Processor processor)
                           throws Exception
        Specified by:
        createConsumer in interface org.apache.camel.Endpoint
        Throws:
        Exception

      • createMessageListenerContainer

        public org.springframework.jms.listener.AbstractMessageListenerContainer createMessageListenerContainer()

      • createReplyToMessageListenerContainer

        public org.springframework.jms.listener.AbstractMessageListenerContainer createReplyToMessageListenerContainer()

      • configureListenerContainer

        public void configureListenerContainer​(org.springframework.jms.listener.AbstractMessageListenerContainer listenerContainer,
                                       JmsConsumer consumer)

      • getEndpointConfiguredDestinationName

        public String getEndpointConfiguredDestinationName()
        Gets the destination name which was configured from the endpoint uri.
        Returns:
        the destination name resolved from the endpoint uri

      • createConsumer

        public JmsConsumer createConsumer​(org.apache.camel.Processor processor,
                                  org.springframework.jms.listener.AbstractMessageListenerContainer listenerContainer)
                           throws Exception
        Creates a consumer using the given processor and listener container
        Parameters:
        processor - the processor to use to process the messages
        listenerContainer - the listener container
        Returns:
        a newly created consumer
        Throws:
        Exception - if the consumer cannot be created

      • createPollingConsumer

        public org.apache.camel.PollingConsumer createPollingConsumer()
                                                       throws Exception
        Specified by:
        createPollingConsumer in interface org.apache.camel.Endpoint
        Overrides:
        createPollingConsumer in class org.apache.camel.support.DefaultEndpoint
        Throws:
        Exception

      • createExchange

        public org.apache.camel.Exchange createExchange​(org.apache.camel.ExchangePattern pattern)
        Specified by:
        createExchange in interface org.apache.camel.Endpoint
        Overrides:
        createExchange in class org.apache.camel.support.DefaultEndpoint

      • createExchange

        public org.apache.camel.Exchange createExchange​(javax.jms.Message message,
                                                javax.jms.Session session)

      • createInOnlyTemplate

        public org.springframework.jms.core.JmsOperations createInOnlyTemplate()
        Factory method for creating a new template for InOnly message exchanges

      • createInOutTemplate

        public org.springframework.jms.core.JmsOperations createInOutTemplate()
        Factory method for creating a new template for InOut message exchanges

      • isMultipleConsumersSupported

        public boolean isMultipleConsumersSupported()
        Specified by:
        isMultipleConsumersSupported in interface org.apache.camel.MultipleConsumersSupport

      • getThreadName

        public String getThreadName()

      • getComponent

        public JmsComponent getComponent()
        Overrides:
        getComponent in class org.apache.camel.support.DefaultEndpoint

      • getHeaderFilterStrategy

        public org.apache.camel.spi.HeaderFilterStrategy getHeaderFilterStrategy()
        Specified by:
        getHeaderFilterStrategy in interface org.apache.camel.spi.HeaderFilterStrategyAware

      • setHeaderFilterStrategy

        public void setHeaderFilterStrategy​(org.apache.camel.spi.HeaderFilterStrategy strategy)
        To use a custom HeaderFilterStrategy to filter header to and from Camel message.
        Specified by:
        setHeaderFilterStrategy in interface org.apache.camel.spi.HeaderFilterStrategyAware

      • setBinding

        public void setBinding​(JmsBinding binding)
        Sets the binding used to convert from a Camel message to and from a JMS message

      • getDestinationType

        public String getDestinationType()

      • setDestinationType

        public void setDestinationType​(String destinationType)
        The kind of destination to use

      • getDestinationName

        public String getDestinationName()

      • setDestinationName

        public void setDestinationName​(String destinationName)
        Name of the queue or topic to use as destination

      • setConfiguration

        public void setConfiguration​(JmsConfiguration configuration)

      • isPubSubDomain

        @ManagedAttribute
public boolean isPubSubDomain()

      • getAsyncStartStopExecutorService

        protected ExecutorService getAsyncStartStopExecutorService()

      • onListenerContainerStarting

        public void onListenerContainerStarting()

      • onListenerContainerStopped

        public void onListenerContainerStopped()

      • isRunning

        protected boolean isRunning()
        State whether this endpoint is running (eg started)

      • stop

        public void stop()
        Specified by:
        stop in interface org.apache.camel.Service
        Overrides:
        stop in class org.apache.camel.support.service.BaseService

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface org.apache.camel.ShutdownableService
        Overrides:
        shutdown in class org.apache.camel.support.service.BaseService

      • getAcknowledgementMode

        @ManagedAttribute
public int getAcknowledgementMode()

      • getAcknowledgementModeName

        @ManagedAttribute
public String getAcknowledgementModeName()

      • getCacheLevel

        @ManagedAttribute
public int getCacheLevel()

      • getCacheLevelName

        @ManagedAttribute
public String getCacheLevelName()

      • getReplyToCacheLevelName

        @ManagedAttribute
public String getReplyToCacheLevelName()

      • getClientId

        @ManagedAttribute
public String getClientId()

      • getConcurrentConsumers

        @ManagedAttribute
public int getConcurrentConsumers()

      • getReplyToConcurrentConsumers

        @ManagedAttribute
public int getReplyToConcurrentConsumers()

      • getConnectionFactory

        public javax.jms.ConnectionFactory getConnectionFactory()

      • getDestinationResolver

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

      • getDurableSubscriptionName

        @ManagedAttribute
public String getDurableSubscriptionName()

      • getExceptionListener

        public javax.jms.ExceptionListener getExceptionListener()

      • getErrorHandler

        public org.springframework.util.ErrorHandler getErrorHandler()

      • getErrorHandlerLoggingLevel

        public org.apache.camel.LoggingLevel getErrorHandlerLoggingLevel()

      • isErrorHandlerLogStackTrace

        @ManagedAttribute
public boolean isErrorHandlerLogStackTrace()

      • setErrorHandlerLogStackTrace

        @ManagedAttribute
public void setErrorHandlerLogStackTrace​(boolean errorHandlerLogStackTrace)

      • getIdleTaskExecutionLimit

        @ManagedAttribute
public int getIdleTaskExecutionLimit()

      • getIdleConsumerLimit

        @ManagedAttribute
public int getIdleConsumerLimit()

      • getJmsOperations

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

      • getListenerConnectionFactory

        public javax.jms.ConnectionFactory getListenerConnectionFactory()

      • getMaxConcurrentConsumers

        @ManagedAttribute
public int getMaxConcurrentConsumers()

      • getReplyToMaxConcurrentConsumers

        @ManagedAttribute
public int getReplyToMaxConcurrentConsumers()

      • getReplyToOnTimeoutMaxConcurrentConsumers

        @ManagedAttribute
public int getReplyToOnTimeoutMaxConcurrentConsumers()

      • getMaxMessagesPerTask

        @ManagedAttribute
public int getMaxMessagesPerTask()

      • getMessageConverter

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

      • getPriority

        @ManagedAttribute
public int getPriority()

      • getReceiveTimeout

        @ManagedAttribute
public long getReceiveTimeout()

      • getRecoveryInterval

        @ManagedAttribute
public long getRecoveryInterval()

      • getReplyTo

        @ManagedAttribute
public String getReplyTo()

      • getReplyToOverride

        @ManagedAttribute
public String getReplyToOverride()

      • isReplyToSameDestinationAllowed

        @ManagedAttribute
public boolean isReplyToSameDestinationAllowed()

      • getReplyToDestinationSelectorName

        @ManagedAttribute
public String getReplyToDestinationSelectorName()

      • getRequestTimeout

        @ManagedAttribute
public long getRequestTimeout()

      • getRequestTimeoutCheckerInterval

        @ManagedAttribute
public long getRequestTimeoutCheckerInterval()

      • getTaskExecutor

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

      • getTemplateConnectionFactory

        public javax.jms.ConnectionFactory getTemplateConnectionFactory()

      • getTimeToLive

        @ManagedAttribute
public long getTimeToLive()

      • getTransactionManager

        public org.springframework.transaction.PlatformTransactionManager getTransactionManager()

      • getTransactionName

        @ManagedAttribute
public String getTransactionName()

      • getTransactionTimeout

        @ManagedAttribute
public int getTransactionTimeout()

      • isAcceptMessagesWhileStopping

        @ManagedAttribute
public boolean isAcceptMessagesWhileStopping()

      • isAllowReplyManagerQuickStop

        @ManagedAttribute
public boolean isAllowReplyManagerQuickStop()

      • isAlwaysCopyMessage

        @ManagedAttribute
public boolean isAlwaysCopyMessage()

      • isAutoStartup

        @ManagedAttribute
public boolean isAutoStartup()

      • isDeliveryPersistent

        @ManagedAttribute
public boolean isDeliveryPersistent()

      • getDeliveryMode

        @ManagedAttribute
public Integer getDeliveryMode()

      • isDisableReplyTo

        @ManagedAttribute
public boolean isDisableReplyTo()

      • getEagerPoisonBody

        @ManagedAttribute
public String getEagerPoisonBody()

      • isEagerLoadingOfProperties

        @ManagedAttribute
public boolean isEagerLoadingOfProperties()

      • isExplicitQosEnabled

        @ManagedAttribute
public boolean isExplicitQosEnabled()

      • isExposeListenerSession

        @ManagedAttribute
public boolean isExposeListenerSession()

      • isMessageIdEnabled

        @ManagedAttribute
public boolean isMessageIdEnabled()

      • isMessageTimestampEnabled

        @ManagedAttribute
public boolean isMessageTimestampEnabled()

      • isPreserveMessageQos

        @ManagedAttribute
public boolean isPreserveMessageQos()

      • isPubSubNoLocal

        @ManagedAttribute
public boolean isPubSubNoLocal()

      • isReplyToDeliveryPersistent

        @ManagedAttribute
public boolean isReplyToDeliveryPersistent()

      • isTransacted

        @ManagedAttribute
public boolean isTransacted()

      • isTransactedInOut

        @ManagedAttribute
public boolean isTransactedInOut()

      • isLazyCreateTransactionManager

        @ManagedAttribute
public boolean isLazyCreateTransactionManager()

      • isUseMessageIDAsCorrelationID

        @ManagedAttribute
public boolean isUseMessageIDAsCorrelationID()

      • setAcceptMessagesWhileStopping

        @ManagedAttribute
public void setAcceptMessagesWhileStopping​(boolean acceptMessagesWhileStopping)

      • setAllowReplyManagerQuickStop

        @ManagedAttribute
public void setAllowReplyManagerQuickStop​(boolean allowReplyManagerQuickStop)

      • setAcknowledgementMode

        @ManagedAttribute
public void setAcknowledgementMode​(int consumerAcknowledgementMode)

      • setAcknowledgementModeName

        @ManagedAttribute
public void setAcknowledgementModeName​(String consumerAcknowledgementMode)

      • setAlwaysCopyMessage

        @ManagedAttribute
public void setAlwaysCopyMessage​(boolean alwaysCopyMessage)

      • setAutoStartup

        @ManagedAttribute
public void setAutoStartup​(boolean autoStartup)

      • setCacheLevel

        @ManagedAttribute
public void setCacheLevel​(int cacheLevel)

      • setCacheLevelName

        @ManagedAttribute
public void setCacheLevelName​(String cacheName)

      • setReplyToCacheLevelName

        @ManagedAttribute
public void setReplyToCacheLevelName​(String cacheName)

      • setClientId

        @ManagedAttribute
public void setClientId​(String consumerClientId)

      • setConcurrentConsumers

        @ManagedAttribute
public void setConcurrentConsumers​(int concurrentConsumers)

      • setReplyToConcurrentConsumers

        @ManagedAttribute
public void setReplyToConcurrentConsumers​(int concurrentConsumers)

      • setConnectionFactory

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

      • setDeliveryPersistent

        @ManagedAttribute
public void setDeliveryPersistent​(boolean deliveryPersistent)

      • setDeliveryMode

        @ManagedAttribute
public void setDeliveryMode​(Integer deliveryMode)

      • setDestinationResolver

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

      • setDisableReplyTo

        @ManagedAttribute
public void setDisableReplyTo​(boolean disableReplyTo)

      • setDurableSubscriptionName

        @ManagedAttribute
public void setDurableSubscriptionName​(String durableSubscriptionName)

      • setEagerPoisonBody

        @ManagedAttribute
public void setEagerPoisonBody​(String eagerPoisonBody)

      • setEagerLoadingOfProperties

        @ManagedAttribute
public void setEagerLoadingOfProperties​(boolean eagerLoadingOfProperties)

      • setExceptionListener

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

      • setErrorHandler

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

      • setExplicitQosEnabled

        @ManagedAttribute
public void setExplicitQosEnabled​(boolean explicitQosEnabled)

      • setExposeListenerSession

        @ManagedAttribute
public void setExposeListenerSession​(boolean exposeListenerSession)

      • setIdleTaskExecutionLimit

        @ManagedAttribute
public void setIdleTaskExecutionLimit​(int idleTaskExecutionLimit)

      • setIdleConsumerLimit

        @ManagedAttribute
public void setIdleConsumerLimit​(int idleConsumerLimit)

      • setJmsOperations

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

      • setListenerConnectionFactory

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

      • setMaxConcurrentConsumers

        @ManagedAttribute
public void setMaxConcurrentConsumers​(int maxConcurrentConsumers)

      • setReplyToMaxConcurrentConsumers

        @ManagedAttribute
public void setReplyToMaxConcurrentConsumers​(int maxConcurrentConsumers)

      • setMaxMessagesPerTask

        @ManagedAttribute
public void setMaxMessagesPerTask​(int maxMessagesPerTask)

      • setMessageConverter

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

      • setMessageIdEnabled

        @ManagedAttribute
public void setMessageIdEnabled​(boolean messageIdEnabled)

      • setMessageTimestampEnabled

        @ManagedAttribute
public void setMessageTimestampEnabled​(boolean messageTimestampEnabled)

      • setPreserveMessageQos

        @ManagedAttribute
public void setPreserveMessageQos​(boolean preserveMessageQos)

      • setPriority

        @ManagedAttribute
public void setPriority​(int priority)

      • setPubSubNoLocal

        @ManagedAttribute
public void setPubSubNoLocal​(boolean pubSubNoLocal)

      • setReceiveTimeout

        @ManagedAttribute
public void setReceiveTimeout​(long receiveTimeout)

      • setRecoveryInterval

        @ManagedAttribute
public void setRecoveryInterval​(long recoveryInterval)

      • setReplyTo

        @ManagedAttribute
public void setReplyTo​(String replyToDestination)

      • setReplyToOverride

        @ManagedAttribute
public void setReplyToOverride​(String replyToDestination)

      • setReplyToSameDestinationAllowed

        @ManagedAttribute
public void setReplyToSameDestinationAllowed​(boolean replyToSameDestinationAllowed)

      • setReplyToDeliveryPersistent

        @ManagedAttribute
public void setReplyToDeliveryPersistent​(boolean replyToDeliveryPersistent)

      • setReplyToDestinationSelectorName

        @ManagedAttribute
public void setReplyToDestinationSelectorName​(String replyToDestinationSelectorName)

      • setRequestTimeout

        @ManagedAttribute
public void setRequestTimeout​(long requestTimeout)

      • setTaskExecutor

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

      • setTemplateConnectionFactory

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

      • setTimeToLive

        @ManagedAttribute
public void setTimeToLive​(long timeToLive)

      • setTransacted

        @ManagedAttribute
public void setTransacted​(boolean transacted)

      • setLazyCreateTransactionManager

        @ManagedAttribute
public void setLazyCreateTransactionManager​(boolean lazyCreating)

      • setTransactionManager

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

      • setTransactionName

        @ManagedAttribute
public void setTransactionName​(String transactionName)

      • setTransactionTimeout

        @ManagedAttribute
public void setTransactionTimeout​(int transactionTimeout)

      • setUseMessageIDAsCorrelationID

        @ManagedAttribute
public void setUseMessageIDAsCorrelationID​(boolean useMessageIDAsCorrelationID)

      • setJmsMessageType

        public void setJmsMessageType​(JmsMessageType jmsMessageType)

      • setJmsKeyFormatStrategy

        public void setJmsKeyFormatStrategy​(JmsKeyFormatStrategy jmsHeaderStrategy)

      • setMessageCreatedStrategy

        public void setMessageCreatedStrategy​(MessageCreatedStrategy messageCreatedStrategy)

      • isTransferExchange

        @ManagedAttribute
public boolean isTransferExchange()

      • setTransferExchange

        @ManagedAttribute
public void setTransferExchange​(boolean transferExchange)

      • isAllowSerializedHeaders

        @ManagedAttribute
public boolean isAllowSerializedHeaders()

      • setAllowSerializedHeaders

        @ManagedAttribute
public void setAllowSerializedHeaders​(boolean allowSerializedHeaders)

      • isTransferException

        @ManagedAttribute
public boolean isTransferException()

      • setTransferException

        @ManagedAttribute
public void setTransferException​(boolean transferException)

      • isTestConnectionOnStartup

        @ManagedAttribute
public boolean isTestConnectionOnStartup()

      • setTestConnectionOnStartup

        @ManagedAttribute
public void setTestConnectionOnStartup​(boolean testConnectionOnStartup)

      • isForceSendOriginalMessage

        @ManagedAttribute
public boolean isForceSendOriginalMessage()

      • setForceSendOriginalMessage

        @ManagedAttribute
public void setForceSendOriginalMessage​(boolean forceSendOriginalMessage)

      • isDisableTimeToLive

        @ManagedAttribute
public boolean isDisableTimeToLive()

      • setDisableTimeToLive

        @ManagedAttribute
public void setDisableTimeToLive​(boolean disableTimeToLive)

      • setAsyncConsumer

        @ManagedAttribute
public void setAsyncConsumer​(boolean asyncConsumer)

      • isAsyncConsumer

        @ManagedAttribute
public boolean isAsyncConsumer()

      • setAsyncStartListener

        @ManagedAttribute
public void setAsyncStartListener​(boolean asyncStartListener)

      • isAsyncStartListener

        @ManagedAttribute
public boolean isAsyncStartListener()

      • setAsyncStopListener

        @ManagedAttribute
public void setAsyncStopListener​(boolean asyncStopListener)

      • isAsyncStopListener

        @ManagedAttribute
public boolean isAsyncStopListener()

      • isAllowNullBody

        @ManagedAttribute
public boolean isAllowNullBody()

      • setAllowNullBody

        @ManagedAttribute
public void setAllowNullBody​(boolean allowNullBody)

      • isIncludeSentJMSMessageID

        @ManagedAttribute
public boolean isIncludeSentJMSMessageID()

      • setIncludeSentJMSMessageID

        @ManagedAttribute
public void setIncludeSentJMSMessageID​(boolean includeSentJMSMessageID)

      • isIncludeAllJMSXProperties

        @ManagedAttribute
public boolean isIncludeAllJMSXProperties()

      • setIncludeAllJMSXProperties

        @ManagedAttribute
public void setIncludeAllJMSXProperties​(boolean includeAllJMSXProperties)

      • getAllowAdditionalHeaders

        @ManagedAttribute
public String getAllowAdditionalHeaders()

      • setAllowAdditionalHeaders

        @ManagedAttribute
public void setAllowAdditionalHeaders​(String allowAdditionalHeaders)

      • isSubscriptionDurable

        @ManagedAttribute
public boolean isSubscriptionDurable()

      • setSubscriptionDurable

        @ManagedAttribute
public void setSubscriptionDurable​(boolean subscriptionDurable)

      • isSubscriptionShared

        @ManagedAttribute
public boolean isSubscriptionShared()

      • setSubscriptionShared

        @ManagedAttribute
public void setSubscriptionShared​(boolean subscriptionShared)

      • getSubscriptionName

        @ManagedAttribute
public String getSubscriptionName()

      • setSubscriptionName

        @ManagedAttribute
public void setSubscriptionName​(String subscriptionName)

      • getReplyToType

        @ManagedAttribute
public String getReplyToType()

      • setReplyToType

        @ManagedAttribute
public void setReplyToType​(String replyToType)

      • getRunningMessageListeners

        @ManagedAttribute(description="Number of running message listeners")
public int getRunningMessageListeners()

      • getSelector

        @ManagedAttribute
public String getSelector()

      • setSelector

        public void setSelector​(String selector)

      • getWaitForProvisionCorrelationToBeUpdatedCounter

        @ManagedAttribute
public int getWaitForProvisionCorrelationToBeUpdatedCounter()

      • setWaitForProvisionCorrelationToBeUpdatedCounter

        @ManagedAttribute
public void setWaitForProvisionCorrelationToBeUpdatedCounter​(int counter)

      • getWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime

        @ManagedAttribute
public long getWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime()

      • setWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime

        @ManagedAttribute
public void setWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime​(long sleepingTime)

      • isFormatDateHeadersToIso8601

        @ManagedAttribute
public boolean isFormatDateHeadersToIso8601()

      • setFormatDateHeadersToIso8601

        @ManagedAttribute
public void setFormatDateHeadersToIso8601​(boolean formatDateHeadersToIso8601)

      • isArtemisStreamingEnabled

        @ManagedAttribute
public boolean isArtemisStreamingEnabled()

      • setArtemisStreamingEnabled

        @ManagedAttribute
public void setArtemisStreamingEnabled​(boolean artemisStreamingEnabled)

      • createEndpointUri

        protected String createEndpointUri()
        Overrides:
        createEndpointUri in class org.apache.camel.support.DefaultEndpoint