Package org.citrusframework.jms.actions

Class PurgeJmsQueuesAction

java.lang.Object

org.citrusframework.actions.AbstractTestAction

org.citrusframework.jms.actions.PurgeJmsQueuesAction

All Implemented Interfaces:

Described, Named, TestAction, TestActorAware

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PurgeJmsQueuesAction.Builder	Action builder.

Field Summary

Fields inherited from class org.citrusframework.actions.AbstractTestAction

description

Constructor Summary

Constructors

Constructor	Description
PurgeJmsQueuesAction(PurgeJmsQueuesAction.Builder builder)	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected jakarta.jms.Connection	createConnection()	Create queue connection.
protected jakarta.jms.Session	createSession(jakarta.jms.Connection connection)	Create queue session.
void	doExecute(TestContext context)
jakarta.jms.ConnectionFactory	getConnectionFactory()	Gets the connectionFactory.
List<String>	getQueueNames()
List<jakarta.jms.Queue>	getQueues()	Gets the queues.
long	getReceiveTimeout()	Gets the receiveTimeout.
long	getSleepTime()	Gets the sleepTime.

Methods inherited from class org.citrusframework.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 Details

PurgeJmsQueuesAction

public PurgeJmsQueuesAction(PurgeJmsQueuesAction.Builder builder)

Default constructor.

Method Details

doExecute

public void doExecute(TestContext context)

Specified by:

doExecute in class AbstractTestAction

createConnection

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

Create queue connection.

Returns:

Throws:

jakarta.jms.JMSException

createSession

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

Create queue session.

Parameters:

connection -

Returns:

Throws:

jakarta.jms.JMSException

getQueueNames

public List<String> getQueueNames()

Returns:

the queueNames

getQueues

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

Gets the queues.

Returns:

the queues

getConnectionFactory

public jakarta.jms.ConnectionFactory getConnectionFactory()

Gets the connectionFactory.

Returns:

the connectionFactory

getReceiveTimeout

public long getReceiveTimeout()

Gets the receiveTimeout.

Returns:

the receiveTimeout

getSleepTime

public long getSleepTime()

Gets the sleepTime.

Returns:

the sleepTime the sleepTime to get.