Package org.apache.pulsar.admin.cli

Class PulsarAdminTool

java.lang.Object

org.apache.pulsar.admin.cli.PulsarAdminTool

All Implemented Interfaces:

CommandHook

Direct Known Subclasses:

AdminShell

public class PulsarAdminTool
extends Object
implements CommandHook

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PulsarAdminTool.RootParams

Field Summary

Fields

Modifier and Type	Field	Description
protected static boolean	allowSystemExit
protected final picocli.CommandLine	commander
protected Map<String,Class<?>>	commandMap
protected List<CustomCommandFactory>	customCommandFactories
protected PulsarAdminSupplier	pulsarAdminSupplier
protected PulsarAdminTool.RootParams	rootParams

Constructor Summary

Constructors

Constructor	Description
PulsarAdminTool(Properties properties)

Method Summary

Modifier and Type	Method	Description
static PulsarAdminTool	execute(String[] args)
protected String	getAdminUrl()
PulsarAdminSupplier	getPulsarAdminSupplier()
static void	main(String[] args)
int	preRun()	The preRun hook is used to execute commands before.
protected boolean	run(String[] args)
protected void	setCommandName(String name)

Methods inherited from class java.lang.Object

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

Field Details

allowSystemExit

protected static boolean allowSystemExit

customCommandFactories

protected List<CustomCommandFactory> customCommandFactories

commandMap

protected Map<String,Class<?>> commandMap

commander

protected final picocli.CommandLine commander

rootParams

protected PulsarAdminTool.RootParams rootParams

pulsarAdminSupplier

protected PulsarAdminSupplier pulsarAdminSupplier

Constructor Details

PulsarAdminTool

public PulsarAdminTool(Properties properties)
                throws Exception

Throws:

Exception

Method Details

run

protected boolean run(String[] args)

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

execute

public static PulsarAdminTool execute(String[] args)
                               throws Exception

Throws:

Exception

preRun

public int preRun()

Description copied from interface: CommandHook

The preRun hook is used to execute commands before.

Specified by:

preRun in interface CommandHook

Returns:

If the return value is 0, continue to the next stage.

getPulsarAdminSupplier

public PulsarAdminSupplier getPulsarAdminSupplier()

setCommandName

protected void setCommandName(String name)

getAdminUrl

protected String getAdminUrl()