sirius.kernel.health.console

Interface Command

All Superinterfaces:

Named

All Known Implementing Classes:

AsyncInfoCommand, CacheCommand, DocCommand, EnvCommand, GCCommand, HelpCommand, LoggerCommand, MD5Command, ModulesCommand, StatsCommand, ThreadsCommand, TimerCommand, TimingCommand

public interface Command
extends Named

Describes a command which is callable via the system console (http://localhost:9000/system/console).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Command.Output Encapsulates the output functionality used by commands to render their output.

Method Summary

Modifier and Type	Method and Description
void	execute(Command.Output output, String... params) Executes the given command with the given parameters.
String	getDescription() Returns a short description of the command.

Methods inherited from interface sirius.kernel.di.std.Named

getName

Method Detail

execute

void execute(Command.Output output,
             String... params)
      throws Exception

Executes the given command with the given parameters.

Parameters:

output - provides access to the output interface used to generate output

params - provides the parameters entered in the console

Throws:

Exception - in case of an error. Throw a HandledException to signal, that all logging and handling has already been performed. Any other exception will be logged and reported as system error.

getDescription

String getDescription()

Returns a short description of the command.

Returns:

the description of the command