org.apache.activemq.tool

Class AbstractJmsClient

java.lang.Object

org.apache.activemq.tool.AbstractJmsClient

Direct Known Subclasses:

AbstractJmsMeasurableClient

public abstract class AbstractJmsClient
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	clientName
protected int	destCount
protected int	destIndex
protected javax.jms.ConnectionFactory	factory
protected javax.jms.Connection	jmsConnection
protected javax.jms.Session	jmsSession

Constructor Summary

Constructors

Constructor and Description
AbstractJmsClient(javax.jms.ConnectionFactory factory)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	commitTxIfNecessary() Helper method that checks if session is transacted and whether to commit the tx based on commitAfterXMsgs property.
javax.jms.Destination	createCompositeDestination(int destIndex, int destCount)
protected javax.jms.Destination	createCompositeDestination(String name, int destIndex, int destCount)
javax.jms.Destination[]	createDestination(int destIndex, int destCount)
protected javax.jms.Destination	createDestination(String name)
abstract JmsClientProperties	getClient()
String	getClientName()
javax.jms.Connection	getConnection()
int	getDestCount()
int	getDestIndex()
javax.jms.ConnectionFactory	getFactory()
javax.jms.Session	getSession()
abstract void	setClient(JmsClientProperties client)
void	setClientName(String clientName)
void	setDestCount(int destCount)
void	setDestIndex(int destIndex)
void	setFactory(javax.jms.ConnectionFactory factory)

Methods inherited from class java.lang.Object

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

Field Detail

factory

protected javax.jms.ConnectionFactory factory

jmsConnection

protected javax.jms.Connection jmsConnection

jmsSession

protected javax.jms.Session jmsSession

destCount

protected int destCount

destIndex

protected int destIndex

clientName

protected String clientName

Constructor Detail

AbstractJmsClient

public AbstractJmsClient(javax.jms.ConnectionFactory factory)

Method Detail

getClient

public abstract JmsClientProperties getClient()

setClient

public abstract void setClient(JmsClientProperties client)

getFactory

public javax.jms.ConnectionFactory getFactory()

setFactory

public void setFactory(javax.jms.ConnectionFactory factory)

getDestCount

public int getDestCount()

setDestCount

public void setDestCount(int destCount)

getDestIndex

public int getDestIndex()

setDestIndex

public void setDestIndex(int destIndex)

getClientName

public String getClientName()

setClientName

public void setClientName(String clientName)

getConnection

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

Throws:

javax.jms.JMSException

getSession

public javax.jms.Session getSession()
                             throws javax.jms.JMSException

Throws:

javax.jms.JMSException

createDestination

public javax.jms.Destination[] createDestination(int destIndex,
                                        int destCount)
                                          throws javax.jms.JMSException

Throws:

javax.jms.JMSException

createCompositeDestination

public javax.jms.Destination createCompositeDestination(int destIndex,
                                               int destCount)
                                                 throws javax.jms.JMSException

Throws:

javax.jms.JMSException

createCompositeDestination

protected javax.jms.Destination createCompositeDestination(String name,
                                               int destIndex,
                                               int destCount)
                                                    throws javax.jms.JMSException

Throws:

javax.jms.JMSException

createDestination

protected javax.jms.Destination createDestination(String name)
                                           throws javax.jms.JMSException

Throws:

javax.jms.JMSException

commitTxIfNecessary

public boolean commitTxIfNecessary()
                            throws javax.jms.JMSException

Helper method that checks if session is transacted and whether to commit the tx based on commitAfterXMsgs property.

Returns:

true if transaction was committed.

Throws:

javax.jms.JMSException - in case the call to JMS Session.commit() fails.