io.ballerina.messaging.broker.client.cmd

Interface MBClientCmd

All Known Implementing Classes:

AbstractCmd, CreateBindingCmd, CreateCmd, CreateExchangeCmd, CreateQueueCmd, DeleteCmd, DeleteExchangeCmd, DeleteQueueCmd, GrantCmd, GrantExchangeCmd, GrantQueueCmd, InitCmd, ListBindingCmd, ListCmd, ListConsumerCmd, ListExchangeCmd, ListQueueCmd, RevokeCmd, RevokeExchangeCmd, RevokeQueueCmd, RootCmd, TransferCmd, TransferExchangeCmd, TransferQueueCmd

public interface MBClientCmd

Interface to represent API for any command to be declared.

Method Summary

Modifier and Type	Method and Description
void	appendUsage(StringBuilder out) Append usage description of this command to the passed string builder.
default Message	buildResponseMessage(HttpResponse response, String defaultMessage) This method is commonly used by implementations of this interface.
void	execute() Execution logic of the command.
void	setSelfJCommander(com.beust.jcommander.JCommander jCommander) Store the JCommander instance related to this command itself.

Method Detail

buildResponseMessage

default Message buildResponseMessage(HttpResponse response,
                                     String defaultMessage)

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.

execute

void execute()

Execution logic of the command.

appendUsage

void appendUsage(StringBuilder out)

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

Parameters:

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

setSelfJCommander

void setSelfJCommander(com.beust.jcommander.JCommander jCommander)

Store the JCommander instance related to this command itself. This can be used to print help statements, on its child commands.

Parameters:

jCommander - JCommander instance generated for this Command