org.mule.jms.commons.internal.connection

Class JmsConnection

java.lang.Object

org.mule.jms.commons.internal.connection.JmsConnection

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Stoppable

Direct Known Subclasses:

JmsTransactionalConnection

public class JmsConnection
extends Object
implements org.mule.runtime.api.lifecycle.Stoppable, org.mule.runtime.api.lifecycle.Disposable

A Connection for the JmsConnector

Since:

1.0

Field Summary

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
JmsConnection(JmsSupport jmsSupport, javax.jms.Connection connection, JmsSessionManager jmsSessionManager, CompositeJmsExceptionListener exceptionListener)

Method Summary

Modifier and Type	Method and Description
JmsMessageConsumer	createConsumer(JmsSession session, javax.jms.Destination jmsDestination, String selector, ConsumerType consumerType) Creates a new JMS MessageConsumer using the given Session
JmsMessageConsumer	createConsumer(JmsSession session, javax.jms.Destination jmsDestination, String selector, ConsumerType consumerType, boolean avoidCaching) Creates a new JMS MessageConsumer using the given Session
JmsMessageProducer	createProducer(JmsSession session, javax.jms.Destination jmsDestination, boolean isTopic) Creates a new JMS MessageProducer using the given Session
JmsSession	createSession(InternalAckMode ackMode, boolean isTopic) Creates a new JMS Session using the current Connection
void	dispose()
javax.jms.Connection	get()
JmsSessionManager	getJmsSessionManager()
JmsSupport	getJmsSupport()
void	registerExceptionListener(javax.jms.ExceptionListener exceptionListener)
void	setConnection(javax.jms.Connection connection)
void	stop() Temporarily stops a connection's delivery of incoming messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

JmsConnection

public JmsConnection(JmsSupport jmsSupport,
                     javax.jms.Connection connection,
                     JmsSessionManager jmsSessionManager,
                     CompositeJmsExceptionListener exceptionListener)

Method Detail

getJmsSupport

public JmsSupport getJmsSupport()

get

public javax.jms.Connection get()

setConnection

public void setConnection(javax.jms.Connection connection)

createSession

public JmsSession createSession(InternalAckMode ackMode,
                                boolean isTopic)
                         throws javax.jms.JMSException

Creates a new JMS Session using the current Connection

Parameters:

ackMode - the Session InternalAckMode

isTopic - if true the Session created will be a TopicSession. This distinction is made only for JmsSpecification.JMS_1_0_2b]

Returns:

a new Session

Throws:

javax.jms.JMSException - if an error occurs while creating the Session

createConsumer

public JmsMessageConsumer createConsumer(JmsSession session,
                                         javax.jms.Destination jmsDestination,
                                         String selector,
                                         ConsumerType consumerType,
                                         boolean avoidCaching)
                                  throws javax.jms.JMSException

Creates a new JMS MessageConsumer using the given Session

Parameters:

session - the JmsSession used to create the MessageConsumer

jmsDestination - the Destination from which Messages will be consumed

selector - a JMS selector string for filtering incoming Messages. Empty or null implies no filtering

consumerType - the ConsumerType to use based on the Destination type

avoidCaching - indicates if the consumer should prevent be cached.

Returns:

a new MessageConsumer for the given Destination

Throws:

javax.jms.JMSException - if an error occurs while creating the consumer

createConsumer

public JmsMessageConsumer createConsumer(JmsSession session,
                                         javax.jms.Destination jmsDestination,
                                         String selector,
                                         ConsumerType consumerType)
                                  throws javax.jms.JMSException

Creates a new JMS MessageConsumer using the given Session

Parameters:

session - the JmsSession used to create the MessageConsumer

jmsDestination - the Destination from which Messages will be consumed

selector - a JMS selector string for filtering incoming Messages. Empty or null implies no filtering

consumerType - the ConsumerType to use based on the Destination type

Returns:

a new MessageConsumer for the given Destination

Throws:

javax.jms.JMSException - if an error occurs while creating the consumer

createProducer

public JmsMessageProducer createProducer(JmsSession session,
                                         javax.jms.Destination jmsDestination,
                                         boolean isTopic)
                                  throws javax.jms.JMSException

Creates a new JMS MessageProducer using the given Session

Parameters:

session - the JmsSession used to create the MessageProducer

jmsDestination - the Destination to where the Messages will be published

isTopic - if true the given Destination has a Topic destination type. This distinction is made only for JmsSpecification.JMS_1_0_2b in order to decide whether to create a TopicPublisher or a QueueSender

Returns:

a new MessageProducer for the given Destination

Throws:

javax.jms.JMSException - if an error occurs while creating the consumer

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

Temporarily stops a connection's delivery of incoming messages. Delivery can be restarted using the connection's start method. When the connection is stopped, delivery to all the connection's message consumers is inhibited.

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Throws:

org.mule.runtime.api.exception.MuleException

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

registerExceptionListener

public void registerExceptionListener(javax.jms.ExceptionListener exceptionListener)

getJmsSessionManager

public JmsSessionManager getJmsSessionManager()