org.mule.extensions.jms.api.connection

Class JmsConnection

java.lang.Object

org.mule.extensions.jms.api.connection.JmsConnection

All Implemented Interfaces:

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

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

A Connection for the JmsExtension

Since:

4.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)

Method Summary

Modifier and Type	Method and Description
JmsMessageConsumer	createConsumer(javax.jms.Session session, javax.jms.Destination jmsDestination, String selector, ConsumerType consumerType) Creates a new JMS MessageConsumer using the given Session
JmsMessageProducer	createProducer(javax.jms.Session session, javax.jms.Destination jmsDestination, boolean isTopic) Creates a new JMS MessageProducer using the given Session
JmsSession	createSession(AckMode ackMode, boolean isTopic) Creates a new JMS Session using the current Connection
void	dispose()
void	doAck(String ackId) Executes the Message.acknowledge() on the latest Message associated to the Session identified by the ackId
javax.jms.Connection	get()
JmsSupport	getJmsSupport()
void	registerMessageForAck(String ackId, javax.jms.Message message) Registers the Message to the Session using the ackId in order to being able later to perform a AckMode.MANUAL ACK
void	releaseResources() Release the resources related to the Session, Producers and Consumers that may have been allocated by this 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)

Method Detail

getJmsSupport

public JmsSupport getJmsSupport()

get

public javax.jms.Connection get()

createSession

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

Creates a new JMS Session using the current Connection

Parameters:

ackMode - the Session AckMode

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(javax.jms.Session 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 Session 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(javax.jms.Session session,
                                         javax.jms.Destination jmsDestination,
                                         boolean isTopic)
                                  throws javax.jms.JMSException

Creates a new JMS MessageProducer using the given Session

Parameters:

session - the Session 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

registerMessageForAck

public void registerMessageForAck(String ackId,
                                  javax.jms.Message message)

Registers the Message to the Session using the ackId in order to being able later to perform a AckMode.MANUAL ACK

Parameters:

ackId - the id associated to the Session used to create the Message

message - the Message to use for executing the Message.acknowledge()

Throws:

IllegalArgumentException - if no Session was registered with the given AckId

doAck

public void doAck(String ackId)
           throws javax.jms.JMSException

Executes the Message.acknowledge() on the latest Message associated to the Session identified by the ackId

Parameters:

ackId - the id associated to the Session that should be ACKed

Throws:

javax.jms.JMSException - if an error occurs during the ack

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

releaseResources

public void releaseResources()

Release the resources related to the Session, Producers and Consumers that may have been allocated by this Connection. This terminates all message processing on the Sessions created by this Connection.