com.consol.citrus.dsl.builder

Class PurgeJmsQueuesBuilder

java.lang.Object

com.consol.citrus.dsl.builder.AbstractTestActionBuilder<PurgeJmsQueuesAction>

com.consol.citrus.dsl.builder.PurgeJmsQueuesBuilder

All Implemented Interfaces:

TestActionBuilder<PurgeJmsQueuesAction>, TestAction

public class PurgeJmsQueuesBuilder
extends AbstractTestActionBuilder<PurgeJmsQueuesAction>

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:

2.3

Author:

Christoph Deppisch

Field Summary

Fields inherited from class com.consol.citrus.dsl.builder.AbstractTestActionBuilder

action

Constructor Summary

Constructors

Constructor and Description
PurgeJmsQueuesBuilder() Default constructor.
PurgeJmsQueuesBuilder(PurgeJmsQueuesAction action) Constructor using action field.

Method Summary

Modifier and Type	Method and Description
PurgeJmsQueuesBuilder	connectionFactory(javax.jms.ConnectionFactory connectionFactory) Sets the Connection factory.
boolean	hasConnectionFactory() Checks if connection factory is set properly.
PurgeJmsQueuesBuilder	queue(javax.jms.Queue queue) Adds a new queue to the list of queues to purge in this action.
PurgeJmsQueuesBuilder	queue(String name) Adds a queue name to the list of queues to purge in this action.
PurgeJmsQueuesBuilder	queueNames(List<String> names) List of queue names to purge in this action.
PurgeJmsQueuesBuilder	queueNames(String... names) List of queue names to purge in this action.
PurgeJmsQueuesBuilder	queues(List<javax.jms.Queue> queues) List of queues to purge in this action.
PurgeJmsQueuesBuilder	queues(javax.jms.Queue... queues) List of queues to purge in this action.
PurgeJmsQueuesBuilder	sleep(long millis) Sets the sleepTime.
PurgeJmsQueuesBuilder	timeout(long receiveTimeout) Receive timeout for reading message from a destination.
PurgeJmsQueuesBuilder	withApplicationContext(org.springframework.context.ApplicationContext applicationContext) Sets the Spring bean factory for using endpoint names.

Methods inherited from class com.consol.citrus.dsl.builder.AbstractTestActionBuilder

actor, build, description, 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

PurgeJmsQueuesBuilder

public PurgeJmsQueuesBuilder(PurgeJmsQueuesAction action)

Constructor using action field.

Parameters:

action -

PurgeJmsQueuesBuilder

public PurgeJmsQueuesBuilder()

Default constructor.

Method Detail

connectionFactory

public PurgeJmsQueuesBuilder connectionFactory(javax.jms.ConnectionFactory connectionFactory)

Sets the Connection factory.

Parameters:

connectionFactory - the queueConnectionFactory to set

queues

public PurgeJmsQueuesBuilder queues(List<javax.jms.Queue> queues)

List of queues to purge in this action.

Parameters:

queues - The queues which are to be purged.

queues

public PurgeJmsQueuesBuilder queues(javax.jms.Queue... queues)

List of queues to purge in this action.

Parameters:

queues -

Returns:

queue

public PurgeJmsQueuesBuilder queue(javax.jms.Queue queue)

Adds a new queue to the list of queues to purge in this action.

Parameters:

queue -

Returns:

queueNames

public PurgeJmsQueuesBuilder queueNames(List<String> names)

List of queue names to purge in this action.

Parameters:

names - the queueNames to set

queueNames

public PurgeJmsQueuesBuilder queueNames(String... names)

List of queue names to purge in this action.

Parameters:

names -

Returns:

queue

public PurgeJmsQueuesBuilder queue(String name)

Adds a queue name to the list of queues to purge in this action.

Parameters:

name -

Returns:

timeout

public PurgeJmsQueuesBuilder timeout(long receiveTimeout)

Receive timeout for reading message from a destination.

Parameters:

receiveTimeout - the receiveTimeout to set

sleep

public PurgeJmsQueuesBuilder sleep(long millis)

Sets the sleepTime.

Parameters:

millis - the sleepTime to set

hasConnectionFactory

public boolean hasConnectionFactory()

Checks if connection factory is set properly.

Returns:

withApplicationContext

public PurgeJmsQueuesBuilder withApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Sets the Spring bean factory for using endpoint names.

Parameters:

applicationContext -