com.consol.citrus.dsl.builder

Class PurgeEndpointsBuilder

java.lang.Object

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

com.consol.citrus.dsl.builder.PurgeEndpointsBuilder

All Implemented Interfaces:

TestActionBuilder<PurgeEndpointAction>, TestAction

public class PurgeEndpointsBuilder
extends AbstractTestActionBuilder<PurgeEndpointAction>

Action purges all messages from a message endpoint instance. Message endpoint must be of type Endpoint. Action receives a list of endpoint objects or a list of endpoint names that are resolved dynamically at runtime.

Since:

2.4

Author:

Christoph Deppisch

Field Summary

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

action

Constructor Summary

Constructors

Constructor and Description
PurgeEndpointsBuilder() Default constructor.
PurgeEndpointsBuilder(PurgeEndpointAction action) Default constructor using test action and application context

Method Summary

Modifier and Type	Method and Description
PurgeEndpointsBuilder	endpoint(Endpoint endpoint) Adds a endpoint to the list of endpoints to purge in this action.
PurgeEndpointsBuilder	endpoint(String name) Adds a endpoint name to the list of endpoints to purge in this action.
PurgeEndpointsBuilder	endpointNames(List<String> endpointNames) Adds list of endpoint names to purge in this action.
PurgeEndpointsBuilder	endpointNames(String... endpointNames) Adds several endpoint names to the list of endpoints to purge in this action.
PurgeEndpointsBuilder	endpoints(Endpoint... endpoints) Sets several endpoints to purge in this action.
PurgeEndpointsBuilder	endpoints(List<Endpoint> endpoints) Adds list of endpoints to purge in this action.
PurgeEndpointsBuilder	selector(Map<String,Object> messageSelector) Sets the messageSelector.
PurgeEndpointsBuilder	selector(String messageSelector) Sets the messageSelector.
PurgeEndpointsBuilder	sleep(long millis) Sets the sleepTime.
PurgeEndpointsBuilder	timeout(long receiveTimeout) Receive timeout for reading message from a destination.
PurgeEndpointsBuilder	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

PurgeEndpointsBuilder

public PurgeEndpointsBuilder(PurgeEndpointAction action)

Default constructor using test action and application context

Parameters:

action -

PurgeEndpointsBuilder

public PurgeEndpointsBuilder()

Default constructor.

Method Detail

selector

public PurgeEndpointsBuilder selector(String messageSelector)

Sets the messageSelector.

Parameters:

messageSelector - the messageSelector to set

selector

public PurgeEndpointsBuilder selector(Map<String,Object> messageSelector)

Sets the messageSelector.

Parameters:

messageSelector - the messageSelector to set

endpointNames

public PurgeEndpointsBuilder endpointNames(List<String> endpointNames)

Adds list of endpoint names to purge in this action.

Parameters:

endpointNames - the endpointNames to set

endpointNames

public PurgeEndpointsBuilder endpointNames(String... endpointNames)

Adds several endpoint names to the list of endpoints to purge in this action.

Parameters:

endpointNames -

Returns:

endpoint

public PurgeEndpointsBuilder endpoint(String name)

Adds a endpoint name to the list of endpoints to purge in this action.

Parameters:

name -

Returns:

endpoints

public PurgeEndpointsBuilder endpoints(List<Endpoint> endpoints)

Adds list of endpoints to purge in this action.

Parameters:

endpoints - the endpoints to set

endpoints

public PurgeEndpointsBuilder endpoints(Endpoint... endpoints)

Sets several endpoints to purge in this action.

Parameters:

endpoints -

Returns:

endpoint

public PurgeEndpointsBuilder endpoint(Endpoint endpoint)

Adds a endpoint to the list of endpoints to purge in this action.

Parameters:

endpoint -

Returns:

timeout

public PurgeEndpointsBuilder timeout(long receiveTimeout)

Receive timeout for reading message from a destination.

Parameters:

receiveTimeout - the receiveTimeout to set

sleep

public PurgeEndpointsBuilder sleep(long millis)

Sets the sleepTime.

Parameters:

millis - the sleepTime to set

withApplicationContext

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

Sets the Spring bean factory for using endpoint names.

Parameters:

applicationContext -