Package org.apache.pulsar.admin.cli.extensions

Interface CustomCommand

public interface CustomCommand
Custom command.

  • Method Details

    • name

      String name()
      Name of the command.
      Returns:
      the name

    • description

      String description()
      Descritption of the command.
      Returns:
      the description

    • parameters

      List<ParameterDescriptor> parameters()
      The parameters for the command.
      Returns:
      the parameters

    • execute

      boolean execute(Map<String,Object> parameters, CommandExecutionContext context) throws Exception
      Execute the command.
      Parameters:
      parameters - the parameters, one entry per each parameter name
      context - access the environment
      Returns:
      false in case of failure
      Throws:
      Exception