psdi.iface.jms

Class JMSClient

java.lang.Object

psdi.iface.jms.JMSClient

Direct Known Subclasses:

JMSConsumer, JMSProducer, JMSQueueBrowser

public abstract class JMSClient
extends java.lang.Object

Abstract base class for all JMS clients - for both Topics and Queues. Responsible for handling the Session and transactional details.

Author:

Anamitra Bhattacharyya

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JMS_LOGGER The JMS logger.
static int	NO_TX Setting this mode will result in non transacted JMS client Session.
static java.lang.String	QUEUE Queue Destination type
static int	SESSION_TX Setting this mode will result in transacted JMS client session.
static java.lang.String	TOPIC Topic Destination type

Method Summary

Modifier and Type	Method and Description
void	close() Releses all resources that is cached by the client like JMS Session and Connection.
void	commitTx() Commits the JMS Session transaction.
abstract JMSClient	createClientInSession() Creates another JMSClient of the same type in this clients Session.
abstract JMSClient	createClientInSession(java.lang.String destinationName, java.util.Properties env) Creates another JMSClient of the same type in this clients Session.
java.lang.String	getDestinationName()
java.util.Properties	getEnvironment()
java.lang.String	getProviderPassword()
java.lang.String	getProviderUserName()
javax.jms.Session	getSession() Deprecated.
boolean	isValid() Determines if the client is still valid.
void	rollbackTx() Rollback the JMS Session transaction.

Methods inherited from class java.lang.Object

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

Field Detail

NO_TX

public static final int NO_TX

Setting this mode will result in non transacted JMS client Session. Use thid mode when the client will be invoked in JTA context.

See Also:

Constant Field Values

SESSION_TX

public static final int SESSION_TX

Setting this mode will result in transacted JMS client session.

See Also:

Constant Field Values

QUEUE

public static final java.lang.String QUEUE

Queue Destination type

See Also:

Constant Field Values

TOPIC

public static final java.lang.String TOPIC

Topic Destination type

See Also:

Constant Field Values

JMS_LOGGER

public static final java.lang.String JMS_LOGGER

The JMS logger.

See Also:

Constant Field Values

Method Detail

getProviderUserName

public java.lang.String getProviderUserName()

Returns:

the provider connection username

getProviderPassword

public java.lang.String getProviderPassword()

Returns:

the provider connection password

getSession

@Deprecated
public javax.jms.Session getSession()

Deprecated.

This method funtionality been replaced by createClientInSession().

Returns:

JMS Session used by this client.

createClientInSession

public abstract JMSClient createClientInSession()
                                         throws MXException

Creates another JMSClient of the same type in this clients Session. This is used for making the this client and the newly created client to work off the same Session and hence be in the same JMS transaction context.

Returns:

the newly created JMSClient instance.

Throws:

MXException

createClientInSession

public abstract JMSClient createClientInSession(java.lang.String destinationName,
                                                java.util.Properties env)
                                         throws MXException

Creates another JMSClient of the same type in this clients Session. This is used for making the this client and the newly created client to work off the same Session and hence be in the same JMS transaction context.

Returns:

the newly created JMSClient instance.

Throws:

MXException

getEnvironment

public java.util.Properties getEnvironment()

Returns:

the env properties used JNDI lookup.

getDestinationName

public java.lang.String getDestinationName()

Returns:

the JNDI name of the Queue.

isValid

public boolean isValid()

Determines if the client is still valid. An invalid client has all its resources released and hence cannot be used for further communication to the JMS provider.

close

public void close()

Releses all resources that is cached by the client like JMS Session and Connection. If the Session is owned by another client then this operation will not close that Session (and Connection). Calling this method on the originating client (which created the Session and Connection) will close these resources.

rollbackTx

public void rollbackTx()
                throws MXException

Rollback the JMS Session transaction. Will do nothing if the trsansaction mode is NO_TX.

Throws:

MXException

commitTx

public void commitTx()
              throws MXException

Commits the JMS Session transaction. Will do nothing if the trsansaction mode is NO_TX.

Throws:

MXException