|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.mule.transport.AbstractConnector
org.mule.transport.jms.JmsConnector
public class JmsConnector
JmsConnector
is a JMS 1.0.2b compliant connector that can be used
by a Mule endpoint. The connector supports all JMS functionality including topics
and queues, durable subscribers, acknowledgement modes and local transactions.
Field Summary | |
---|---|
static String |
JMS
|
String |
password
|
static int |
REDELIVERY_FAIL_ON_FIRST
Indicates that Mule should throw an exception on any redelivery attempt. |
static int |
REDELIVERY_IGNORE
|
String |
username
|
Fields inherited from interface org.mule.api.transport.Connector |
---|
INT_VALUE_NOT_SET |
Fields inherited from interface org.mule.api.lifecycle.Disposable |
---|
PHASE_NAME |
Constructor Summary | |
---|---|
JmsConnector(MuleContext context)
|
Method Summary | |
---|---|
void |
close(MessageConsumer consumer)
Closes the MessageConsumer |
void |
close(MessageProducer producer)
Closes the MessageProducer |
void |
close(Session session)
Closes the MuleSession |
void |
close(TemporaryQueue tempQueue)
Closes the TemporaryQueue |
void |
close(TemporaryTopic tempTopic)
Closes the TemporaryTopic |
void |
closeQuietly(MessageConsumer consumer)
Closes the MessageConsumer without throwing an exception (an error message is logged instead). |
void |
closeQuietly(MessageProducer producer)
Closes the MessageProducer without throwing an exception (an error message is logged instead). |
void |
closeQuietly(Session session)
Closes the MuleSession without throwing an exception (an error message is logged instead). |
void |
closeQuietly(TemporaryQueue tempQueue)
Closes the TemporaryQueue without throwing an exception (an error message is logged instead). |
void |
closeQuietly(TemporaryTopic tempTopic)
Closes the TemporaryTopic without throwing an exception (an error message is logged instead). |
void |
closeSessionIfNoTransactionActive(Session session)
Closes a session if there is no active transaction in the current thread, otherwise the session will continue active until there is a direct call to close it. |
protected Connection |
createConnection()
|
protected ConnectionFactory |
createConnectionFactory()
|
protected JmsSupport |
createJmsSupport()
A factory method to create various JmsSupport class versions. |
protected Session |
createOperationResource(ImmutableEndpoint endpoint)
|
Session |
createSession(ImmutableEndpoint endpoint)
|
protected void |
doConnect()
Template method where any connections should be made for the connector |
protected void |
doDisconnect()
Template method where any connected resources used by the connector should be disconnected |
protected void |
doDispose()
Template method to perform any work when destroying the connectoe |
protected void |
doInitialise()
|
protected void |
doStart()
Template method to perform any work when starting the connectoe |
protected void |
doStop()
Template method to perform any work when stopping the connectoe |
int |
getAcknowledgementMode()
|
String |
getClientId()
|
Connection |
getConnection()
|
ConnectionFactory |
getConnectionFactory()
|
String |
getConnectionFactoryJndiName()
|
Map |
getConnectionFactoryProperties()
|
protected ConnectionFactory |
getDefaultConnectionFactory()
Override this method to provide a default ConnectionFactory for a vendor-specific JMS Connector. |
JmsSupport |
getJmsSupport()
|
String |
getJndiInitialFactory()
Deprecated. use a JndiNameResolver instead of access this property |
JndiNameResolver |
getJndiNameResolver()
|
Map |
getJndiProviderProperties()
Deprecated. use a JndiNameResolver instead of access this property |
String |
getJndiProviderUrl()
Deprecated. use a JndiNameResolver instead of access this property |
int |
getMaxRedelivery()
|
int |
getNumberOfConsumers()
A synonym for AbstractConnector.numberOfConcurrentTransactedReceivers . |
protected Object |
getOperationResourceFactory()
|
String |
getPassword()
|
String |
getProtocol()
|
protected Object |
getReceiverKey(FlowConstruct flowConstruct,
InboundEndpoint endpoint)
The method determines the key used to store the receiver against. |
RedeliveryHandlerFactory |
getRedeliveryHandlerFactory()
|
ReplyToHandler |
getReplyToHandler(ImmutableEndpoint endpoint)
Getter for property 'replyToHandler'. |
Boolean |
getSameRMOverrideValue()
|
JmsSelectorFilter |
getSelector(ImmutableEndpoint endpoint)
|
Session |
getSession(boolean transacted,
boolean topic)
|
Session |
getSession(ImmutableEndpoint endpoint)
|
Session |
getSessionFromTransaction()
|
String |
getSpecification()
|
JmsTopicResolver |
getTopicResolver()
Getter for property 'topicResolver'. |
String |
getUsername()
|
boolean |
isCacheJmsSessions()
|
boolean |
isDisableTemporaryReplyToDestinations()
|
boolean |
isDurable()
|
boolean |
isEagerConsumer()
Getter for property 'eagerConsumer'. |
boolean |
isEmbeddedMode()
|
boolean |
isForceJndiDestinations()
|
boolean |
isHonorQosHeaders()
Gets the value of honorQosHeaders property. |
boolean |
isJndiDestinations()
|
boolean |
isNoLocal()
|
boolean |
isPersistentDelivery()
|
boolean |
isResponseEnabled()
|
boolean |
isReturnOriginalMessageAsReply()
|
protected Object |
lookupFromJndi(String jndiName)
|
void |
onException(JMSException jmsException)
|
Message |
preProcessMessage(Message message,
Session session)
This method may be overridden in order to apply pre-processing to the message as soon as it arrives. |
void |
setAcknowledgementMode(int acknowledgementMode)
|
void |
setCacheJmsSessions(boolean cacheJmsSessions)
|
void |
setClientId(String clientId)
|
protected void |
setConnection(Connection connection)
|
void |
setConnectionFactory(ConnectionFactory connectionFactory)
|
void |
setConnectionFactoryJndiName(String connectionFactoryJndiName)
|
void |
setConnectionFactoryProperties(Map connectionFactoryProperties)
|
void |
setDisableTemporaryReplyToDestinations(boolean disableTemporaryReplyToDestinations)
|
void |
setDurable(boolean durable)
|
void |
setEagerConsumer(boolean eagerConsumer)
A value of true will create a consumer on
connect, in contrast to lazy instantiation in the poll loop. |
void |
setEmbeddedMode(boolean embeddedMode)
|
void |
setForceJndiDestinations(boolean forceJndiDestinations)
|
void |
setHonorQosHeaders(boolean honorQosHeaders)
Sets the honorQosHeaders property, which determines whether
JmsMessageDispatcher should honor incoming message's QoS headers
(JMSPriority, JMSDeliveryMode). |
void |
setJmsSupport(JmsSupport jmsSupport)
|
void |
setJndiDestinations(boolean jndiDestinations)
|
void |
setJndiInitialFactory(String jndiInitialFactory)
Deprecated. use a JndiNameResolver instead of access this property |
void |
setJndiNameResolver(JndiNameResolver jndiNameResolver)
|
void |
setJndiProviderProperties(Map jndiProviderProperties)
Deprecated. use a JndiNameResolver instead of access this property |
void |
setJndiProviderUrl(String jndiProviderUrl)
Deprecated. use a JndiNameResolver instead of access this property |
void |
setMaxRedelivery(int maxRedelivery)
|
void |
setNoLocal(boolean noLocal)
|
void |
setNumberOfConsumers(int count)
A synonym for AbstractConnector.numberOfConcurrentTransactedReceivers . |
void |
setPassword(String password)
|
void |
setPersistentDelivery(boolean persistentDelivery)
|
void |
setRedeliveryHandlerFactory(RedeliveryHandlerFactory redeliveryHandlerFactory)
|
void |
setReturnOriginalMessageAsReply(boolean returnOriginalMessageAsReply)
|
void |
setSameRMOverrideValue(Boolean sameRMOverrideValue)
|
void |
setSpecification(String specification)
|
void |
setTopicResolver(JmsTopicResolver topicResolver)
Setter for property 'topicResolver'. |
void |
setUsername(String username)
|
boolean |
supportsProperty(String property)
This method may be overridden in case a certain JMS implementation does not support all the standard JMS properties. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String JMS
public static final int REDELIVERY_FAIL_ON_FIRST
public static final int REDELIVERY_IGNORE
public String username
public String password
Constructor Detail |
---|
public JmsConnector(MuleContext context)
Method Detail |
---|
public String getProtocol()
getProtocol
in interface Connector
protected void doInitialise() throws InitialisationException
doInitialise
in class AbstractConnector
InitialisationException
protected JmsSupport createJmsSupport()
JmsSupport
protected ConnectionFactory createConnectionFactory() throws InitialisationException, NamingException
InitialisationException
NamingException
protected ConnectionFactory getDefaultConnectionFactory() throws Exception
Exception
protected void doDispose()
AbstractConnector
doDispose
in class AbstractConnector
protected Object lookupFromJndi(String jndiName) throws NamingException
NamingException
protected Connection createConnection() throws NamingException, JMSException, InitialisationException
NamingException
JMSException
InitialisationException
public void onException(JMSException jmsException)
onException
in interface ExceptionListener
protected void doConnect() throws Exception
AbstractConnector
doConnect
in class AbstractConnector
Exception
protected void doDisconnect() throws Exception
AbstractConnector
doDisconnect
in class AbstractConnector
Exception
protected Object getReceiverKey(FlowConstruct flowConstruct, InboundEndpoint endpoint)
AbstractConnector
getReceiverKey
in class AbstractConnector
flowConstruct
- the service for which the endpoint is being registeredendpoint
- the endpoint being registered for the service
public Session getSessionFromTransaction()
public Session getSession(ImmutableEndpoint endpoint) throws JMSException
JMSException
public Session createSession(ImmutableEndpoint endpoint) throws JMSException
JMSException
public Session getSession(boolean transacted, boolean topic) throws JMSException
JMSException
protected void doStart() throws MuleException
AbstractConnector
doStart
in class AbstractConnector
MuleException
- if the method failspublic void closeSessionIfNoTransactionActive(Session session)
session
- the session that ill be closed if there is an active transaction.protected void doStop() throws MuleException
AbstractConnector
doStop
in class AbstractConnector
MuleException
- if the method failspublic ReplyToHandler getReplyToHandler(ImmutableEndpoint endpoint)
AbstractConnector
getReplyToHandler
in class AbstractConnector
public boolean supportsProperty(String property)
public Message preProcessMessage(Message message, Session session) throws Exception
message
- - the incoming messagesession
- - the JMS session
Exception
public void close(MessageProducer producer) throws JMSException
producer
-
JMSException
public void closeQuietly(MessageProducer producer)
producer
- public void close(MessageConsumer consumer) throws JMSException
consumer
-
JMSException
public void closeQuietly(MessageConsumer consumer)
consumer
- public void close(Session session) throws JMSException
session
-
JMSException
public void closeQuietly(Session session)
session
- public void close(TemporaryQueue tempQueue) throws JMSException
tempQueue
-
JMSException
public void closeQuietly(TemporaryQueue tempQueue)
tempQueue
- public void close(TemporaryTopic tempTopic) throws JMSException
tempTopic
-
JMSException
public void closeQuietly(TemporaryTopic tempTopic)
tempTopic
- public Connection getConnection()
protected void setConnection(Connection connection)
public int getAcknowledgementMode()
public void setAcknowledgementMode(int acknowledgementMode)
acknowledgementMode
- The acknowledgementMode to set.public boolean isDurable()
public void setDurable(boolean durable)
durable
- The durable to set.public boolean isNoLocal()
public void setNoLocal(boolean noLocal)
noLocal
- The noLocal to set.public boolean isPersistentDelivery()
public void setPersistentDelivery(boolean persistentDelivery)
persistentDelivery
- The persistentDelivery to set.public JmsSupport getJmsSupport()
public void setJmsSupport(JmsSupport jmsSupport)
public String getSpecification()
public void setSpecification(String specification)
public String getUsername()
public void setUsername(String username)
public String getPassword()
public void setPassword(String password)
public String getClientId()
public void setClientId(String clientId)
public int getMaxRedelivery()
public void setMaxRedelivery(int maxRedelivery)
public boolean isResponseEnabled()
isResponseEnabled
in interface Connector
isResponseEnabled
in class AbstractConnector
public JmsTopicResolver getTopicResolver()
public void setTopicResolver(JmsTopicResolver topicResolver)
topicResolver
- Value to set for property 'topicResolver'.public boolean isEagerConsumer()
true
.
eagerConsumer
public void setEagerConsumer(boolean eagerConsumer)
true
will create a consumer on
connect, in contrast to lazy instantiation in the poll loop.
This setting very much depends on the JMS vendor.
Affects transactional receivers, typical symptoms are:
eagerConsumer
- Value to set for property 'eagerConsumer'.eagerConsumer
,
XaTransactedJmsMessageReceiver
public boolean isCacheJmsSessions()
public void setCacheJmsSessions(boolean cacheJmsSessions)
public ConnectionFactory getConnectionFactory()
public void setConnectionFactory(ConnectionFactory connectionFactory)
public RedeliveryHandlerFactory getRedeliveryHandlerFactory()
public void setRedeliveryHandlerFactory(RedeliveryHandlerFactory redeliveryHandlerFactory)
public void setHonorQosHeaders(boolean honorQosHeaders)
honorQosHeaders
property, which determines whether
JmsMessageDispatcher
should honor incoming message's QoS headers
(JMSPriority, JMSDeliveryMode).
honorQosHeaders
- true
if JmsMessageDispatcher
should honor incoming message's QoS headers; otherwise
false
Default is false
, meaning that
connector settings will override message headers.public boolean isHonorQosHeaders()
honorQosHeaders
property.
true
if JmsMessageDispatcher
should
honor incoming message's QoS headers; otherwise false
Default is false
, meaning that connector settings will
override message headers.@Deprecated public String getJndiInitialFactory()
JndiNameResolver
instead of access this property
@Deprecated public void setJndiInitialFactory(String jndiInitialFactory)
JndiNameResolver
instead of access this property
@Deprecated public String getJndiProviderUrl()
JndiNameResolver
instead of access this property
@Deprecated public void setJndiProviderUrl(String jndiProviderUrl)
JndiNameResolver
instead of access this property
@Deprecated public Map getJndiProviderProperties()
JndiNameResolver
instead of access this property
@Deprecated public void setJndiProviderProperties(Map jndiProviderProperties)
JndiNameResolver
instead of access this property
public JndiNameResolver getJndiNameResolver()
public void setJndiNameResolver(JndiNameResolver jndiNameResolver)
public String getConnectionFactoryJndiName()
public void setConnectionFactoryJndiName(String connectionFactoryJndiName)
public boolean isJndiDestinations()
public void setJndiDestinations(boolean jndiDestinations)
public boolean isForceJndiDestinations()
public void setForceJndiDestinations(boolean forceJndiDestinations)
public boolean isDisableTemporaryReplyToDestinations()
public void setDisableTemporaryReplyToDestinations(boolean disableTemporaryReplyToDestinations)
public boolean isReturnOriginalMessageAsReply()
public void setReturnOriginalMessageAsReply(boolean returnOriginalMessageAsReply)
public Map getConnectionFactoryProperties()
public void setConnectionFactoryProperties(Map connectionFactoryProperties)
connectionFactoryProperties
- properties to be set on the underlying
ConnectionFactory.public void setNumberOfConsumers(int count)
AbstractConnector.numberOfConcurrentTransactedReceivers
. Note that
it affects both transactional and non-transactional scenarios.
count
- number of consumerspublic int getNumberOfConsumers()
AbstractConnector.numberOfConcurrentTransactedReceivers
.
public boolean isEmbeddedMode()
public void setEmbeddedMode(boolean embeddedMode)
public Boolean getSameRMOverrideValue()
public void setSameRMOverrideValue(Boolean sameRMOverrideValue)
public JmsSelectorFilter getSelector(ImmutableEndpoint endpoint)
protected Session createOperationResource(ImmutableEndpoint endpoint) throws MuleException
createOperationResource
in class AbstractConnector
MuleException
protected Object getOperationResourceFactory()
getOperationResourceFactory
in class AbstractConnector
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |