io.ballerina.messaging.broker.client.cmd.impl.delete

Class DeleteMessagesCmd

java.lang.Object

io.ballerina.messaging.broker.client.cmd.AbstractCmd

io.ballerina.messaging.broker.client.cmd.impl.delete.DeleteCmd

io.ballerina.messaging.broker.client.cmd.impl.delete.DeleteMessagesCmd

All Implemented Interfaces:

MBClientCmd

public class DeleteMessagesCmd
extends DeleteCmd

Command representing message deletion of a queue(purge) in MB.

Field Summary

Fields inherited from class io.ballerina.messaging.broker.client.cmd.AbstractCmd

ERR_STREAM, help, password, rootCommand, selfJCommander, verbose

Constructor Summary

Constructors

Constructor and Description
DeleteMessagesCmd(String rootCommand)

Method Summary

Modifier and Type	Method and Description
void	appendUsage(StringBuilder out) Append usage description of this command to the passed string builder.
Message	buildResponseMessage(HttpResponse response, String defaultMessage) This method is commonly used by implementations of this interface.
void	execute() Execution logic of the command.

Methods inherited from class io.ballerina.messaging.broker.client.cmd.AbstractCmd

processHelpLogs, setSelfJCommander

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeleteMessagesCmd

public DeleteMessagesCmd(String rootCommand)

Method Detail

execute

public void execute()

Description copied from interface: MBClientCmd

Execution logic of the command.

Specified by:

execute in interface MBClientCmd

Overrides:

execute in class DeleteCmd

buildResponseMessage

public Message buildResponseMessage(HttpResponse response,
                                    String defaultMessage)

Description copied from interface: MBClientCmd

This method is commonly used by implementations of this interface. This method will extract response message, from the HttpResponse and create a new Message instance with it. If response message payload is empty, the new Message will contain the default message.

Parameters:

response - httpResponse received from the Brokers REST backend.

defaultMessage - default message to be set, in case of absence of the http message payload.

Returns:

newly created Message instance.

appendUsage

public void appendUsage(StringBuilder out)

Description copied from interface: MBClientCmd

Append usage description of this command to the passed string builder.

Specified by:

appendUsage in interface MBClientCmd

Overrides:

appendUsage in class DeleteCmd

Parameters:

out - StringBuilder instance, which messages should be appended to.