org.apache.camel.component.jms
Class JmsEndpoint

java.lang.Object
  org.apache.camel.impl.DefaultEndpoint
      org.apache.camel.component.jms.JmsEndpoint

All Implemented Interfaces:

CamelContextAware, Endpoint, IsSingleton, HeaderFilterStrategyAware

Direct Known Subclasses:

JmsQueueEndpoint, JmsTemporaryTopicEndpoint

public class JmsEndpoint
extends DefaultEndpoint
implements HeaderFilterStrategyAware

A JMS Endpoint

Version:

$Revision:520964 $

Constructor Summary

JmsEndpoint()

JmsEndpoint(String endpointUri, JmsBinding binding, JmsConfiguration configuration, String destinationName, boolean pubSubDomain)

JmsEndpoint(String uri, JmsComponent component, String destinationName, boolean pubSubDomain, JmsConfiguration configuration)

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

JmsEndpoint(String endpointUri, String destinationName, boolean pubSubDomain)

JmsEndpoint(Topic destination)

Method Summary

void	checkValidTemplate(JmsTemplate template)
JmsConsumer	createConsumer(Processor processor)
JmsConsumer	createConsumer(Processor processor, AbstractMessageListenerContainer listenerContainer) Creates a consumer using the given processor and listener container
protected String	createEndpointUri()
Exchange	createExchange(ExchangePattern pattern)
Exchange	createExchange(Message message)
JmsOperations	createInOnlyTemplate() Factory method for creating a new template for InOnly message exchanges
JmsOperations	createInOutTemplate() Factory method for creating a new template for InOut message exchanges
PollingConsumer	createPollingConsumer()
JmsProducer	createProducer()
JmsProducer	createProducer(JmsOperations template) Creates a producer using the given template for InOnly message exchanges
int	getAcknowledgementMode()
String	getAcknowledgementModeName()
JmsBinding	getBinding()
int	getCacheLevel()
String	getCacheLevelName()
String	getClientId()
int	getConcurrentConsumers()
JmsConfiguration	getConfiguration()
ConnectionFactory	getConnectionFactory()
ConsumerType	getConsumerType()
Destination	getDestination()
String	getDestinationName()
DestinationResolver	getDestinationResolver()
String	getDurableSubscriptionName()
ExceptionListener	getExceptionListener()
HeaderFilterStrategy	getHeaderFilterStrategy()
int	getIdleTaskExecutionLimit()
JmsKeyFormatStrategy	getJmsKeyFormatStrategy()
JmsMessageType	getJmsMessageType()
JmsOperations	getJmsOperations()
ConnectionFactory	getListenerConnectionFactory()
int	getMaxConcurrentConsumers()
int	getMaxMessagesPerTask()
MessageConverter	getMessageConverter()
protected JmsOperations	getMetadataJmsOperations() Returns the JmsOperations used for metadata operations such as creating temporary destinations
JmsOperations	getMetadataJmsOperations(JmsEndpoint endpoint)
int	getPriority()
protected JmsProviderMetadata	getProviderMetadata() Returns the provider metadata
long	getReceiveTimeout()
long	getRecoveryInterval()
String	getReplyTo()
String	getReplyToDestinationSelectorName()
String	getReplyToTempDestinationAffinity()
long	getRequestMapPurgePollTimeMillis()
Requestor	getRequestor()
long	getRequestTimeout()
String	getSelector()
TaskExecutor	getTaskExecutor()
ConnectionFactory	getTemplateConnectionFactory()
Class<? extends TemporaryQueue>	getTemporaryQueueType() Lazily loads the temporary queue type if one has not been explicitly configured via calling the JmsProviderMetadata.setTemporaryQueueType(Class) on the getConfiguration() instance
Class<? extends TemporaryTopic>	getTemporaryTopicType() Lazily loads the temporary topic type if one has not been explicitly configured via calling the JmsProviderMetadata.setTemporaryTopicType(Class) on the getConfiguration() instance
long	getTimeToLive()
PlatformTransactionManager	getTransactionManager()
String	getTransactionName()
int	getTransactionTimeout()
boolean	isAcceptMessagesWhileStopping()
boolean	isAlwaysCopyMessage()
boolean	isAutoStartup()
boolean	isDeliveryPersistent()
boolean	isDisableReplyTo()
boolean	isEagerLoadingOfProperties()
boolean	isExplicitQosEnabled()
boolean	isExposeListenerSession()
boolean	isMessageIdEnabled()
boolean	isMessageTimestampEnabled()
boolean	isPreserveMessageQos()
boolean	isPubSubDomain()
boolean	isPubSubNoLocal()
boolean	isReplyToDeliveryPersistent()
boolean	isSingleton()
boolean	isSubscriptionDurable()
boolean	isTransacted()
boolean	isTransactedInOut()
boolean	isTransferException()
boolean	isTransferExchange()
boolean	isUseMessageIDAsCorrelationID()
boolean	isUseVersion102()
static JmsEndpoint	newInstance(Destination destination) Returns a new JMS endpoint for the given JMS destination
static JmsEndpoint	newInstance(Destination destination, JmsComponent component) Returns a new JMS endpoint for the given JMS destination using the configuration from the given JMS component
void	setAcceptMessagesWhileStopping(boolean acceptMessagesWhileStopping)
void	setAcknowledgementMode(int consumerAcknowledgementMode)
void	setAcknowledgementModeName(String consumerAcknowledgementMode)
void	setAlwaysCopyMessage(boolean alwaysCopyMessage)
void	setAutoStartup(boolean autoStartup)
void	setBinding(JmsBinding binding) Sets the binding used to convert from a Camel message to and from a JMS message
void	setCacheLevel(int cacheLevel)
void	setCacheLevelName(String cacheName)
void	setClientId(String consumerClientId)
void	setConcurrentConsumers(int concurrentConsumers)
void	setConfiguration(JmsConfiguration configuration)
void	setConnectionFactory(ConnectionFactory connectionFactory)
void	setConsumerType(ConsumerType consumerType)
void	setDeliveryPersistent(boolean deliveryPersistent)
void	setDestination(Destination destination) Allows a specific JMS Destination object to be used as the destination
void	setDestinationName(String destinationName)
void	setDestinationResolver(DestinationResolver destinationResolver)
void	setDisableReplyTo(boolean disableReplyTo)
void	setDurableSubscriptionName(String durableSubscriptionName)
void	setEagerLoadingOfProperties(boolean eagerLoadingOfProperties)
void	setExceptionListener(ExceptionListener exceptionListener)
void	setExplicitQosEnabled(boolean explicitQosEnabled)
void	setExposeListenerSession(boolean exposeListenerSession)
void	setHeaderFilterStrategy(HeaderFilterStrategy strategy)
void	setIdleTaskExecutionLimit(int idleTaskExecutionLimit)
void	setJmsKeyFormatStrategy(JmsKeyFormatStrategy jmsHeaderStrategy)
void	setJmsMessageType(JmsMessageType jmsMessageType)
void	setJmsOperations(JmsOperations jmsOperations)
void	setListenerConnectionFactory(ConnectionFactory listenerConnectionFactory)
void	setMaxConcurrentConsumers(int maxConcurrentConsumers)
void	setMaxMessagesPerTask(int maxMessagesPerTask)
void	setMessageConverter(MessageConverter messageConverter)
void	setMessageIdEnabled(boolean messageIdEnabled)
void	setMessageTimestampEnabled(boolean messageTimestampEnabled)
void	setMetadataJmsOperations(JmsOperations metadataJmsOperations)
void	setPreserveMessageQos(boolean preserveMessageQos)
void	setPriority(int priority)
void	setProviderMetadata(JmsProviderMetadata providerMetadata)
void	setPubSubNoLocal(boolean pubSubNoLocal)
void	setReceiveTimeout(long receiveTimeout)
void	setRecoveryInterval(long recoveryInterval)
void	setReplyTo(String replyToDestination)
void	setReplyToDeliveryPersistent(boolean replyToDeliveryPersistent)
void	setReplyToDestinationSelectorName(String replyToDestinationSelectorName)
void	setReplyToTempDestinationAffinity(String replyToTempDestinationAffinity)
void	setRequestMapPurgePollTimeMillis(long requestMapPurgePollTimeMillis)
void	setRequestor(Requestor requestor)
void	setRequestTimeout(long requestTimeout)
void	setSelector(String selector) Sets the JMS selector to use
void	setSubscriptionDurable(boolean subscriptionDurable)
void	setTaskExecutor(TaskExecutor taskExecutor)
void	setTemplateConnectionFactory(ConnectionFactory templateConnectionFactory)
void	setTimeToLive(long timeToLive)
void	setTransacted(boolean consumerTransacted)
void	setTransactedInOut(boolean transactedInOut)
void	setTransactionManager(PlatformTransactionManager transactionManager)
void	setTransactionName(String transactionName)
void	setTransactionTimeout(int transactionTimeout)
void	setTransferException(boolean transferException)
void	setTransferExchange(boolean transferExchange)
void	setUseMessageIDAsCorrelationID(boolean useMessageIDAsCorrelationID)
void	setUseVersion102(boolean useVersion102)

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

configureProperties, convertTo, createExchange, createExchange, createScheduledExecutorService, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExchangePattern, getExchangeType, getExecutorService, getScheduledExecutorService, hashCode, isLenientProperties, setCamelContext, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, setExecutorService, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JmsEndpoint

public JmsEndpoint()

JmsEndpoint

public JmsEndpoint(Topic destination)
            throws JMSException

Throws:

JMSException

JmsEndpoint

public JmsEndpoint(String uri,
                   JmsComponent component,
                   String destinationName,
                   boolean pubSubDomain,
                   JmsConfiguration configuration)

JmsEndpoint

public JmsEndpoint(String endpointUri,
                   JmsBinding binding,
                   JmsConfiguration configuration,
                   String destinationName,
                   boolean pubSubDomain)

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

newInstance

public static JmsEndpoint newInstance(Destination destination,
                                      JmsComponent component)
                               throws JMSException

Returns a new JMS endpoint for the given JMS destination using the configuration from the given JMS component

Throws:

JMSException

newInstance

public static JmsEndpoint newInstance(Destination destination)
                               throws JMSException

Returns a new JMS endpoint for the given JMS destination

Throws:

JMSException

createProducer

public JmsProducer createProducer()
                           throws Exception

Specified by:

createProducer in interface Endpoint

Throws:

Exception

createProducer

public JmsProducer createProducer(JmsOperations template)
                           throws Exception

Creates a producer using the given template for InOnly message exchanges

Throws:

Exception

createConsumer

public JmsConsumer createConsumer(Processor processor)
                           throws Exception

Specified by:

createConsumer in interface Endpoint

Throws:

Exception

createConsumer

public JmsConsumer createConsumer(Processor processor,
                                  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 PollingConsumer createPollingConsumer()
                                      throws Exception

Specified by:

createPollingConsumer in interface Endpoint

Overrides:

createPollingConsumer in class DefaultEndpoint

Throws:

Exception

createExchange

public Exchange createExchange(ExchangePattern pattern)

Specified by:

createExchange in interface Endpoint

Overrides:

createExchange in class DefaultEndpoint

createExchange

public Exchange createExchange(Message message)

createInOnlyTemplate

public JmsOperations createInOnlyTemplate()

Factory method for creating a new template for InOnly message exchanges

createInOutTemplate

public JmsOperations createInOutTemplate()

Factory method for creating a new template for InOut message exchanges

getHeaderFilterStrategy

public HeaderFilterStrategy getHeaderFilterStrategy()

Specified by:

getHeaderFilterStrategy in interface HeaderFilterStrategyAware

setHeaderFilterStrategy

public void setHeaderFilterStrategy(HeaderFilterStrategy strategy)

Specified by:

setHeaderFilterStrategy in interface HeaderFilterStrategyAware

getBinding

public JmsBinding getBinding()

setBinding

public void setBinding(JmsBinding binding)

Sets the binding used to convert from a Camel message to and from a JMS message

Parameters:

binding - the binding to use

getDestinationName

public String getDestinationName()

setDestinationName

public void setDestinationName(String destinationName)

getDestination

public Destination getDestination()

setDestination

public void setDestination(Destination destination)

Allows a specific JMS Destination object to be used as the destination

getConfiguration

public JmsConfiguration getConfiguration()

setConfiguration

public void setConfiguration(JmsConfiguration configuration)

getSelector

public String getSelector()

setSelector

public void setSelector(String selector)

Sets the JMS selector to use

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface IsSingleton

getRequestor

public Requestor getRequestor()
                       throws Exception

Throws:

Exception

setRequestor

public void setRequestor(Requestor requestor)

isPubSubDomain

public boolean isPubSubDomain()

getTemporaryQueueType

public Class<? extends TemporaryQueue> getTemporaryQueueType()

Lazily loads the temporary queue type if one has not been explicitly configured via calling the JmsProviderMetadata.setTemporaryQueueType(Class) on the getConfiguration() instance

getTemporaryTopicType

public Class<? extends TemporaryTopic> getTemporaryTopicType()

Lazily loads the temporary topic type if one has not been explicitly configured via calling the JmsProviderMetadata.setTemporaryTopicType(Class) on the getConfiguration() instance

getProviderMetadata

protected JmsProviderMetadata getProviderMetadata()

Returns the provider metadata

getMetadataJmsOperations

protected JmsOperations getMetadataJmsOperations()

Returns the JmsOperations used for metadata operations such as creating temporary destinations

checkValidTemplate

public void checkValidTemplate(JmsTemplate template)

getAcknowledgementMode

public int getAcknowledgementMode()

getAcknowledgementModeName

public String getAcknowledgementModeName()

getCacheLevel

public int getCacheLevel()

getCacheLevelName

public String getCacheLevelName()

getClientId

public String getClientId()

getConcurrentConsumers

public int getConcurrentConsumers()

getConnectionFactory

public ConnectionFactory getConnectionFactory()

getConsumerType

public ConsumerType getConsumerType()

getDestinationResolver

public DestinationResolver getDestinationResolver()

getDurableSubscriptionName

public String getDurableSubscriptionName()

getExceptionListener

public ExceptionListener getExceptionListener()

getIdleTaskExecutionLimit

public int getIdleTaskExecutionLimit()

getJmsOperations

public JmsOperations getJmsOperations()

getListenerConnectionFactory

public ConnectionFactory getListenerConnectionFactory()

getMaxConcurrentConsumers

public int getMaxConcurrentConsumers()

getMaxMessagesPerTask

public int getMaxMessagesPerTask()

getMessageConverter

public MessageConverter getMessageConverter()

getMetadataJmsOperations

public JmsOperations getMetadataJmsOperations(JmsEndpoint endpoint)

getPriority

public int getPriority()

getReceiveTimeout

public long getReceiveTimeout()

getRecoveryInterval

public long getRecoveryInterval()

getReplyTo

public String getReplyTo()

getReplyToDestinationSelectorName

public String getReplyToDestinationSelectorName()

getReplyToTempDestinationAffinity

public String getReplyToTempDestinationAffinity()

getRequestMapPurgePollTimeMillis

public long getRequestMapPurgePollTimeMillis()

getRequestTimeout

public long getRequestTimeout()

getTaskExecutor

public TaskExecutor getTaskExecutor()

getTemplateConnectionFactory

public ConnectionFactory getTemplateConnectionFactory()

getTimeToLive

public long getTimeToLive()

getTransactionManager

public PlatformTransactionManager getTransactionManager()

getTransactionName

public String getTransactionName()

getTransactionTimeout

public int getTransactionTimeout()

isAcceptMessagesWhileStopping

public boolean isAcceptMessagesWhileStopping()

isAlwaysCopyMessage

public boolean isAlwaysCopyMessage()

isAutoStartup

public boolean isAutoStartup()

isDeliveryPersistent

public boolean isDeliveryPersistent()

isDisableReplyTo

public boolean isDisableReplyTo()

isEagerLoadingOfProperties

public boolean isEagerLoadingOfProperties()

isExplicitQosEnabled

public boolean isExplicitQosEnabled()

isExposeListenerSession

public boolean isExposeListenerSession()

isMessageIdEnabled

public boolean isMessageIdEnabled()

isMessageTimestampEnabled

public boolean isMessageTimestampEnabled()

isPreserveMessageQos

public boolean isPreserveMessageQos()

isPubSubNoLocal

public boolean isPubSubNoLocal()

isReplyToDeliveryPersistent

public boolean isReplyToDeliveryPersistent()

isSubscriptionDurable

public boolean isSubscriptionDurable()

isTransacted

public boolean isTransacted()

isTransactedInOut

public boolean isTransactedInOut()

isUseMessageIDAsCorrelationID

public boolean isUseMessageIDAsCorrelationID()

isUseVersion102

public boolean isUseVersion102()

setAcceptMessagesWhileStopping

public void setAcceptMessagesWhileStopping(boolean acceptMessagesWhileStopping)

setAcknowledgementMode

public void setAcknowledgementMode(int consumerAcknowledgementMode)

setAcknowledgementModeName

public void setAcknowledgementModeName(String consumerAcknowledgementMode)

setAlwaysCopyMessage

public void setAlwaysCopyMessage(boolean alwaysCopyMessage)

setAutoStartup

public void setAutoStartup(boolean autoStartup)

setCacheLevel

public void setCacheLevel(int cacheLevel)

setCacheLevelName

public void setCacheLevelName(String cacheName)

setClientId

public void setClientId(String consumerClientId)

setConcurrentConsumers

public void setConcurrentConsumers(int concurrentConsumers)

setConnectionFactory

public void setConnectionFactory(ConnectionFactory connectionFactory)

setConsumerType

public void setConsumerType(ConsumerType consumerType)

setDeliveryPersistent

public void setDeliveryPersistent(boolean deliveryPersistent)

setDestinationResolver

public void setDestinationResolver(DestinationResolver destinationResolver)

setDisableReplyTo

public void setDisableReplyTo(boolean disableReplyTo)

setDurableSubscriptionName

public void setDurableSubscriptionName(String durableSubscriptionName)

setEagerLoadingOfProperties

public void setEagerLoadingOfProperties(boolean eagerLoadingOfProperties)

setExceptionListener

public void setExceptionListener(ExceptionListener exceptionListener)

setExplicitQosEnabled

public void setExplicitQosEnabled(boolean explicitQosEnabled)

setExposeListenerSession

public void setExposeListenerSession(boolean exposeListenerSession)

setIdleTaskExecutionLimit

public void setIdleTaskExecutionLimit(int idleTaskExecutionLimit)

setJmsOperations

public void setJmsOperations(JmsOperations jmsOperations)

setListenerConnectionFactory

public void setListenerConnectionFactory(ConnectionFactory listenerConnectionFactory)

setMaxConcurrentConsumers

public void setMaxConcurrentConsumers(int maxConcurrentConsumers)

setMaxMessagesPerTask

public void setMaxMessagesPerTask(int maxMessagesPerTask)

setMessageConverter

public void setMessageConverter(MessageConverter messageConverter)

setMessageIdEnabled

public void setMessageIdEnabled(boolean messageIdEnabled)

setMessageTimestampEnabled

public void setMessageTimestampEnabled(boolean messageTimestampEnabled)

setMetadataJmsOperations

public void setMetadataJmsOperations(JmsOperations metadataJmsOperations)

setPreserveMessageQos

public void setPreserveMessageQos(boolean preserveMessageQos)

setPriority

public void setPriority(int priority)

setProviderMetadata

public void setProviderMetadata(JmsProviderMetadata providerMetadata)

setPubSubNoLocal

public void setPubSubNoLocal(boolean pubSubNoLocal)

setReceiveTimeout

public void setReceiveTimeout(long receiveTimeout)

setRecoveryInterval

public void setRecoveryInterval(long recoveryInterval)

setReplyTo

public void setReplyTo(String replyToDestination)

setReplyToDeliveryPersistent

public void setReplyToDeliveryPersistent(boolean replyToDeliveryPersistent)

setReplyToDestinationSelectorName

public void setReplyToDestinationSelectorName(String replyToDestinationSelectorName)

setReplyToTempDestinationAffinity

public void setReplyToTempDestinationAffinity(String replyToTempDestinationAffinity)

setRequestMapPurgePollTimeMillis

public void setRequestMapPurgePollTimeMillis(long requestMapPurgePollTimeMillis)

setRequestTimeout

public void setRequestTimeout(long requestTimeout)

setSubscriptionDurable

public void setSubscriptionDurable(boolean subscriptionDurable)

setTaskExecutor

public void setTaskExecutor(TaskExecutor taskExecutor)

setTemplateConnectionFactory

public void setTemplateConnectionFactory(ConnectionFactory templateConnectionFactory)

setTimeToLive

public void setTimeToLive(long timeToLive)

setTransacted

public void setTransacted(boolean consumerTransacted)

setTransactedInOut

public void setTransactedInOut(boolean transactedInOut)

setTransactionManager

public void setTransactionManager(PlatformTransactionManager transactionManager)

setTransactionName

public void setTransactionName(String transactionName)

setTransactionTimeout

public void setTransactionTimeout(int transactionTimeout)

setUseMessageIDAsCorrelationID

public void setUseMessageIDAsCorrelationID(boolean useMessageIDAsCorrelationID)

setUseVersion102

public void setUseVersion102(boolean useVersion102)

getJmsMessageType

public JmsMessageType getJmsMessageType()

setJmsMessageType

public void setJmsMessageType(JmsMessageType jmsMessageType)

getJmsKeyFormatStrategy

public JmsKeyFormatStrategy getJmsKeyFormatStrategy()

setJmsKeyFormatStrategy

public void setJmsKeyFormatStrategy(JmsKeyFormatStrategy jmsHeaderStrategy)

isTransferExchange

public boolean isTransferExchange()

setTransferExchange

public void setTransferExchange(boolean transferExchange)

isTransferException

public boolean isTransferException()

setTransferException

public void setTransferException(boolean transferException)

createEndpointUri

protected String createEndpointUri()

Overrides:

createEndpointUri in class DefaultEndpoint