|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.camel.component.jms.JmsConfiguration
public class JmsConfiguration
| Nested Class Summary | |
|---|---|
static class |
JmsConfiguration.CamelJmsTemplate
|
static class |
JmsConfiguration.CamelJmsTemplate102
Deprecated. will be removed in the future |
static interface |
JmsConfiguration.MessageSentCallback
|
| Field Summary | |
|---|---|
protected static String |
AUTO_ACKNOWLEDGE
|
protected static String |
CLIENT_ACKNOWLEDGE
|
protected static String |
DUPS_OK_ACKNOWLEDGE
|
static String |
QUEUE_PREFIX
|
protected static String |
REPLYTO_TEMP_DEST_AFFINITY_PER_COMPONENT
|
protected static String |
REPLYTO_TEMP_DEST_AFFINITY_PER_ENDPOINT
|
protected static String |
REPLYTO_TEMP_DEST_AFFINITY_PER_PRODUCER
|
static String |
TEMP_QUEUE_PREFIX
|
static String |
TEMP_TOPIC_PREFIX
|
static String |
TOPIC_PREFIX
|
protected static String |
TRANSACTED
|
| Constructor Summary | |
|---|---|
JmsConfiguration()
|
|
JmsConfiguration(ConnectionFactory connectionFactory)
|
|
| Method Summary | |
|---|---|
AbstractMessageListenerContainer |
chooseMessageListenerContainerImplementation()
|
void |
configure(EndpointMessageListener listener)
|
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 |
protected void |
configureMessageListenerContainer(AbstractMessageListenerContainer container,
JmsEndpoint endpoint)
|
JmsConfiguration |
copy()
Returns a copy of this configuration |
protected ConnectionFactory |
createConnectionFactory()
Factory method which allows derived classes to customize the lazy creation |
static DestinationResolver |
createDestinationResolver(DestinationEndpoint destinationEndpoint)
|
JmsOperations |
createInOnlyTemplate(JmsEndpoint endpoint,
boolean pubSubDomain,
String destination)
Creates a JmsOperations object used for one way messaging |
JmsOperations |
createInOutTemplate(JmsEndpoint endpoint,
boolean pubSubDomain,
String destination,
long requestTimeout)
Creates a JmsOperations object used for request/response using a request timeout value |
protected ConnectionFactory |
createListenerConnectionFactory()
Factory method which allows derived classes to customize the lazy creation |
AbstractMessageListenerContainer |
createMessageListenerContainer(JmsEndpoint endpoint)
|
protected ConnectionFactory |
createTemplateConnectionFactory()
Factory method which allows derived classes to customize the lazy creation |
protected PlatformTransactionManager |
createTransactionManager()
Factory method which which allows derived classes to customize the lazy transcationManager creation |
protected int |
defaultCacheLevel(JmsEndpoint endpoint)
Defaults the JMS cache level if none is explicitly specified. |
int |
getAcknowledgementMode()
|
String |
getAcknowledgementModeName()
|
int |
getCacheLevel()
|
String |
getCacheLevelName()
|
String |
getClientId()
|
int |
getConcurrentConsumers()
|
ConnectionFactory |
getConnectionFactory()
|
ConsumerType |
getConsumerType()
|
DestinationResolver |
getDestinationResolver()
|
String |
getDurableSubscriptionName()
|
ExceptionListener |
getExceptionListener()
|
int |
getIdleTaskExecutionLimit()
|
JmsKeyFormatStrategy |
getJmsKeyFormatStrategy()
|
JmsMessageType |
getJmsMessageType()
|
JmsOperations |
getJmsOperations()
|
ConnectionFactory |
getListenerConnectionFactory()
|
int |
getMaxConcurrentConsumers()
|
int |
getMaxMessagesPerTask()
|
MessageConverter |
getMessageConverter()
|
JmsOperations |
getMetadataJmsOperations(JmsEndpoint endpoint)
|
int |
getPriority()
|
JmsProviderMetadata |
getProviderMetadata()
|
long |
getReceiveTimeout()
|
long |
getRecoveryInterval()
|
String |
getReplyTo()
|
String |
getReplyToDestinationSelectorName()
|
String |
getReplyToTempDestinationAffinity()
|
long |
getRequestMapPurgePollTimeMillis()
|
long |
getRequestTimeout()
|
TaskExecutor |
getTaskExecutor()
|
ConnectionFactory |
getTemplateConnectionFactory()
|
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 |
isLazyCreateTransactionManager()
|
boolean |
isMapJmsMessage()
|
boolean |
isMessageIdEnabled()
|
boolean |
isMessageTimestampEnabled()
|
boolean |
isPreserveMessageQos()
|
boolean |
isPubSubNoLocal()
|
boolean |
isReplyToDeliveryPersistent()
|
boolean |
isSubscriptionDurable()
|
boolean |
isTestConnectionOnStartup()
|
boolean |
isTransacted()
|
boolean |
isTransactedInOut()
Should InOut operations (request reply) default to using transacted mode? By default this is false as you need to commit the outgoing request before you can consume the input |
boolean |
isTransferException()
|
boolean |
isTransferExchange()
|
boolean |
isUseMessageIDAsCorrelationID()
|
boolean |
isUseVersion102()
Deprecated. will be removed in the future |
void |
setAcceptMessagesWhileStopping(boolean acceptMessagesWhileStopping)
|
void |
setAcknowledgementMode(int consumerAcknowledgementMode)
|
void |
setAcknowledgementModeName(String consumerAcknowledgementMode)
|
void |
setAlwaysCopyMessage(boolean alwaysCopyMessage)
|
void |
setAutoStartup(boolean autoStartup)
|
void |
setCacheLevel(int cacheLevel)
|
void |
setCacheLevelName(String cacheName)
|
void |
setClientId(String consumerClientId)
|
void |
setConcurrentConsumers(int concurrentConsumers)
|
void |
setConnectionFactory(ConnectionFactory connectionFactory)
Sets the default connection factory to be used if a connection factory is not specified for either setTemplateConnectionFactory(ConnectionFactory) or
setListenerConnectionFactory(ConnectionFactory) |
void |
setConsumerType(ConsumerType consumerType)
|
void |
setDeliveryPersistent(boolean deliveryPersistent)
|
void |
setDestinationResolver(DestinationResolver destinationResolver)
|
void |
setDisableReplyTo(boolean disableReplyTo)
Disables the use of the JMSReplyTo header for consumers so that inbound messages are treated as InOnly rather than InOut requests. |
void |
setDurableSubscriptionName(String durableSubscriptionName)
|
void |
setEagerLoadingOfProperties(boolean eagerLoadingOfProperties)
Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties |
void |
setExceptionListener(ExceptionListener exceptionListener)
|
void |
setExplicitQosEnabled(boolean explicitQosEnabled)
|
void |
setExposeListenerSession(boolean exposeListenerSession)
|
void |
setIdleTaskExecutionLimit(int idleTaskExecutionLimit)
|
void |
setJmsKeyFormatStrategy(JmsKeyFormatStrategy jmsKeyFormatStrategy)
|
void |
setJmsMessageType(JmsMessageType jmsMessageType)
|
void |
setJmsOperations(JmsOperations jmsOperations)
|
void |
setLazyCreateTransactionManager(boolean lazyCreating)
|
void |
setListenerConnectionFactory(ConnectionFactory listenerConnectionFactory)
Sets the connection factory to be used for consuming messages via the createMessageListenerContainer(JmsEndpoint) |
void |
setMapJmsMessage(boolean mapJmsMessage)
|
void |
setMaxConcurrentConsumers(int maxConcurrentConsumers)
|
void |
setMaxMessagesPerTask(int maxMessagesPerTask)
|
void |
setMessageConverter(MessageConverter messageConverter)
|
void |
setMessageIdEnabled(boolean messageIdEnabled)
|
void |
setMessageTimestampEnabled(boolean messageTimestampEnabled)
|
void |
setMetadataJmsOperations(JmsOperations metadataJmsOperations)
Sets the JmsOperations used to deduce the JmsProviderMetadata details which if none
is customized one is lazily created on demand |
void |
setPreserveMessageQos(boolean preserveMessageQos)
Set to true if you want to send message using the QoS settings specified on the message. |
void |
setPriority(int priority)
|
void |
setProviderMetadata(JmsProviderMetadata providerMetadata)
Allows the provider metadata to be explicitly configured. |
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)
Sets the frequency that the requestMap for InOut exchanges is purged for timed out message exchanges |
void |
setRequestTimeout(long requestTimeout)
Sets the timeout in milliseconds which requests should timeout after |
void |
setSubscriptionDurable(boolean subscriptionDurable)
|
void |
setTaskExecutor(TaskExecutor taskExecutor)
|
void |
setTemplateConnectionFactory(ConnectionFactory templateConnectionFactory)
Sets the connection factory to be used for sending messages via the JmsTemplate via createInOnlyTemplate(JmsEndpoint,boolean, String) |
void |
setTestConnectionOnStartup(boolean testConnectionOnStartup)
|
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)
Deprecated. will be removed in the future |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String QUEUE_PREFIX
public static final String TOPIC_PREFIX
public static final String TEMP_QUEUE_PREFIX
public static final String TEMP_TOPIC_PREFIX
protected static final String TRANSACTED
protected static final String CLIENT_ACKNOWLEDGE
protected static final String AUTO_ACKNOWLEDGE
protected static final String DUPS_OK_ACKNOWLEDGE
protected static final String REPLYTO_TEMP_DEST_AFFINITY_PER_COMPONENT
protected static final String REPLYTO_TEMP_DEST_AFFINITY_PER_ENDPOINT
protected static final String REPLYTO_TEMP_DEST_AFFINITY_PER_PRODUCER
| Constructor Detail |
|---|
public JmsConfiguration()
public JmsConfiguration(ConnectionFactory connectionFactory)
| Method Detail |
|---|
public JmsConfiguration copy()
public JmsOperations createInOutTemplate(JmsEndpoint endpoint,
boolean pubSubDomain,
String destination,
long requestTimeout)
JmsOperations object used for request/response using a request timeout value
public JmsOperations createInOnlyTemplate(JmsEndpoint endpoint,
boolean pubSubDomain,
String destination)
JmsOperations object used for one way messaging
public AbstractMessageListenerContainer createMessageListenerContainer(JmsEndpoint endpoint)
public ConnectionFactory getConnectionFactory()
public void setConnectionFactory(ConnectionFactory connectionFactory)
setTemplateConnectionFactory(ConnectionFactory) or
setListenerConnectionFactory(ConnectionFactory)
connectionFactory - the default connection factory to usepublic ConnectionFactory getListenerConnectionFactory()
public void setListenerConnectionFactory(ConnectionFactory listenerConnectionFactory)
createMessageListenerContainer(JmsEndpoint)
listenerConnectionFactory - the connection factory to use for
consuming messagespublic ConnectionFactory getTemplateConnectionFactory()
public void setTemplateConnectionFactory(ConnectionFactory templateConnectionFactory)
JmsTemplate via createInOnlyTemplate(JmsEndpoint,boolean, String)
templateConnectionFactory - the connection factory for sending messages@Deprecated public boolean isUseVersion102()
@Deprecated public void setUseVersion102(boolean useVersion102)
public boolean isAutoStartup()
public void setAutoStartup(boolean autoStartup)
public boolean isAcceptMessagesWhileStopping()
public void setAcceptMessagesWhileStopping(boolean acceptMessagesWhileStopping)
public String getClientId()
public void setClientId(String consumerClientId)
public String getDurableSubscriptionName()
public void setDurableSubscriptionName(String durableSubscriptionName)
public ExceptionListener getExceptionListener()
public void setExceptionListener(ExceptionListener exceptionListener)
public boolean isSubscriptionDurable()
public void setSubscriptionDurable(boolean subscriptionDurable)
public String getAcknowledgementModeName()
public void setAcknowledgementModeName(String consumerAcknowledgementMode)
public boolean isExposeListenerSession()
public void setExposeListenerSession(boolean exposeListenerSession)
public TaskExecutor getTaskExecutor()
public void setTaskExecutor(TaskExecutor taskExecutor)
public boolean isPubSubNoLocal()
public void setPubSubNoLocal(boolean pubSubNoLocal)
public int getConcurrentConsumers()
public void setConcurrentConsumers(int concurrentConsumers)
public int getMaxMessagesPerTask()
public void setMaxMessagesPerTask(int maxMessagesPerTask)
public int getCacheLevel()
public void setCacheLevel(int cacheLevel)
public String getCacheLevelName()
public void setCacheLevelName(String cacheName)
public long getRecoveryInterval()
public void setRecoveryInterval(long recoveryInterval)
public long getReceiveTimeout()
public void setReceiveTimeout(long receiveTimeout)
public PlatformTransactionManager getTransactionManager()
public void setTransactionManager(PlatformTransactionManager transactionManager)
public String getTransactionName()
public void setTransactionName(String transactionName)
public int getTransactionTimeout()
public void setTransactionTimeout(int transactionTimeout)
public int getIdleTaskExecutionLimit()
public void setIdleTaskExecutionLimit(int idleTaskExecutionLimit)
public int getMaxConcurrentConsumers()
public void setMaxConcurrentConsumers(int maxConcurrentConsumers)
public boolean isExplicitQosEnabled()
public void setExplicitQosEnabled(boolean explicitQosEnabled)
public boolean isDeliveryPersistent()
public void setDeliveryPersistent(boolean deliveryPersistent)
public boolean isReplyToDeliveryPersistent()
public void setReplyToDeliveryPersistent(boolean replyToDeliveryPersistent)
public long getTimeToLive()
public void setTimeToLive(long timeToLive)
public MessageConverter getMessageConverter()
public void setMessageConverter(MessageConverter messageConverter)
public boolean isMapJmsMessage()
public void setMapJmsMessage(boolean mapJmsMessage)
public boolean isMessageIdEnabled()
public void setMessageIdEnabled(boolean messageIdEnabled)
public boolean isMessageTimestampEnabled()
public void setMessageTimestampEnabled(boolean messageTimestampEnabled)
public int getPriority()
public void setPriority(int priority)
public ConsumerType getConsumerType()
public void setConsumerType(ConsumerType consumerType)
public int getAcknowledgementMode()
public void setAcknowledgementMode(int consumerAcknowledgementMode)
public boolean isTransacted()
public void setTransacted(boolean consumerTransacted)
public boolean isTransactedInOut()
public void setTransactedInOut(boolean transactedInOut)
public boolean isLazyCreateTransactionManager()
public void setLazyCreateTransactionManager(boolean lazyCreating)
public boolean isEagerLoadingOfProperties()
public void setEagerLoadingOfProperties(boolean eagerLoadingOfProperties)
eagerLoadingOfProperties - whether or not to enable eager loading of
JMS properties on inbound messagespublic boolean isDisableReplyTo()
public void setDisableReplyTo(boolean disableReplyTo)
disableReplyTo - whether or not to disable the use of JMSReplyTo
header indicating an InOutpublic void setPreserveMessageQos(boolean preserveMessageQos)
public JmsOperations getJmsOperations()
public void setJmsOperations(JmsOperations jmsOperations)
public DestinationResolver getDestinationResolver()
public void setDestinationResolver(DestinationResolver destinationResolver)
public long getRequestMapPurgePollTimeMillis()
public void setRequestMapPurgePollTimeMillis(long requestMapPurgePollTimeMillis)
public JmsProviderMetadata getProviderMetadata()
public void setProviderMetadata(JmsProviderMetadata providerMetadata)
public JmsOperations getMetadataJmsOperations(JmsEndpoint endpoint)
public void setMetadataJmsOperations(JmsOperations metadataJmsOperations)
JmsOperations used to deduce the JmsProviderMetadata details which if none
is customized one is lazily created on demand
public static DestinationResolver createDestinationResolver(DestinationEndpoint destinationEndpoint)
protected void configureMessageListenerContainer(AbstractMessageListenerContainer container,
JmsEndpoint endpoint)
public void configure(EndpointMessageListener listener)
public AbstractMessageListenerContainer chooseMessageListenerContainerImplementation()
protected int defaultCacheLevel(JmsEndpoint endpoint)
endpoint - the endpoint
protected ConnectionFactory createConnectionFactory()
protected ConnectionFactory createListenerConnectionFactory()
protected ConnectionFactory createTemplateConnectionFactory()
protected PlatformTransactionManager createTransactionManager()
public boolean isPreserveMessageQos()
protected void configuredQoS()
setDeliveryPersistent(boolean),
setPriority(int) or setTimeToLive(long) then we should auto default the
setting of setExplicitQosEnabled(boolean) if its not been configured yet
public boolean isAlwaysCopyMessage()
public void setAlwaysCopyMessage(boolean alwaysCopyMessage)
public boolean isUseMessageIDAsCorrelationID()
public void setUseMessageIDAsCorrelationID(boolean useMessageIDAsCorrelationID)
public String getReplyToTempDestinationAffinity()
public void setReplyToTempDestinationAffinity(String replyToTempDestinationAffinity)
public long getRequestTimeout()
public void setRequestTimeout(long requestTimeout)
public String getReplyTo()
public void setReplyTo(String replyToDestination)
public String getReplyToDestinationSelectorName()
public void setReplyToDestinationSelectorName(String replyToDestinationSelectorName)
public JmsMessageType getJmsMessageType()
public void setJmsMessageType(JmsMessageType jmsMessageType)
public JmsKeyFormatStrategy getJmsKeyFormatStrategy()
public void setJmsKeyFormatStrategy(JmsKeyFormatStrategy jmsKeyFormatStrategy)
public boolean isTransferExchange()
public void setTransferExchange(boolean transferExchange)
public boolean isTransferException()
public void setTransferException(boolean transferException)
public boolean isTestConnectionOnStartup()
public void setTestConnectionOnStartup(boolean testConnectionOnStartup)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||