com.consol.citrus.jms.actions

Class PurgeJmsQueuesAction

java.lang.Object

com.consol.citrus.actions.AbstractTestAction

com.consol.citrus.jms.actions.PurgeJmsQueuesAction

All Implemented Interfaces:

TestAction

public class PurgeJmsQueuesAction
extends AbstractTestAction

Action to purge JMS queue destinations by simply consuming all available messages. As queue purging is a broker implementation specific feature in many cases this action clears all messages from a destination regardless of JMS broker vendor implementations. Consumer will continue to receive messages until message receive timeout is reached, so no messages are left.

Since:

2007

Author:

Christoph Deppisch

Field Summary

Fields inherited from class com.consol.citrus.actions.AbstractTestAction

description

Constructor Summary

Constructors

Constructor and Description
PurgeJmsQueuesAction() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected javax.jms.Connection	createConnection() Create queue connection.
protected javax.jms.Session	createSession(javax.jms.Connection connection) Create queue session.
void	doExecute(TestContext context)
javax.jms.ConnectionFactory	getConnectionFactory() Gets the connectionFactory.
List<String>	getQueueNames()
List<javax.jms.Queue>	getQueues() Gets the queues.
long	getReceiveTimeout() Gets the receiveTimeout.
long	getSleepTime() Gets the sleepTime.
void	setConnectionFactory(javax.jms.ConnectionFactory connectionFactory) Connection factory.
void	setQueueNames(List<String> queueNames) List of queue names to purge.
void	setQueues(List<javax.jms.Queue> queues) List of queues.
void	setReceiveTimeout(long receiveTimeout) Receive timeout for reading message from a destination.
void	setSleepTime(long sleepTime) Sets the sleepTime.

Methods inherited from class com.consol.citrus.actions.AbstractTestAction

execute, getActor, getDescription, getName, isDisabled, setActor, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

PurgeJmsQueuesAction

public PurgeJmsQueuesAction()

Default constructor.

Method Detail

doExecute

public void doExecute(TestContext context)

Specified by:

doExecute in class AbstractTestAction

createConnection

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

Create queue connection.

Returns:

Throws:

javax.jms.JMSException

createSession

protected javax.jms.Session createSession(javax.jms.Connection connection)
                                   throws javax.jms.JMSException

Create queue session.

Parameters:

connection -

Returns:

Throws:

javax.jms.JMSException

setQueueNames

public void setQueueNames(List<String> queueNames)

List of queue names to purge.

Parameters:

queueNames - the queueNames to set

setConnectionFactory

public void setConnectionFactory(javax.jms.ConnectionFactory connectionFactory)

Connection factory.

Parameters:

connectionFactory - the connectionFactory to set

getQueueNames

public List<String> getQueueNames()

Returns:

the queueNames

setQueues

public void setQueues(List<javax.jms.Queue> queues)

List of queues.

Parameters:

queues - The queues which are to be purged.

setReceiveTimeout

public void setReceiveTimeout(long receiveTimeout)

Receive timeout for reading message from a destination.

Parameters:

receiveTimeout - the receiveTimeout to set

getQueues

public List<javax.jms.Queue> getQueues()

Gets the queues.

Returns:

the queues

getConnectionFactory

public javax.jms.ConnectionFactory getConnectionFactory()

Gets the connectionFactory.

Returns:

the connectionFactory

getReceiveTimeout

public long getReceiveTimeout()

Gets the receiveTimeout.

Returns:

the receiveTimeout

setSleepTime

public void setSleepTime(long sleepTime)

Sets the sleepTime.

Parameters:

sleepTime - the sleepTime to set

getSleepTime

public long getSleepTime()

Gets the sleepTime.

Returns:

the sleepTime the sleepTime to get.