PurgeMessageChannelAction (Citrus :: Endpoints :: Spring Integration 3.3.1 API)

java.lang.Object
- com.consol.citrus.actions.AbstractTestAction
- - com.consol.citrus.actions.PurgeMessageChannelAction

All Implemented Interfaces:

Described, Named, TestAction, TestActorAware
```
public class PurgeMessageChannelAction
extends AbstractTestAction
```
Action purges all messages from a message channel instance. Message channel must be of type QueueChannel. Action receives a list of channel objects or a list of channel names that are resolved dynamically at runtime.

Author:

Christoph Deppisch

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PurgeMessageChannelAction.AllAcceptingMessageSelector`	Special message selector accepts all messages on queue channel.
`static class`	`PurgeMessageChannelAction.Builder`	Action builder.

Field Summary
- Fields inherited from class com.consol.citrus.actions.AbstractTestAction
  description

Constructor Summary

Constructors
Constructor Description

PurgeMessageChannelAction(PurgeMessageChannelAction.Builder builder)
Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`doExecute(TestContext context)`
`List<String>`	`getChannelNames()`	Gets the channelNames.
`org.springframework.messaging.core.DestinationResolver<org.springframework.messaging.MessageChannel>`	`getChannelResolver()`	Gets the channelResolver.
`List<org.springframework.messaging.MessageChannel>`	`getChannels()`	Gets the channels.
`org.springframework.integration.core.MessageSelector`	`getMessageSelector()`	Gets the messageSelector.
`protected org.springframework.messaging.MessageChannel`	`resolveChannelName(String channelName)`	Resolve the channel by name.

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
  - PurgeMessageChannelAction
```
public PurgeMessageChannelAction(PurgeMessageChannelAction.Builder builder)
```
    Default constructor.
- Method Detail
  - doExecute
```
public void doExecute(TestContext context)
```
    Specified by:
    
    doExecute in class AbstractTestAction
  - resolveChannelName
```
protected org.springframework.messaging.MessageChannel resolveChannelName(String channelName)
```
    Resolve the channel by name.
    
    Parameters:
    
    channelName - the name to resolve
    
    Returns:
    
    the MessageChannel object
  - getChannelNames
```
public List<String> getChannelNames()
```
    Gets the channelNames.
    
    Returns:
    
    the channelNames the channelNames to get.
  - getChannels
```
public List<org.springframework.messaging.MessageChannel> getChannels()
```
    Gets the channels.
    
    Returns:
    
    the channels the channels to get.
  - getMessageSelector
```
public org.springframework.integration.core.MessageSelector getMessageSelector()
```
    Gets the messageSelector.
    
    Returns:
    
    the messageSelector the messageSelector to get.
  - getChannelResolver
```
public org.springframework.messaging.core.DestinationResolver<org.springframework.messaging.MessageChannel> getChannelResolver()
```
    Gets the channelResolver.
    
    Returns:
    
    the channelResolver the channelResolver to get.