Package org.apache.pulsar.shell

Class ClientShell

java.lang.Object

org.apache.pulsar.client.cli.PulsarClientTool

org.apache.pulsar.shell.ClientShell

All Implemented Interfaces:

CommandHook, ShellCommandsProvider

public class ClientShell
extends PulsarClientTool
implements ShellCommandsProvider

Pulsar Client tool extension for Pulsar shell.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pulsar.client.cli.PulsarClientTool

PulsarClientTool.RootParams

Field Summary

Fields inherited from class org.apache.pulsar.client.cli.PulsarClientTool

commander, consumeCommand, produceCommand, readCommand, rootParams

Constructor Summary

Constructors

Constructor	Description
ClientShell(Properties properties)

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.

Methods inherited from class org.apache.pulsar.client.cli.PulsarClientTool

addCommand, initCommander, main, preRun, replaceProducerCommand, run, setCommandName

Methods inherited from class java.lang.Object

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

Constructor Details

ClientShell

public ClientShell(Properties properties)

Method Details

getName

public String getName()

Description copied from interface: ShellCommandsProvider

Name of the commands. This will be used as program name.

Specified by:

getName in interface ShellCommandsProvider

Returns:

getServiceUrl

public String getServiceUrl()

Description copied from interface: ShellCommandsProvider

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.

Specified by:

getServiceUrl in interface ShellCommandsProvider

Overrides:

getServiceUrl in class PulsarClientTool

Returns:

service url

getAdminUrl

public String getAdminUrl()

Description copied from interface: ShellCommandsProvider

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.

Specified by:

getAdminUrl in interface ShellCommandsProvider

Returns:

admin url

getCommander

public picocli.CommandLine getCommander()

Description copied from interface: ShellCommandsProvider

Return commander instance.

Specified by:

getCommander in interface ShellCommandsProvider

Returns:

Non-null.