Package org.citrusframework.actions

Class PurgeEndpointAction

java.lang.Object

org.citrusframework.actions.AbstractTestAction

org.citrusframework.actions.PurgeEndpointAction

All Implemented Interfaces:

org.citrusframework.common.Described, org.citrusframework.common.Named, org.citrusframework.TestAction, org.citrusframework.TestActorAware

public class PurgeEndpointAction
extends AbstractTestAction

Action purges all messages from a message endpoint. Action receives a list of endpoint objects or a list of endpoint names that are resolved dynamically at runtime.

Since:

2.4

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.citrusframework.actions.AbstractTestAction

description

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	doExecute(org.citrusframework.context.TestContext context)	Subclasses may add custom execution logic here.
List<String>	getEndpointNames()	Gets the endpointNames.
List<org.citrusframework.endpoint.Endpoint>	getEndpoints()	Gets the endpoints.
String	getMessageSelector()	Gets the messageSelector.
Map<String,Object>	getMessageSelectorMap()	Gets the messageSelector as map.
long	getReceiveTimeout()	Gets the receiveTimeout.
org.citrusframework.spi.ReferenceResolver	getReferenceResolver()	Gets the bean reference resolver for endpoint name resolving.
long	getSleepTime()	Gets the sleepTime.
protected org.citrusframework.endpoint.Endpoint	resolveEndpointName(String endpointName)	Resolve the endpoint by name.

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

PurgeEndpointAction

public PurgeEndpointAction(PurgeEndpointAction.Builder builder)

Default constructor.

Method Details

doExecute

public void doExecute(org.citrusframework.context.TestContext context)

Description copied from class: AbstractTestAction

Subclasses may add custom execution logic here.

Specified by:

doExecute in class AbstractTestAction

resolveEndpointName

protected org.citrusframework.endpoint.Endpoint resolveEndpointName(String endpointName)

Resolve the endpoint by name.

Parameters:

endpointName - the name to resolve

Returns:

the Endpoint object

getReferenceResolver

public org.citrusframework.spi.ReferenceResolver getReferenceResolver()

Gets the bean reference resolver for endpoint name resolving.

Returns:

getEndpointNames

public List<String> getEndpointNames()

Gets the endpointNames.

Returns:

the endpointNames the endpointNames to get.

getEndpoints

public List<org.citrusframework.endpoint.Endpoint> getEndpoints()

Gets the endpoints.

Returns:

the endpoints the endpoints to get.

getMessageSelectorMap

public Map<String,Object> getMessageSelectorMap()

Gets the messageSelector as map.

Returns:

the messageSelectorMap

getMessageSelector

public String getMessageSelector()

Gets the messageSelector.

Returns:

the messageSelector

getReceiveTimeout

public long getReceiveTimeout()

Gets the receiveTimeout.

Returns:

the receiveTimeout

getSleepTime

public long getSleepTime()

Gets the sleepTime.

Returns:

the sleepTime the sleepTime to get.