org.wso2.transport.jms.factory

Class JMSClientConnectionFactory

java.lang.Object

org.wso2.transport.jms.factory.JMSConnectionResourceFactory

org.wso2.transport.jms.factory.JMSClientConnectionFactory

public class JMSClientConnectionFactory
extends JMSConnectionResourceFactory

Extended class to handle Client side Connection Factory requirements.

Field Summary

Fields inherited from class org.wso2.transport.jms.factory.JMSConnectionResourceFactory

clientId, destinationType, jmsSpec

Constructor Summary

Constructors

Constructor and Description
JMSClientConnectionFactory(Properties properties, boolean isCached) Constructor.

Method Summary

Modifier and Type	Method and Description
void	closeJMSResources() Close cached JMS resources allocated for this Connection Factory.
javax.jms.Connection	createConnection() Create a Connection instance using the initialized configurations.
javax.jms.XAConnection	createXAConnection() Create a XAConnection instance using the initialized configurations.
List<ConnectionWrapper>	getConnections()
String	getFactoryId() Get ID of the factory.
int	getMaxNumberOfConnections()
int	getMaxSessionsPerConnection()
SessionWrapper	getSessionWrapper() Borrow an object from the session pool.
boolean	isClientCaching() Is this Client Connection factory is configured to use caching/pooling.
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	returnSessionWrapper(SessionWrapper sessionWrapper) Return an object to the Session pool.

Methods inherited from class org.wso2.transport.jms.factory.JMSConnectionResourceFactory

closeConnection, closeConsumer, closeProducer, closeSession, createDestination, createMessageProducer, createSession, createXASession, getConnectionFactory, getConnectionFactoryString, getDestinationType, getJmsSpec, getProperties, getSessionAckMode, isTransactedSession, isxATransacted, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

JMSClientConnectionFactory

public JMSClientConnectionFactory(Properties properties,
                                  boolean isCached)
                           throws JMSConnectorException

Constructor.

Parameters:

properties - JMS properties.

Throws:

JMSConnectorException - if an error thrown from parents constructor.

Method Detail

getMaxNumberOfConnections

public int getMaxNumberOfConnections()

getMaxSessionsPerConnection

public int getMaxSessionsPerConnection()

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.

Overrides:

notifyError in class JMSConnectionResourceFactory

Parameters:

ex - JMS Exception that occurred in Connection.

getConnections

public List<ConnectionWrapper> getConnections()

Returns:

Connections list.

getSessionWrapper

public SessionWrapper getSessionWrapper()
                                 throws Exception

Borrow an object from the session pool.

Returns:

SessionWrapper instance.

Throws:

Exception - Exception when borrowing an object from the pool.

returnSessionWrapper

public void returnSessionWrapper(SessionWrapper sessionWrapper)
                          throws JMSConnectorException

Return an object to the Session pool.

Parameters:

sessionWrapper - SessionWrapper instance.

Throws:

JMSConnectorException

closeJMSResources

public void closeJMSResources()
                       throws JMSConnectorException

Close cached JMS resources allocated for this Connection Factory.

Throws:

JMSConnectorException

isClientCaching

public boolean isClientCaching()

Is this Client Connection factory is configured to use caching/pooling.

Returns:

isClientCaching set.

createConnection

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

Description copied from class: JMSConnectionResourceFactory

Create a Connection instance using the initialized configurations.

Overrides:

createConnection in class JMSConnectionResourceFactory

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

Description copied from class: JMSConnectionResourceFactory

Create a XAConnection instance using the initialized configurations.

Overrides:

createXAConnection in class JMSConnectionResourceFactory

Returns:

XAConnection instance.

Throws:

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

getFactoryId

public String getFactoryId()

Get ID of the factory.

Returns:

factory ID.