org.wso2.transport.jms.factory

Class JMSConnectionResourceFactory

java.lang.Object

org.wso2.transport.jms.factory.JMSConnectionResourceFactory

Direct Known Subclasses:

JMSClientConnectionFactory, JMSServerConnectionFactory

public class JMSConnectionResourceFactory
extends Object

JMSServerConnectionFactory that handles the JMS Connection, Session creation and closing.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	clientId The String instance representing the client id of the durable subscription.
protected JMSConstants.JMSDestinationType	destinationType Represents whether to listen queue or topic.
protected String	jmsSpec The String instance representing the jms spec version.

Constructor Summary

Constructors

Constructor and Description
JMSConnectionResourceFactory(Properties properties) Initialization of JMS ConnectionFactory with the user specified properties.

Method Summary

Modifier and Type	Method and Description
void	closeConnection(javax.jms.Connection connection) Close a JMS Connection.
void	closeConsumer(javax.jms.MessageConsumer messageConsumer) Close a JMS MessageConsumer.
void	closeProducer(javax.jms.MessageProducer messageProducer) Close a JMS MessageProducer.
void	closeSession(javax.jms.Session session) Close a JMS Session.
javax.jms.Connection	createConnection() Create a Connection instance using the initialized configurations.
javax.jms.Destination	createDestination(javax.jms.Session session, String destinationName) To create the destination.
javax.jms.MessageProducer	createMessageProducer(javax.jms.Session session) Create MessageProducer instance for the provided session.
javax.jms.Session	createSession(javax.jms.Connection connection) Create JMS Session instance on top of the provided Connection instance.
javax.jms.XAConnection	createXAConnection() Create a XAConnection instance using the initialized configurations.
javax.jms.XASession	createXASession(javax.jms.XAConnection xAConnection) Create JMS XASession instance on top of the provided Connection instance.
javax.jms.ConnectionFactory	getConnectionFactory() To get the JMS Connection Factory.
protected String	getConnectionFactoryString() Get ConnectionFactory Name.
JMSConstants.JMSDestinationType	getDestinationType() Get destination type of this Connection factory.
String	getJmsSpec() Get JMS specification version.
Properties	getProperties()
int	getSessionAckMode()
boolean	isTransactedSession()
boolean	isxATransacted()
void	notifyError(javax.jms.JMSException ex) This method will get invoked by the JMS Connection Error listener whenever as error occurs in the JMS Connection level.
void	start(javax.jms.Connection connection) Start the jms connection to start the message delivery.
void	stop(javax.jms.Connection connection) Stop the jms connection to stop the message delivery.

Methods inherited from class java.lang.Object

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

Field Detail

destinationType

protected JMSConstants.JMSDestinationType destinationType

Represents whether to listen queue or topic.

jmsSpec

protected String jmsSpec

The String instance representing the jms spec version.

clientId

protected String clientId

The String instance representing the client id of the durable subscription.

Constructor Detail

JMSConnectionResourceFactory

public JMSConnectionResourceFactory(Properties properties)
                             throws JMSConnectorException

Initialization of JMS ConnectionFactory with the user specified properties.

Parameters:

properties - Properties to be added to the initial context.

Throws:

JMSConnectorException - Thrown when initial context name is wrong or when creating connection factory.

Method Detail

getConnectionFactory

public javax.jms.ConnectionFactory getConnectionFactory()
                                                 throws JMSConnectorException

To get the JMS Connection Factory.

Returns:

JMS Connection Factory.

Throws:

JMSConnectorException - Thrown when creating jms connection.

createConnection

public javax.jms.Connection createConnection()
                                      throws javax.jms.JMSException

Create a Connection instance using the initialized configurations.

Returns:

Connection instance.

Throws:

javax.jms.JMSException - thrown when creating the connection object from JMS connection factory.

createXAConnection

public javax.jms.XAConnection createXAConnection()
                                          throws javax.jms.JMSException

Create a XAConnection instance using the initialized configurations.

Returns:

XAConnection instance.

Throws:

javax.jms.JMSException - thrown when creating the XAconnection object from JMS XAconnection factory.

createDestination

public javax.jms.Destination createDestination(javax.jms.Session session,
                                               String destinationName)
                                        throws JMSConnectorException

To create the destination.

Parameters:

session - relevant session to create the destination.

destinationName - Destination jms destination.

Returns:

the destination that is created from session.

Throws:

JMSConnectorException - Thrown when looking up destination.

createSession

public javax.jms.Session createSession(javax.jms.Connection connection)
                                throws JMSConnectorException

Create JMS Session instance on top of the provided Connection instance.

Parameters:

connection - JMS Connection.

Returns:

Session instance.

Throws:

JMSConnectorException - Error when creating the JMS Session.

createXASession

public javax.jms.XASession createXASession(javax.jms.XAConnection xAConnection)
                                    throws JMSConnectorException

Create JMS XASession instance on top of the provided Connection instance.

Parameters:

xAConnection - JMS Connection.

Returns:

Session instance.

Throws:

JMSConnectorException - Error when creating the XASession.

createMessageProducer

public javax.jms.MessageProducer createMessageProducer(javax.jms.Session session)
                                                throws JMSConnectorException

Create MessageProducer instance for the provided session.

Parameters:

session - JMS Session instance.

Returns:

Message producer.

Throws:

JMSConnectorException - Error when creating the JMS Message Producer.

isTransactedSession

public boolean isTransactedSession()

isxATransacted

public boolean isxATransacted()

getSessionAckMode

public int getSessionAckMode()

getProperties

public Properties getProperties()

notifyError

public void notifyError(javax.jms.JMSException ex)

This method will get invoked by the JMS Connection Error listener whenever as error occurs in the JMS Connection level.

This can be used to close all the Connections, Sessions, Producer, Consumers created on top of this Connection factory and initialize again.

Parameters:

ex - JMS Exception that occurred in Connection.

getJmsSpec

public String getJmsSpec()

Get JMS specification version.

Returns:

1.0, 1.1 or 2.0.

getDestinationType

public JMSConstants.JMSDestinationType getDestinationType()

Get destination type of this Connection factory.

Returns:

queue or topic.

closeConnection

public void closeConnection(javax.jms.Connection connection)
                     throws javax.jms.JMSException

Close a JMS Connection.

Parameters:

connection - Connection that need to be closed.

Throws:

javax.jms.JMSException - if an error occurs while closing the connection.

closeSession

public void closeSession(javax.jms.Session session)
                  throws javax.jms.JMSException

Close a JMS Session.

Parameters:

session - Session that needs to be closed.

Throws:

javax.jms.JMSException - if an error occurs while closing the session.

closeProducer

public void closeProducer(javax.jms.MessageProducer messageProducer)
                   throws javax.jms.JMSException

Close a JMS MessageProducer.

Parameters:

messageProducer - JMS Message Producer that needs to be closed.

Throws:

javax.jms.JMSException - if an error occurs while closing the producer.

closeConsumer

public void closeConsumer(javax.jms.MessageConsumer messageConsumer)
                   throws javax.jms.JMSException

Close a JMS MessageConsumer.

Parameters:

messageConsumer - JMS Message Consumer that needs to be closed.

Throws:

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

start

public void start(javax.jms.Connection connection)
           throws JMSConnectorException,
                  javax.jms.JMSSecurityException

Start the jms connection to start the message delivery.

Parameters:

connection - Connection that need to be started.

Throws:

JMSConnectorException - Thrown when starting jms connection.

javax.jms.JMSSecurityException - Thrown for issues in security (eg: credentials).

stop

public void stop(javax.jms.Connection connection)
          throws JMSConnectorException

Stop the jms connection to stop the message delivery.

Parameters:

connection - JMS connection that need to be stopped.

Throws:

JMSConnectorException - Thrown when stopping jms connection.

getConnectionFactoryString

protected String getConnectionFactoryString()

Get ConnectionFactory Name.

Returns:

Connection factory name.