org.apache.camel.component.sjms

Class SjmsEndpoint

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.apache.camel.component.sjms.SjmsEndpoint

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

@UriEndpoint(firstVersion="2.11.0",
             scheme="sjms",
             title="Simple JMS",
             syntax="sjms:destinationType:destinationName",
             category=MESSAGING)
public class SjmsEndpoint
extends org.apache.camel.support.DefaultEndpoint
implements org.apache.camel.AsyncEndpoint, org.apache.camel.MultipleConsumersSupport, org.apache.camel.spi.HeaderFilterStrategyAware

Send and receive messages to/from a JMS Queue or Topic using plain JMS 1.x API. This component uses plain JMS API where as the jms component uses Spring JMS.

Field Summary

Fields inherited from class org.apache.camel.support.service.BaseService

BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
SjmsEndpoint()
SjmsEndpoint(String uri, org.apache.camel.Component component, String remaining)

Method Summary

Modifier and Type	Method and Description
protected void	configuredQoS() When one of the QoS properties are configured such as setDeliveryPersistent(boolean), setPriority(int) or setTimeToLive(long) then we should auto default the setting of setExplicitQosEnabled(Boolean) if its not been configured yet
void	configureMessageListener(EndpointMessageListener listener)
protected JmsBinding	createBinding() Creates the JmsBinding to use.
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Exchange	createExchange(javax.jms.Message message, javax.jms.Session session)
SjmsTemplate	createInOnlyTemplate() Factory method for creating a new template for InOnly message exchanges
SjmsTemplate	createInOutTemplate() Factory method for creating a new template for InOut message exchanges
MessageListenerContainer	createMessageListenerContainer(SjmsEndpoint endpoint)
org.apache.camel.PollingConsumer	createPollingConsumer()
org.apache.camel.Producer	createProducer()
protected void	doInit()
SessionAcknowledgementType	getAcknowledgementMode()
protected ExecutorService	getAsyncStartStopExecutorService()
JmsBinding	getBinding()
String	getClientId()
SjmsComponent	getComponent()
int	getConcurrentConsumers()
javax.jms.ConnectionFactory	getConnectionFactory()
Integer	getDeliveryMode()
DestinationCreationStrategy	getDestinationCreationStrategy()
String	getDestinationName()
String	getDurableSubscriptionName()
String	getEagerPoisonBody()
String	getEndpointConfiguredDestinationName() Gets the destination name which was configured from the endpoint uri.
javax.jms.ExceptionListener	getExceptionListener()
Boolean	getExplicitQosEnabled()
org.apache.camel.spi.HeaderFilterStrategy	getHeaderFilterStrategy()
JmsKeyFormatStrategy	getJmsKeyFormatStrategy()
JmsObjectFactory	getJmsObjectFactory()
MessageCreatedStrategy	getMessageCreatedStrategy()
String	getMessageSelector()
int	getPriority()
long	getRecoveryInterval()
String	getReplyTo()
int	getReplyToConcurrentConsumers()
String	getReplyToOverride()
ReplyToType	getReplyToType()
long	getRequestTimeout()
long	getTimeToLive()
boolean	isAllowNullBody()
boolean	isAsyncConsumer()
boolean	isAsyncStartListener()
boolean	isAsyncStopListener()
boolean	isAutoStartup()
boolean	isDeliveryPersistent()
boolean	isDisableReplyTo()
boolean	isDisableTimeToLive()
boolean	isEagerLoadingOfProperties()
boolean	isExplicitQosEnabled()
boolean	isIncludeAllJMSXProperties()
boolean	isMapJmsMessage()
boolean	isMultipleConsumersSupported()
boolean	isPreserveMessageQos()
boolean	isReplyToDeliveryPersistent()
boolean	isReplyToSameDestinationAllowed()
boolean	isSynchronous()
boolean	isTestConnectionOnStartup()
boolean	isTopic()
boolean	isTransacted()
boolean	isTransferException()
void	setAcknowledgementMode(SessionAcknowledgementType acknowledgementMode)
void	setAllowNullBody(boolean allowNullBody)
void	setAsyncConsumer(boolean asyncConsumer)
void	setAsyncStartListener(boolean asyncStartListener)
void	setAsyncStopListener(boolean asyncStopListener)
void	setAutoStartup(boolean autoStartup)
void	setBinding(JmsBinding binding)
void	setClientId(String clientId)
void	setConcurrentConsumers(int concurrentConsumers)
void	setConnectionFactory(javax.jms.ConnectionFactory connectionFactory)
void	setDeliveryMode(Integer deliveryMode)
void	setDeliveryPersistent(boolean deliveryPersistent)
void	setDestinationCreationStrategy(DestinationCreationStrategy destinationCreationStrategy)
void	setDestinationName(String destinationName)
void	setDisableReplyTo(boolean disableReplyTo)
void	setDisableTimeToLive(boolean disableTimeToLive)
void	setDurableSubscriptionName(String durableSubscriptionName)
void	setEagerLoadingOfProperties(boolean eagerLoadingOfProperties)
void	setEagerPoisonBody(String eagerPoisonBody)
void	setExceptionListener(javax.jms.ExceptionListener exceptionListener)
void	setExplicitQosEnabled(Boolean explicitQosEnabled)
void	setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy strategy)
void	setIncludeAllJMSXProperties(boolean includeAllJMSXProperties)
void	setJmsKeyFormatStrategy(JmsKeyFormatStrategy jmsKeyFormatStrategy)
void	setJmsObjectFactory(JmsObjectFactory jmsObjectFactory)
void	setMapJmsMessage(boolean mapJmsMessage)
void	setMessageCreatedStrategy(MessageCreatedStrategy messageCreatedStrategy)
void	setMessageSelector(String messageSelector)
void	setPreserveMessageQos(boolean preserveMessageQos)
void	setPriority(int priority)
void	setRecoveryInterval(long recoveryInterval)
void	setReplyTo(String replyTo)
void	setReplyToConcurrentConsumers(int replyToConcurrentConsumers)
void	setReplyToDeliveryPersistent(boolean replyToDeliveryPersistent)
void	setReplyToOverride(String replyToOverride)
void	setReplyToSameDestinationAllowed(boolean replyToSameDestinationAllowed)
void	setReplyToType(ReplyToType replyToType)
void	setRequestTimeout(long requestTimeout)
void	setSynchronous(boolean synchronous)
void	setTestConnectionOnStartup(boolean testConnectionOnStartup)
void	setTimeToLive(long timeToLive)
void	setTransacted(boolean transacted)
void	setTransferException(boolean transferException)

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

configureConsumer, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, doStart, doStop, equals, getCamelContext, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, toString

Methods inherited from class org.apache.camel.support.service.BaseService

build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.Endpoint

configureProperties, createAsyncProducer, createExchange, createExchange, getCamelContext, getEndpointBaseUri, getEndpointKey, getEndpointUri, isLenientProperties, isSingletonProducer, setCamelContext

Methods inherited from interface org.apache.camel.IsSingleton

isSingleton, test

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.CamelContextAware

trySetCamelContext

Methods inherited from interface org.apache.camel.StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Constructor Detail

SjmsEndpoint

public SjmsEndpoint()

SjmsEndpoint

public SjmsEndpoint(String uri,
                    org.apache.camel.Component component,
                    String remaining)

Method Detail

getComponent

public SjmsComponent getComponent()

Overrides:

getComponent in class org.apache.camel.support.DefaultEndpoint

doInit

protected void doInit()
               throws Exception

Overrides:

doInit in class org.apache.camel.support.DefaultEndpoint

Throws:

Exception

getEndpointConfiguredDestinationName

public String getEndpointConfiguredDestinationName()

Gets the destination name which was configured from the endpoint uri.

Returns:

the destination name resolved from the endpoint uri

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Specified by:

createProducer in interface org.apache.camel.Endpoint

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Specified by:

createConsumer in interface org.apache.camel.Endpoint

Throws:

Exception

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

configureMessageListener

public void configureMessageListener(EndpointMessageListener listener)

isMultipleConsumersSupported

public boolean isMultipleConsumersSupported()

Specified by:

isMultipleConsumersSupported in interface org.apache.camel.MultipleConsumersSupport

createExchange

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

createInOnlyTemplate

public SjmsTemplate createInOnlyTemplate()

Factory method for creating a new template for InOnly message exchanges

createInOutTemplate

public SjmsTemplate createInOutTemplate()

Factory method for creating a new template for InOut message exchanges

createMessageListenerContainer

public MessageListenerContainer createMessageListenerContainer(SjmsEndpoint endpoint)
                                                        throws Exception

Throws:

Exception

configuredQoS

protected void configuredQoS()

When one of the QoS properties are configured such as setDeliveryPersistent(boolean), setPriority(int) or setTimeToLive(long) then we should auto default the setting of setExplicitQosEnabled(Boolean) if its not been configured yet

isPreserveMessageQos

public boolean isPreserveMessageQos()

setPreserveMessageQos

public void setPreserveMessageQos(boolean preserveMessageQos)

getBinding

public JmsBinding getBinding()

createBinding

protected JmsBinding createBinding()

Creates the JmsBinding to use.

setBinding

public void setBinding(JmsBinding binding)

getAsyncStartStopExecutorService

protected ExecutorService getAsyncStartStopExecutorService()

setDestinationName

public void setDestinationName(String destinationName)

getDestinationName

public String getDestinationName()

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)

Specified by:

setHeaderFilterStrategy in interface org.apache.camel.spi.HeaderFilterStrategyAware

isIncludeAllJMSXProperties

public boolean isIncludeAllJMSXProperties()

setIncludeAllJMSXProperties

public void setIncludeAllJMSXProperties(boolean includeAllJMSXProperties)

getAcknowledgementMode

public SessionAcknowledgementType getAcknowledgementMode()

setAcknowledgementMode

public void setAcknowledgementMode(SessionAcknowledgementType acknowledgementMode)

isTopic

public boolean isTopic()

getConcurrentConsumers

public int getConcurrentConsumers()

setConcurrentConsumers

public void setConcurrentConsumers(int concurrentConsumers)

getReplyToConcurrentConsumers

public int getReplyToConcurrentConsumers()

setReplyToConcurrentConsumers

public void setReplyToConcurrentConsumers(int replyToConcurrentConsumers)

getExplicitQosEnabled

public Boolean getExplicitQosEnabled()

setExplicitQosEnabled

public void setExplicitQosEnabled(Boolean explicitQosEnabled)

isExplicitQosEnabled

public boolean isExplicitQosEnabled()

getPriority

public int getPriority()

setPriority

public void setPriority(int priority)

isDeliveryPersistent

public boolean isDeliveryPersistent()

setDeliveryPersistent

public void setDeliveryPersistent(boolean deliveryPersistent)

isDisableReplyTo

public boolean isDisableReplyTo()

setDisableReplyTo

public void setDisableReplyTo(boolean disableReplyTo)

getReplyToOverride

public String getReplyToOverride()

setReplyToOverride

public void setReplyToOverride(String replyToOverride)

isReplyToDeliveryPersistent

public boolean isReplyToDeliveryPersistent()

setReplyToDeliveryPersistent

public void setReplyToDeliveryPersistent(boolean replyToDeliveryPersistent)

getEagerPoisonBody

public String getEagerPoisonBody()

isEagerLoadingOfProperties

public boolean isEagerLoadingOfProperties()

setEagerLoadingOfProperties

public void setEagerLoadingOfProperties(boolean eagerLoadingOfProperties)

setEagerPoisonBody

public void setEagerPoisonBody(String eagerPoisonBody)

getDeliveryMode

public Integer getDeliveryMode()

setDeliveryMode

public void setDeliveryMode(Integer deliveryMode)

getTimeToLive

public long getTimeToLive()

setTimeToLive

public void setTimeToLive(long timeToLive)

getClientId

public String getClientId()

setClientId

public void setClientId(String clientId)

getDurableSubscriptionName

public String getDurableSubscriptionName()

setDurableSubscriptionName

public void setDurableSubscriptionName(String durableSubscriptionName)

getRequestTimeout

public long getRequestTimeout()

setRequestTimeout

public void setRequestTimeout(long requestTimeout)

getMessageSelector

public String getMessageSelector()

setMessageSelector

public void setMessageSelector(String messageSelector)

isTransacted

public boolean isTransacted()

setTransacted

public void setTransacted(boolean transacted)

getReplyTo

public String getReplyTo()

setReplyTo

public void setReplyTo(String replyTo)

getReplyToType

public ReplyToType getReplyToType()

setReplyToType

public void setReplyToType(ReplyToType replyToType)

isTestConnectionOnStartup

public boolean isTestConnectionOnStartup()

setTestConnectionOnStartup

public void setTestConnectionOnStartup(boolean testConnectionOnStartup)

setAsyncStartListener

public void setAsyncStartListener(boolean asyncStartListener)

setAsyncStopListener

public void setAsyncStopListener(boolean asyncStopListener)

isAsyncStartListener

public boolean isAsyncStartListener()

isAsyncStopListener

public boolean isAsyncStopListener()

isAutoStartup

public boolean isAutoStartup()

setAutoStartup

public void setAutoStartup(boolean autoStartup)

getDestinationCreationStrategy

public DestinationCreationStrategy getDestinationCreationStrategy()

setDestinationCreationStrategy

public void setDestinationCreationStrategy(DestinationCreationStrategy destinationCreationStrategy)

isReplyToSameDestinationAllowed

public boolean isReplyToSameDestinationAllowed()

setReplyToSameDestinationAllowed

public void setReplyToSameDestinationAllowed(boolean replyToSameDestinationAllowed)

isAllowNullBody

public boolean isAllowNullBody()

setAllowNullBody

public void setAllowNullBody(boolean allowNullBody)

isMapJmsMessage

public boolean isMapJmsMessage()

setMapJmsMessage

public void setMapJmsMessage(boolean mapJmsMessage)

getMessageCreatedStrategy

public MessageCreatedStrategy getMessageCreatedStrategy()

setMessageCreatedStrategy

public void setMessageCreatedStrategy(MessageCreatedStrategy messageCreatedStrategy)

getJmsKeyFormatStrategy

public JmsKeyFormatStrategy getJmsKeyFormatStrategy()

setJmsKeyFormatStrategy

public void setJmsKeyFormatStrategy(JmsKeyFormatStrategy jmsKeyFormatStrategy)

getConnectionFactory

public javax.jms.ConnectionFactory getConnectionFactory()

setConnectionFactory

public void setConnectionFactory(javax.jms.ConnectionFactory connectionFactory)

getExceptionListener

public javax.jms.ExceptionListener getExceptionListener()

setExceptionListener

public void setExceptionListener(javax.jms.ExceptionListener exceptionListener)

getJmsObjectFactory

public JmsObjectFactory getJmsObjectFactory()

setJmsObjectFactory

public void setJmsObjectFactory(JmsObjectFactory jmsObjectFactory)

isTransferException

public boolean isTransferException()

setTransferException

public void setTransferException(boolean transferException)

isDisableTimeToLive

public boolean isDisableTimeToLive()

setDisableTimeToLive

public void setDisableTimeToLive(boolean disableTimeToLive)

getRecoveryInterval

public long getRecoveryInterval()

setRecoveryInterval

public void setRecoveryInterval(long recoveryInterval)

isAsyncConsumer

public boolean isAsyncConsumer()

setAsyncConsumer

public void setAsyncConsumer(boolean asyncConsumer)

isSynchronous

public boolean isSynchronous()

setSynchronous

public void setSynchronous(boolean synchronous)