Package 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.ComponentAware,org.apache.camel.Endpoint,org.apache.camel.IsSingleton,org.apache.camel.MultipleConsumersSupport,org.apache.camel.Service,org.apache.camel.ShutdownableService,org.apache.camel.spi.HasCamelContext,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,
headersClass=SjmsConstants.class)
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, whereas 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
ConstructorsConstructorDescriptionSjmsEndpoint(String uri, org.apache.camel.Component component, String remaining) -
Method Summary
Modifier and TypeMethodDescriptionprotected voidWhen one of the QoS properties are configured such assetDeliveryPersistent(boolean),setPriority(int)orsetTimeToLive(long)then we should auto default the setting ofsetExplicitQosEnabled(Boolean)if it has not been configured yetvoidprotected JmsBindingCreates theJmsBindingto use.org.apache.camel.ConsumercreateConsumer(org.apache.camel.Processor processor) org.apache.camel.ExchangecreateExchange(jakarta.jms.Message message, jakarta.jms.Session session) Factory method for creating a new template for InOnly message exchangesFactory method for creating a new template for InOut message exchangescreateMessageListenerContainer(SjmsEndpoint endpoint) org.apache.camel.PollingConsumerorg.apache.camel.Producerprotected voiddoInit()protected ExecutorServiceintjakarta.jms.ConnectionFactoryGets the destination name which was configured from the endpoint uri.jakarta.jms.ExceptionListenerorg.apache.camel.spi.HeaderFilterStrategyintlongintlonglongbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisTopic()booleanbooleanvoidsetAcknowledgementMode(SessionAcknowledgementType acknowledgementMode) voidsetAllowNullBody(boolean allowNullBody) voidsetAsyncConsumer(boolean asyncConsumer) voidsetAsyncStartListener(boolean asyncStartListener) voidsetAsyncStopListener(boolean asyncStopListener) voidsetAutoStartup(boolean autoStartup) voidsetBinding(JmsBinding binding) voidsetClientId(String clientId) voidsetConcurrentConsumers(int concurrentConsumers) voidsetConnectionFactory(jakarta.jms.ConnectionFactory connectionFactory) voidsetDeliveryMode(Integer deliveryMode) voidsetDeliveryPersistent(boolean deliveryPersistent) voidsetDestinationCreationStrategy(DestinationCreationStrategy destinationCreationStrategy) voidsetDestinationName(String destinationName) voidsetDisableReplyTo(boolean disableReplyTo) voidsetDisableTimeToLive(boolean disableTimeToLive) voidsetDurableSubscriptionName(String durableSubscriptionName) voidsetEagerLoadingOfProperties(boolean eagerLoadingOfProperties) voidsetEagerPoisonBody(String eagerPoisonBody) voidsetExceptionListener(jakarta.jms.ExceptionListener exceptionListener) voidsetExplicitQosEnabled(Boolean explicitQosEnabled) voidsetHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy strategy) voidsetIncludeAllJMSXProperties(boolean includeAllJMSXProperties) voidsetJmsKeyFormatStrategy(JmsKeyFormatStrategy jmsKeyFormatStrategy) voidsetJmsMessageType(JmsMessageType jmsMessageType) Allows you to force the use of a specific jakarta.jms.Message implementation for sending JMS messages.voidsetJmsObjectFactory(JmsObjectFactory jmsObjectFactory) voidsetMapJmsMessage(boolean mapJmsMessage) voidsetMessageCreatedStrategy(MessageCreatedStrategy messageCreatedStrategy) voidsetMessageSelector(String messageSelector) voidsetPreserveMessageQos(boolean preserveMessageQos) voidsetPriority(int priority) voidsetRecoveryInterval(long recoveryInterval) voidsetReplyTo(String replyTo) voidsetReplyToConcurrentConsumers(int replyToConcurrentConsumers) voidsetReplyToDeliveryPersistent(boolean replyToDeliveryPersistent) voidsetReplyToOverride(String replyToOverride) voidsetReplyToSameDestinationAllowed(boolean replyToSameDestinationAllowed) voidsetReplyToType(ReplyToType replyToType) voidsetRequestTimeout(long requestTimeout) voidsetSynchronous(boolean synchronous) voidsetTestConnectionOnStartup(boolean testConnectionOnStartup) voidsetTimeToLive(long timeToLive) voidsetTransacted(boolean transacted) voidsetTransferException(boolean transferException) protected booleanShould get overridden by implementations which support BlobMessagesMethods inherited from class org.apache.camel.support.DefaultEndpoint
configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, equals, getCamelContext, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toStringMethods inherited from class org.apache.camel.support.service.BaseService
build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doStart, doStop, doSuspend, fail, getInternalLock, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspendMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.camel.ComponentAware
getComponent, setComponentMethods inherited from interface org.apache.camel.Endpoint
configureExchange, configureProperties, createAsyncProducer, createExchange, createExchange, getCamelContext, getEndpointBaseUri, getEndpointKey, getEndpointUri, getExchangePattern, isLenientProperties, isRemote, isSingletonProducer, setCamelContextMethods inherited from interface org.apache.camel.IsSingleton
isSingletonMethods inherited from interface org.apache.camel.Service
build, close, init, start, stopMethods inherited from interface org.apache.camel.ShutdownableService
shutdownMethods inherited from interface org.apache.camel.StatefulService
getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspendingMethods inherited from interface org.apache.camel.SuspendableService
isSuspended, resume, suspend
-
Constructor Details
-
SjmsEndpoint
public SjmsEndpoint() -
SjmsEndpoint
-
-
Method Details
-
getComponent
- Specified by:
getComponentin interfaceorg.apache.camel.ComponentAware- Overrides:
getComponentin classorg.apache.camel.support.DefaultEndpoint
-
doInit
- Overrides:
doInitin classorg.apache.camel.support.DefaultEndpoint- Throws:
Exception
-
supportBlobMessage
protected boolean supportBlobMessage()Should get overridden by implementations which support BlobMessages- Returns:
- false
-
getEndpointConfiguredDestinationName
Gets the destination name which was configured from the endpoint uri.- Returns:
- the destination name resolved from the endpoint uri
-
createProducer
- Specified by:
createProducerin interfaceorg.apache.camel.Endpoint- Throws:
Exception
-
createConsumer
public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor) throws Exception - Specified by:
createConsumerin interfaceorg.apache.camel.Endpoint- Throws:
Exception
-
createPollingConsumer
- Specified by:
createPollingConsumerin interfaceorg.apache.camel.Endpoint- Overrides:
createPollingConsumerin classorg.apache.camel.support.DefaultEndpoint- Throws:
Exception
-
configureMessageListener
-
isMultipleConsumersSupported
public boolean isMultipleConsumersSupported()- Specified by:
isMultipleConsumersSupportedin interfaceorg.apache.camel.MultipleConsumersSupport
-
createExchange
public org.apache.camel.Exchange createExchange(jakarta.jms.Message message, jakarta.jms.Session session) -
createInOnlyTemplate
Factory method for creating a new template for InOnly message exchanges -
createInOutTemplate
Factory method for creating a new template for InOut message exchanges -
createMessageListenerContainer
-
configuredQoS
protected void configuredQoS()When one of the QoS properties are configured such assetDeliveryPersistent(boolean),setPriority(int)orsetTimeToLive(long)then we should auto default the setting ofsetExplicitQosEnabled(Boolean)if it has not been configured yet -
isPreserveMessageQos
public boolean isPreserveMessageQos() -
setPreserveMessageQos
public void setPreserveMessageQos(boolean preserveMessageQos) -
getBinding
-
createBinding
Creates theJmsBindingto use. -
setBinding
-
getAsyncStartStopExecutorService
-
setDestinationName
-
getDestinationName
-
getHeaderFilterStrategy
public org.apache.camel.spi.HeaderFilterStrategy getHeaderFilterStrategy()- Specified by:
getHeaderFilterStrategyin interfaceorg.apache.camel.spi.HeaderFilterStrategyAware
-
setHeaderFilterStrategy
public void setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy strategy) - Specified by:
setHeaderFilterStrategyin interfaceorg.apache.camel.spi.HeaderFilterStrategyAware
-
isIncludeAllJMSXProperties
public boolean isIncludeAllJMSXProperties() -
setIncludeAllJMSXProperties
public void setIncludeAllJMSXProperties(boolean includeAllJMSXProperties) -
getAcknowledgementMode
-
setAcknowledgementMode
-
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
-
setExplicitQosEnabled
-
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
-
setReplyToOverride
-
isReplyToDeliveryPersistent
public boolean isReplyToDeliveryPersistent() -
setReplyToDeliveryPersistent
public void setReplyToDeliveryPersistent(boolean replyToDeliveryPersistent) -
getEagerPoisonBody
-
isEagerLoadingOfProperties
public boolean isEagerLoadingOfProperties() -
setEagerLoadingOfProperties
public void setEagerLoadingOfProperties(boolean eagerLoadingOfProperties) -
setEagerPoisonBody
-
getDeliveryMode
-
setDeliveryMode
-
getTimeToLive
public long getTimeToLive() -
setTimeToLive
public void setTimeToLive(long timeToLive) -
getClientId
-
setClientId
-
getDurableSubscriptionName
-
setDurableSubscriptionName
-
getRequestTimeout
public long getRequestTimeout() -
setRequestTimeout
public void setRequestTimeout(long requestTimeout) -
getMessageSelector
-
setMessageSelector
-
isTransacted
public boolean isTransacted() -
setTransacted
public void setTransacted(boolean transacted) -
getReplyTo
-
setReplyTo
-
getReplyToType
-
setReplyToType
-
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
-
setDestinationCreationStrategy
-
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
-
setMessageCreatedStrategy
-
getJmsKeyFormatStrategy
-
setJmsKeyFormatStrategy
-
getConnectionFactory
public jakarta.jms.ConnectionFactory getConnectionFactory() -
setConnectionFactory
public void setConnectionFactory(jakarta.jms.ConnectionFactory connectionFactory) -
getExceptionListener
public jakarta.jms.ExceptionListener getExceptionListener() -
setExceptionListener
public void setExceptionListener(jakarta.jms.ExceptionListener exceptionListener) -
getJmsObjectFactory
-
setJmsObjectFactory
-
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) -
getJmsMessageType
-
setJmsMessageType
Allows you to force the use of a specific jakarta.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it.
-