alluxio.cli

Interface Command

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractCollectInfoCommand, AbstractFileSystemCommand, AbstractFsAdminCommand, AbstractTableCommand, AddCommand, AttachDatabaseCommand, BackupCommand, CancelCommand, CatCommand, CheckConsistencyCommand, CheckpointCommand, ChecksumCommand, ChgrpCommand, ChmodCommand, ChownCommand, ClearCommand, CollectAlluxioInfoCommand, CollectConfigCommand, CollectEnvCommand, CollectJvmInfoCommand, CollectLogCommand, CollectMetricsCommand, CopyFromLocalCommand, CopyToLocalCommand, CountCommand, CpCommand, DetachDatabaseCommand, DistributedCpCommand, DistributedLoadCommand, DistributedMvCommand, DoctorCommand, DuCommand, ExecuteShellCollectInfoCommand, FreeCommand, GetBlockInfoCommand, GetCapacityBytesCommand, GetFaclCommand, GetSyncPathListCommand, GetUsedBytesCommand, HeadCommand, HelpCommand, InstallCommand, JournalCommand, LeaderCommand, LeaderCommand, ListCommand, ListCommand, ListDatabasesCommand, LoadCommand, LocationCommand, LsCommand, LsCommand, MasterInfoCommand, MetricsCommand, MkdirCommand, MountCommand, MvCommand, PathConfCommand, PersistCommand, PinCommand, QuorumCommand, QuorumInfoCommand, QuorumRemoveCommand, RemoveCommand, ReportCommand, RmCommand, SetFaclCommand, SetReplicationCommand, SetTtlCommand, ShowCommand, StartSyncCommand, StatCommand, StatCommand, StateLockHoldersCommand, StopSyncCommand, SyncDatabaseCommand, TailCommand, TestCommand, TouchCommand, TransformStatusCommand, TransformTableCommand, UfsCommand, UninstallCommand, UnmountCommand, UnpinCommand, UnsetTtlCommand, UpdateMountCommand

public interface Command
extends Closeable

An interface for all the commands that can be run from a shell.

Method Summary

Modifier and Type	Method and Description
default void	close() Used to close resources created by commands.
String	getCommandName() Gets the command name as input from the shell.
String	getDescription()
default org.apache.commons.cli.Options	getOptions()
default Map<String,Command>	getSubCommands()
String	getUsage()
default boolean	hasSubCommand() If a command has sub-commands, the first argument should be the sub-command's name, all arguments and options will be parsed for the sub-command.
default org.apache.commons.cli.CommandLine	parseAndValidateArgs(String... args) Parses and validates the arguments.
default int	run(org.apache.commons.cli.CommandLine cl) Runs the command.
default void	validateArgs(org.apache.commons.cli.CommandLine cl) Checks if the arguments are valid or throw InvalidArgumentException.

Method Detail

getCommandName

String getCommandName()

Gets the command name as input from the shell.

Returns:

the command name

getOptions

default org.apache.commons.cli.Options getOptions()

Returns:

the supported Options of the command

hasSubCommand

default boolean hasSubCommand()

If a command has sub-commands, the first argument should be the sub-command's name, all arguments and options will be parsed for the sub-command.

Returns:

whether this command has sub-commands

getSubCommands

default Map<String,Command> getSubCommands()

Returns:

a map from sub-command names to sub-command instances

parseAndValidateArgs

default org.apache.commons.cli.CommandLine parseAndValidateArgs(String... args)
                                                         throws InvalidArgumentException

Parses and validates the arguments.

Parameters:

args - the arguments for the command, excluding the command name

Returns:

the parsed command line object

Throws:

InvalidArgumentException - when arguments are not valid

validateArgs

default void validateArgs(org.apache.commons.cli.CommandLine cl)
                   throws InvalidArgumentException

Checks if the arguments are valid or throw InvalidArgumentException.

Parameters:

cl - the parsed command line for the arguments

Throws:

InvalidArgumentException - when arguments are not valid

run

default int run(org.apache.commons.cli.CommandLine cl)
         throws AlluxioException,
                IOException

Runs the command.

Parameters:

cl - the parsed command line for the arguments

Returns:

the result of running the command

Throws:

AlluxioException

IOException

getUsage

String getUsage()

Returns:

the usage information of the command

getDescription

String getDescription()

Returns:

the description information of the command

close

default void close()
            throws IOException

Used to close resources created by commands.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if closing resources fails