Package org.apache.pulsar.internal

Interface ShellCommandsProvider

All Known Implementing Classes:
AdminShell, ClientShell, ConfigShell
public interface ShellCommandsProvider
Commands provider for Pulsar shell.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAdminUrl()
    Current admin url for connecting to pulsar admin.
    picocli.CommandLine
    getCommander()
    Return commander instance.
    String
    getName()
    Name of the commands.
    String
    getServiceUrl()
    Current service url for connecting to brokers.

  • Method Details

    • getName

      String getName()
      Name of the commands. This will be used as program name.
      Returns:

    • getServiceUrl

      String getServiceUrl()
      Current service url for connecting to brokers. If the provider doesn't need brokers connection or the service url is not set it must return null.
      Returns:
      service url

    • getAdminUrl

      String getAdminUrl()
      Current admin url for connecting to pulsar admin. If the provider doesn't need brokers connection or the admin url is not set it must return null.
      Returns:
      admin url

    • getCommander

      picocli.CommandLine getCommander()
      Return commander instance.
      Returns:
      Non-null.