Uses of Interface
org.apache.bookkeeper.tools.framework.Command

Packages that use Command

Package	Description
org.apache.bookkeeper.tools.cli.commands.autorecovery
org.apache.bookkeeper.tools.cli.commands.bookie	Commands to operate a single bookie.
org.apache.bookkeeper.tools.cli.commands.bookies	Commands on operating a cluster of bookies.
org.apache.bookkeeper.tools.cli.commands.client	This package contains all client related commands.
org.apache.bookkeeper.tools.cli.commands.cookie	Cookie related cli commands.
org.apache.bookkeeper.tools.cli.commands.health
org.apache.bookkeeper.tools.cli.helpers	This classes provides some helper mixins for easily to add commands to bookie shell.
org.apache.bookkeeper.tools.common	Common classes used across multiple tools.
org.apache.bookkeeper.tools.framework	BookKeeper Tool Framework.

Uses of Command in org.apache.bookkeeper.tools.cli.commands.autorecovery

Classes in org.apache.bookkeeper.tools.cli.commands.autorecovery that implement Command

Modifier and Type	Class	Description
class	ListUnderReplicatedCommand	Command to listing under replicated ledgers.
class	LostBookieRecoveryDelayCommand	Command to Setter and Getter for LostBookieRecoveryDelay value (in seconds) in metadata store.
class	QueryAutoRecoveryStatusCommand	Command to Query current auto recovery status.
class	ToggleCommand	Command to enable or disable auto recovery in the cluster.
class	TriggerAuditCommand	Command to trigger AuditTask by resetting lostBookieRecoveryDelay to its current value.
class	WhoIsAuditorCommand	Command to print which node has the auditor lock.

Uses of Command in org.apache.bookkeeper.tools.cli.commands.bookie

Classes in org.apache.bookkeeper.tools.cli.commands.bookie that implement Command

Modifier and Type	Class	Description
class	CheckDBLedgersIndexCommand	Command to check the DBLedgerStorage ledgers index integrity.
class	ConvertToDBStorageCommand	A command to convert bookie indexes from InterleavedStorage to DbLedgerStorage format.
class	ConvertToInterleavedStorageCommand	A command to convert bookie indexes from DbLedgerStorage to InterleavedStorage format.
class	FlipBookieIdCommand	Command to update ledger command.
class	FormatCommand	Command to format the current server contents.
class	InitCommand	A command to initialize new bookie.
class	LastMarkCommand	A bookie command to print the last log marker.
class	LedgerCommand	Command to dump ledger index entries into readable format.
class	ListActiveLedgersCommand	List active(exist in metadata storage) ledgers in a entry log file.
class	ListFilesOnDiscCommand	Command to list the files in JournalDirectories/LedgerDirectories/IndexDirectories.
class	ListLedgersCommand	Command for list all ledgers on the cluster.
class	LocalConsistencyCheckCommand	Command to check local storage for inconsistencies.
class	ReadJournalCommand	Command to scan a journal file and format the entries into readable format.
class	ReadLedgerCommand	Command to read ledger entries.
class	ReadLogCommand	Command to read entry log files.
class	ReadLogMetadataCommand	Command to print metadata of entry log.
class	RebuildDBLedgerLocationsIndexCommand	Command to rebuild DBLedgerStorage locations index.
class	RebuildDBLedgersIndexCommand	Command to rebuild DBLedgerStorage ledgers index.
class	RegenerateInterleavedStorageIndexFileCommand	Command to regenerate an index file for interleaved storage.
class	SanityTestCommand	A bookie command to sanity test for local bookie.
class	UpdateBookieInLedgerCommand	Command to update ledger command.

Uses of Command in org.apache.bookkeeper.tools.cli.commands.bookies

Classes in org.apache.bookkeeper.tools.cli.commands.bookies that implement Command

Modifier and Type	Class	Description
class	ClusterInfoCommand	A bookie command to retrieve bookies cluster info.
class	DecommissionCommand	Command to trigger AuditTask by resetting lostBookieRecoveryDelay and then make sure the ledgers stored in the bookie are properly replicated and Cookie of the decommissioned bookie should be deleted from metadata server.
class	EndpointInfoCommand	Get endpoint information about a Bookie.
class	InfoCommand	A bookie command to retrieve bookie info.
class	InitCommand	Intializes new cluster by creating required znodes for the cluster.
class	InstanceIdCommand	Command to print instance id of the cluster.
class	ListBookiesCommand	Command to list available bookies.
class	MetaFormatCommand	Format the bookkeeper metadata present in zookeeper.
class	NukeExistingClusterCommand	Nuke bookkeeper metadata of existing cluster in zookeeper.
class	RecoverCommand	Command to ledger data recovery for failed bookie.

Uses of Command in org.apache.bookkeeper.tools.cli.commands.client

Classes in org.apache.bookkeeper.tools.cli.commands.client that implement Command

Modifier and Type	Class	Description
class	DeleteLedgerCommand	Command to delete a given ledger.
class	LedgerMetaDataCommand	Print the metadata for a ledger.
class	SimpleTestCommand	A client command that simply tests if a cluster is healthy.

Uses of Command in org.apache.bookkeeper.tools.cli.commands.cookie

Classes in org.apache.bookkeeper.tools.cli.commands.cookie that implement Command

Modifier and Type	Class	Description
class	AdminCommand	Command to update cookie.
(package private) class	CookieCommand<CookieFlagsT extends CliFlags>	This is a mixin for cookie related commands to extends.
class	CreateCookieCommand	A command that create cookie.
class	DeleteCookieCommand	A command that deletes cookie.
class	GenerateCookieCommand	A command that generate cookie.
class	GetCookieCommand	A command that deletes cookie.
class	UpdateCookieCommand	A command that updates cookie.

Uses of Command in org.apache.bookkeeper.tools.cli.commands.health

Classes in org.apache.bookkeeper.tools.cli.commands.health that implement Command

Modifier and Type	Class	Description
class	SwitchOfHealthCheckCommand	Command to enable or disable health check in the cluster.

Uses of Command in org.apache.bookkeeper.tools.cli.helpers

Classes in org.apache.bookkeeper.tools.cli.helpers that implement Command

Modifier and Type	Class	Description
class	BookieCommand<BookieFlagsT extends CliFlags>	This is a mixin for bookie related commands to extends.
class	ClientCommand<ClientFlagsT extends CliFlags>	This is a mixin class for commands that needs a bookkeeper client.
class	DiscoveryCommand<DiscoveryFlagsT extends CliFlags>	This is a mixin for commands that talks to discovery service.

Uses of Command in org.apache.bookkeeper.tools.common

Classes in org.apache.bookkeeper.tools.common that implement Command

Modifier and Type	Class	Description
class	BKCommand<CommandFlagsT extends CliFlags>	Base bk command class.

Uses of Command in org.apache.bookkeeper.tools.framework

Subinterfaces of Command in org.apache.bookkeeper.tools.framework

Modifier and Type	Interface	Description
interface	CommandGroup<GlobalFlagsT extends CliFlags>	A command group that group commands together.

Classes in org.apache.bookkeeper.tools.framework that implement Command

Modifier and Type	Class	Description
class	CliCommand<GlobalFlagsT extends CliFlags,CommandFlagsT extends CliFlags>	A command that runs a CLI spec.
class	CliCommandGroup<GlobalFlagsT extends CliFlags>	A command group that group commands together.
(package private) class	HelpCommand<GlobalFlagsT extends CliFlags,CommandFlagsT extends CliFlags>	Help command to show help information.

Methods in org.apache.bookkeeper.tools.framework that return Command

Modifier and Type	Method	Description
(package private) Command	Cli.getCommand(java.lang.String command)

Methods in org.apache.bookkeeper.tools.framework that return types with arguments of type Command

Modifier and Type	Method	Description
java.util.Set<Command>	CliSpec.commands()
(package private) java.util.Map<java.lang.String,Command>	Cli.getCommandMap()

Methods in org.apache.bookkeeper.tools.framework with parameters of type Command

Modifier and Type	Method	Description
CliSpec.Builder<CliFlagsT>	CliSpec.Builder.addCommand(Command command)

Method parameters in org.apache.bookkeeper.tools.framework with type arguments of type Command

Modifier and Type	Method	Description
static void	CommandUtils.printAvailableCommands(java.util.Map<java.lang.String,Command> commands, java.io.PrintStream printer)	Print the available commands in commander.
(package private) static <CliFlagsT extends CliFlags> com.beust.jcommander.JCommander	Cli.setupCli(java.lang.String cmdPath, CliSpec<CliFlagsT> spec, java.util.Map<java.lang.String,Command> commandMap)