alluxio.cli.bundler.command

Class AbstractCollectInfoCommand

java.lang.Object

alluxio.cli.bundler.command.AbstractCollectInfoCommand

All Implemented Interfaces:

Command, Closeable, AutoCloseable

Direct Known Subclasses:

CollectConfigCommand, CollectJvmInfoCommand, CollectLogCommand, CollectMetricsCommand, ExecuteShellCollectInfoCommand

public abstract class AbstractCollectInfoCommand
extends Object
implements Command

Abstraction of a command under CollectInfo.

Field Summary

Fields

Modifier and Type	Field and Description
protected FileSystemContext	mFsContext
protected String	mWorkingDirPath

Constructor Summary

Constructors

Constructor and Description
AbstractCollectInfoCommand(FileSystemContext fsContext) Creates an instance of AbstractCollectInfoCommand.

Method Summary

Modifier and Type	Method and Description
File	generateOutputFile(String workingDirPath, String fileName) Generates the output file for the command to write printouts to.
String	getWorkingDirectory(org.apache.commons.cli.CommandLine cl) Gets the directory that this command should output to.
void	validateArgs(org.apache.commons.cli.CommandLine cl) Checks if the arguments are valid or throw InvalidArgumentException.

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.cli.Command

close, getCommandName, getDescription, getOptions, getSubCommands, getUsage, hasSubCommand, parseAndValidateArgs, run

Field Detail

mFsContext

protected FileSystemContext mFsContext

mWorkingDirPath

protected String mWorkingDirPath

Constructor Detail

AbstractCollectInfoCommand

public AbstractCollectInfoCommand(FileSystemContext fsContext)

Creates an instance of AbstractCollectInfoCommand.

Parameters:

fsContext - FileSystemContext the context to run in

Method Detail

validateArgs

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

Description copied from interface: Command

Checks if the arguments are valid or throw InvalidArgumentException.

Specified by:

validateArgs in interface Command

Parameters:

cl - the parsed command line for the arguments

Throws:

InvalidArgumentException - when arguments are not valid

getWorkingDirectory

public String getWorkingDirectory(org.apache.commons.cli.CommandLine cl)

Gets the directory that this command should output to. Creates the directory if it does not exist.

Parameters:

cl - the parsed CommandLine

Returns:

the directory path

generateOutputFile

public File generateOutputFile(String workingDirPath,
                               String fileName)
                        throws IOException

Generates the output file for the command to write printouts to.

Parameters:

workingDirPath - the base directory this command should output to

fileName - name of the output file

Returns:

the output file

Throws:

IOException