org.mule.providers.jms
Class JmsConnector

java.lang.Object
  org.mule.providers.AbstractConnector
      org.mule.providers.AbstractServiceEnabledConnector
          org.mule.providers.jms.JmsConnector

All Implemented Interfaces:

org.mule.impl.internal.notifications.ConnectionNotificationListener, org.mule.umo.lifecycle.Disposable, EventListener, ExceptionListener, org.mule.umo.lifecycle.Initialisable, org.mule.umo.provider.UMOConnectable, org.mule.umo.provider.UMOConnector, org.mule.umo.manager.UMOServerNotificationListener, WorkListener

public class JmsConnector

extends org.mule.providers.AbstractServiceEnabledConnector

implements org.mule.impl.internal.notifications.ConnectionNotificationListener

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, loacal transactions

Version:

$Revision: 3167 $

Author:

Ross Mason, Guillaume Nodet

Field Summary

String	password
String	username

Fields inherited from class org.mule.providers.AbstractServiceEnabledConnector

serviceDescriptor, serviceOverrides

Fields inherited from class org.mule.providers.AbstractConnector

connected, connecting, createDispatcherPerRequest, createMultipleTransactedReceivers, defaultInboundTransformer, defaultOutboundTransformer, defaultResponseTransformer, dispatcherFactory, dispatchers, disposed, disposing, exceptionListener, initialised, logger, name, receivers, serverSide, sessionHandler, started, startOnConnect

Fields inherited from interface org.mule.umo.provider.UMOConnector

INT_VALUE_NOT_SET

Constructor Summary

JmsConnector()

Method Summary

void	close(MessageConsumer consumer) Closes the MessageConsumer
void	close(MessageProducer producer) Closes the MessageProducer
void	close(Session session) Closes the Session
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 Session 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).
protected Connection	createConnection()
protected ConnectionFactory	createConnectionFactory()
protected RedeliveryHandler	createRedeliveryHandler()
void	doConnect()
void	doDisconnect()
protected void	doDispose()
void	doInitialise()
void	doStart()
int	getAcknowledgementMode()
String	getClientId()
Connection	getConnection()
ConnectionFactory	getConnectionFactory()
String	getConnectionFactoryClass()
String	getConnectionFactoryJndiName()
Map	getConnectionFactoryProperties()
JmsSupport	getJmsSupport()
Context	getJndiContext()
String	getJndiInitialFactory()
Map	getJndiProviderProperties()
String	getJndiProviderUrl()
int	getMaxRedelivery()
String	getPassword()
String	getProtocol()
protected Object	getReceiverKey(org.mule.umo.UMOComponent component, org.mule.umo.endpoint.UMOEndpoint endpoint)
String	getRedeliveryHandler()
org.mule.providers.ReplyToHandler	getReplyToHandler()
Session	getSession(boolean transacted, boolean topic)
Session	getSession(org.mule.umo.endpoint.UMOImmutableEndpoint endpoint)
Object	getSessionFactory(org.mule.umo.endpoint.UMOEndpoint endpoint)
Session	getSessionFromTransaction()
String	getSpecification()
String	getUsername()
protected void	initJndiContext()
boolean	isCacheJmsSessions()
boolean	isDurable()
boolean	isForceJndiDestinations()
boolean	isJndiDestinations()
boolean	isNoLocal()
boolean	isPersistentDelivery()
boolean	isRecoverJmsConnections()
boolean	isRemoteSyncEnabled()
void	onNotification(org.mule.umo.manager.UMOServerNotification notification)
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	setConnectionFactoryClass(String connectionFactoryClass)
void	setConnectionFactoryJndiName(String connectionFactoryJndiName)
void	setConnectionFactoryProperties(Map connectionFactoryProperties)
void	setDurable(boolean durable)
void	setForceJndiDestinations(boolean forceJndiDestinations)
void	setJmsSupport(JmsSupport jmsSupport)
void	setJndiContext(Context jndiContext)
void	setJndiDestinations(boolean jndiDestinations)
void	setJndiInitialFactory(String jndiInitialFactory)
void	setJndiProviderProperties(Map jndiProviderProperties)
void	setJndiProviderUrl(String jndiProviderUrl)
void	setMaxRedelivery(int maxRedelivery)
void	setNoLocal(boolean noLocal)
void	setPassword(String password)
void	setPersistentDelivery(boolean persistentDelivery)
void	setRecoverJmsConnections(boolean recover)
void	setRedeliveryHandler(String redeliveryHandler)
void	setSpecification(String specification)
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 org.mule.providers.AbstractServiceEnabledConnector

createReceiver, getMessageAdapter, getServiceDescriptor, getServiceOverrides, getStreamMessageAdapter, initFromServiceDescriptor, initialiseFromUrl, setServiceOverrides

Methods inherited from class org.mule.providers.AbstractConnector

checkDisposed, connect, createDispatcher, destroyReceiver, disconnect, dispose, disposeDispatchers, disposeReceivers, doStop, exceptionThrown, fireNotification, getConnectEventId, getConnectionDescription, getConnectionStrategy, getDefaultInboundTransformer, getDefaultOutboundTransformer, getDefaultResponseTransformer, getDispatcher, getDispatcherFactory, getDispatchers, getDispatcherThreadingProfile, getExceptionListener, getName, getReceiver, getReceiver, getReceivers, getReceivers, getReceiverThreadingProfile, getSessionHandler, getSupportedProtocols, handleException, handleWorkException, initialise, isConnected, isCreateDispatcherPerRequest, isCreateMultipleTransactedReceivers, isDisposed, isDisposing, isEnableMessageEvents, isServerSide, isStarted, isUseSingleDispatcherThreadPool, isUseSingleReceiverThreadPool, registerListener, registerSupportedProtocol, registerSupportedProtocolWithotPrefix, setConnectionStrategy, setCreateDispatcherPerRequest, setCreateMultipleTransactedReceivers, setDefaultInboundTransformer, setDefaultOutboundTransformer, setDefaultResponseTransformer, setDispatcherFactory, setDispatcherThreadingProfile, setEnableMessageEvents, setExceptionListener, setName, setReceiverThreadingProfile, setServerSide, setSessionHandler, setSupportedProtocols, setUseSingleDispatcherThreadPool, setUseSingleReceiverThreadPool, startConnector, stopConnector, supportsProtocol, unregisterListener, unregisterSupportedProtocol, workAccepted, workCompleted, workRejected, workStarted

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

username

public String username

password

public String password

Constructor Detail

JmsConnector

public JmsConnector()

Method Detail

doInitialise

public void doInitialise()
                  throws org.mule.umo.lifecycle.InitialisationException

Throws:

org.mule.umo.lifecycle.InitialisationException

initJndiContext

protected void initJndiContext()
                        throws NamingException,
                               org.mule.umo.lifecycle.InitialisationException

Throws:

NamingException

org.mule.umo.lifecycle.InitialisationException

setConnection

protected void setConnection(Connection connection)

createConnectionFactory

protected ConnectionFactory createConnectionFactory()
                                             throws org.mule.umo.lifecycle.InitialisationException,
                                                    NamingException

Throws:

org.mule.umo.lifecycle.InitialisationException

NamingException

createConnection

protected Connection createConnection()
                               throws NamingException,
                                      JMSException,
                                      org.mule.umo.lifecycle.InitialisationException

Throws:

NamingException

JMSException

org.mule.umo.lifecycle.InitialisationException

doConnect

public void doConnect()
               throws org.mule.providers.ConnectException

Throws:

org.mule.providers.ConnectException

doDisconnect

public void doDisconnect()
                  throws org.mule.providers.ConnectException

Throws:

org.mule.providers.ConnectException

getReceiverKey

protected Object getReceiverKey(org.mule.umo.UMOComponent component,
                                org.mule.umo.endpoint.UMOEndpoint endpoint)

getSessionFactory

public Object getSessionFactory(org.mule.umo.endpoint.UMOEndpoint endpoint)

getSessionFromTransaction

public Session getSessionFromTransaction()

getSession

public Session getSession(boolean transacted,
                          boolean topic)
                   throws JMSException

Throws:

JMSException

doStart

public void doStart()
             throws org.mule.umo.UMOException

Throws:

org.mule.umo.UMOException

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface org.mule.umo.provider.UMOConnector

doDispose

protected void doDispose()

getAcknowledgementMode

public int getAcknowledgementMode()

Returns:

Returns the acknowledgeMode.

setAcknowledgementMode

public void setAcknowledgementMode(int acknowledgementMode)

Parameters:

acknowledgementMode - The acknowledgementMode to set.

getConnectionFactoryJndiName

public String getConnectionFactoryJndiName()

Returns:

Returns the connectionFactoryJndiName.

setConnectionFactoryJndiName

public void setConnectionFactoryJndiName(String connectionFactoryJndiName)

Parameters:

connectionFactoryJndiName - The connectionFactoryJndiName to set.

isDurable

public boolean isDurable()

Returns:

Returns the durable.

setDurable

public void setDurable(boolean durable)

Parameters:

durable - The durable to set.

isNoLocal

public boolean isNoLocal()

Returns:

Returns the noLocal.

setNoLocal

public void setNoLocal(boolean noLocal)

Parameters:

noLocal - The noLocal to set.

isPersistentDelivery

public boolean isPersistentDelivery()

Returns:

Returns the persistentDelivery.

setPersistentDelivery

public void setPersistentDelivery(boolean persistentDelivery)

Parameters:

persistentDelivery - The persistentDelivery to set.

getJndiProviderProperties

public Map getJndiProviderProperties()

Returns:

Returns the JNDI providerProperties.

Since:

1.1

setJndiProviderProperties

public void setJndiProviderProperties(Map jndiProviderProperties)

Parameters:

jndiProviderProperties - The JNDI providerProperties to set.

Since:

1.1

getConnectionFactoryProperties

public Map getConnectionFactoryProperties()

Returns:

Returns underlying connection factory properties.

setConnectionFactoryProperties

public void setConnectionFactoryProperties(Map connectionFactoryProperties)

Parameters:

connectionFactoryProperties - properties to be set on the underlying ConnectionFactory.

getJndiInitialFactory

public String getJndiInitialFactory()

setJndiInitialFactory

public void setJndiInitialFactory(String jndiInitialFactory)

getJndiProviderUrl

public String getJndiProviderUrl()

setJndiProviderUrl

public void setJndiProviderUrl(String jndiProviderUrl)

getSession

public Session getSession(org.mule.umo.endpoint.UMOImmutableEndpoint endpoint)
                   throws Exception

Throws:

Exception

getConnectionFactory

public ConnectionFactory getConnectionFactory()

setConnectionFactory

public void setConnectionFactory(ConnectionFactory connectionFactory)

getConnectionFactoryClass

public String getConnectionFactoryClass()

setConnectionFactoryClass

public void setConnectionFactoryClass(String connectionFactoryClass)

getJmsSupport

public JmsSupport getJmsSupport()

setJmsSupport

public void setJmsSupport(JmsSupport jmsSupport)

getSpecification

public String getSpecification()

setSpecification

public void setSpecification(String specification)

isJndiDestinations

public boolean isJndiDestinations()

setJndiDestinations

public void setJndiDestinations(boolean jndiDestinations)

isForceJndiDestinations

public boolean isForceJndiDestinations()

setForceJndiDestinations

public void setForceJndiDestinations(boolean forceJndiDestinations)

getJndiContext

public Context getJndiContext()

setJndiContext

public void setJndiContext(Context jndiContext)

setRecoverJmsConnections

public void setRecoverJmsConnections(boolean recover)

isRecoverJmsConnections

public boolean isRecoverJmsConnections()

createRedeliveryHandler

protected RedeliveryHandler createRedeliveryHandler()
                                             throws IllegalAccessException,
                                                    NoSuchMethodException,
                                                    InvocationTargetException,
                                                    InstantiationException,
                                                    ClassNotFoundException

Throws:

IllegalAccessException

NoSuchMethodException

InvocationTargetException

InstantiationException

ClassNotFoundException

getReplyToHandler

public org.mule.providers.ReplyToHandler getReplyToHandler()

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getConnection

public Connection getConnection()

Returns:

Returns the connection.

getClientId

public String getClientId()

setClientId

public void setClientId(String clientId)

getMaxRedelivery

public int getMaxRedelivery()

setMaxRedelivery

public void setMaxRedelivery(int maxRedelivery)

getRedeliveryHandler

public String getRedeliveryHandler()

setRedeliveryHandler

public void setRedeliveryHandler(String redeliveryHandler)

isRemoteSyncEnabled

public boolean isRemoteSyncEnabled()

Specified by:

isRemoteSyncEnabled in interface org.mule.umo.provider.UMOConnector

onNotification

public void onNotification(org.mule.umo.manager.UMOServerNotification notification)

Specified by:

onNotification in interface org.mule.umo.manager.UMOServerNotificationListener

isCacheJmsSessions

public boolean isCacheJmsSessions()

setCacheJmsSessions

public void setCacheJmsSessions(boolean cacheJmsSessions)

supportsProperty

public boolean supportsProperty(String property)

This method may be overridden in case a certain JMS implementation does not support all the standard JMS properties.

preProcessMessage

public Message preProcessMessage(Message message,
                                 Session session)
                          throws Exception

This method may be overridden in order to apply pre-processing to the message as soon as it arrives.

Parameters:

message - - the incoming message

session - - the JMS session

Returns:

the preprocessed message

Throws:

Exception

close

public void close(MessageProducer producer)
           throws JMSException

Closes the MessageProducer

Parameters:

producer -

Throws:

JMSException

closeQuietly

public void closeQuietly(MessageProducer producer)

Closes the MessageProducer without throwing an exception (an error message is logged instead).

Parameters:

producer -

close

public void close(MessageConsumer consumer)
           throws JMSException

Closes the MessageConsumer

Parameters:

consumer -

Throws:

JMSException

closeQuietly

public void closeQuietly(MessageConsumer consumer)

Closes the MessageConsumer without throwing an exception (an error message is logged instead).

Parameters:

consumer -

close

public void close(Session session)
           throws JMSException

Closes the Session

Parameters:

session -

Throws:

JMSException

closeQuietly

public void closeQuietly(Session session)

Closes the Session without throwing an exception (an error message is logged instead).

Parameters:

session -

close

public void close(TemporaryQueue tempQueue)
           throws JMSException

Closes the TemporaryQueue

Parameters:

tempQueue -

Throws:

JMSException

closeQuietly

public void closeQuietly(TemporaryQueue tempQueue)

Closes the TemporaryQueue without throwing an exception (an error message is logged instead).

Parameters:

tempQueue -

close

public void close(TemporaryTopic tempTopic)
           throws JMSException

Closes the TemporaryTopic

Parameters:

tempTopic -

Throws:

JMSException

closeQuietly

public void closeQuietly(TemporaryTopic tempTopic)

Closes the TemporaryTopic without throwing an exception (an error message is logged instead).

Parameters:

tempTopic -