org.apache.slider.common.params

Class AbstractActionArgs

java.lang.Object

org.apache.slider.common.params.ArgOps

org.apache.slider.common.params.AbstractActionArgs

All Implemented Interfaces:

Arguments

Direct Known Subclasses:

AbstractClusterBuildingActionArgs, ActionAMSuicideArgs, ActionClientArgs, ActionDependencyArgs, ActionDestroyArgs, ActionDiagnosticArgs, ActionEchoArgs, ActionExistsArgs, ActionFlexArgs, ActionFreezeArgs, ActionHelpArgs, ActionInstallKeytabArgs, ActionInstallPackageArgs, ActionKDiagArgs, ActionKeytabArgs, ActionKillContainerArgs, ActionListArgs, ActionLookupArgs, ActionNodesArgs, ActionPackageArgs, ActionRegistryArgs, ActionResolveArgs, ActionStatusArgs, ActionThawArgs, ActionVersionArgs, SliderAMCreateAction

public abstract class AbstractActionArgs
extends ArgOps
implements Arguments

Base args for all actions

Field Summary

Fields

Modifier and Type	Field and Description
org.apache.hadoop.fs.Path	basePath
boolean	debug
List<String>	definitions -D name=value Define an HBase configuration option which overrides any options in the configuration XML files of the image or in the image configuration directory.
String	filesystemBinding URI/binding to the filesystem
boolean	help
protected static org.slf4j.Logger	log
String	manager
List<String>	parameters This is the default parameter
List<String>	sysprops System properties

Fields inherited from interface org.apache.slider.common.params.Arguments

ARG_ADDON, ARG_ALIAS, ARG_ALL, ARG_APP_HOME, ARG_APPDEF, ARG_APPLICATION, ARG_BASE_PATH, ARG_CLIENT, ARG_CLUSTER_URI, ARG_COMP_OPT, ARG_COMP_OPT_SHORT, ARG_COMPONENT, ARG_COMPONENT_SHORT, ARG_COMPONENTS, ARG_CONFDIR, ARG_CONFIG, ARG_CONTAINERS, ARG_CREDENTIALS, ARG_DEBUG, ARG_DEFINE, ARG_DELETE, ARG_DEST, ARG_DESTDIR, ARG_DESTFILE, ARG_EXITCODE, ARG_FAIL, ARG_FILESYSTEM, ARG_FILESYSTEM_LONG, ARG_FOLDER, ARG_FORCE, ARG_FORMAT, ARG_GETCERTSTORE, ARG_GETCONF, ARG_GETEXP, ARG_GETFILES, ARG_HEALTHY, ARG_HELP, ARG_HOSTNAME, ARG_ID, ARG_IMAGE, ARG_INSTALL, ARG_INTERNAL, ARG_KEYSTORE, ARG_KEYTAB, ARG_KEYTABDELETE, ARG_KEYTABINSTALL, ARG_KEYTABLIST, ARG_LABEL, ARG_LEVEL, ARG_LIST, ARG_LISTCONF, ARG_LISTEXP, ARG_LISTFILES, ARG_LIVE, ARG_MANAGER, ARG_MANAGER_SHORT, ARG_MESSAGE, ARG_METAINFO, ARG_NAME, ARG_OPTION, ARG_OPTION_SHORT, ARG_OUTPUT, ARG_OUTPUT_SHORT, ARG_OVERWRITE, ARG_PACKAGE, ARG_PASSWORD, ARG_PATH, ARG_PKGDELETE, ARG_PKGINSTANCES, ARG_PKGLIST, ARG_PRINCIPAL, ARG_PROVIDER, ARG_QUEUE, ARG_REPLACE_PKG, ARG_RES_COMP_OPT, ARG_RES_COMP_OPT_SHORT, ARG_RESOURCE_MANAGER, ARG_RESOURCE_OPT, ARG_RESOURCE_OPT_SHORT, ARG_RESOURCES, ARG_RM_ADDR, ARG_ROLE, ARG_ROLEOPT, ARG_SERVICES, ARG_SERVICETYPE, ARG_SLIDER, ARG_STATE, ARG_SYSPROP, ARG_TEMPLATE, ARG_TRUSTSTORE, ARG_UPLOAD, ARG_USER, ARG_VERBOSE, ARG_VERSION, ARG_WAIT, ARG_YARN, ARG_ZKHOSTS, ARG_ZKPATH, ARG_ZKPORT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractActionArgs()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	disableSecureLogin() Flag to disable secure login.
abstract String	getActionName() Get the name of the action
String	getClusterName() get the name: relies on arg 1 being the cluster name in all operations
boolean	getHadoopServicesRequired() Override point: Flag to indicate that core hadoop API services are needed (HDFS, YARN, etc) —and that validation of the client state should take place.
int	getMaxParams() Get the max #of params expected
int	getMinParams() Get the min #of params expected
String	toString()
void	validate()

Methods inherited from class org.apache.slider.common.params.ArgOps

applyDefinitions, applyFileSystemBinding, convertTripleListToMaps, convertTupleListToMap, splitPairs, triple

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

filesystemBinding

public String filesystemBinding

URI/binding to the filesystem

basePath

public org.apache.hadoop.fs.Path basePath

parameters

public final List<String> parameters

This is the default parameter

definitions

public final List<String> definitions

-D name=value Define an HBase configuration option which overrides any options in the configuration XML files of the image or in the image configuration directory. The values will be persisted. Configuration options are only passed to the cluster when creating or reconfiguring a cluster.

sysprops

public final List<String> sysprops

System properties

manager

public String manager

debug

public boolean debug

help

public boolean help

Constructor Detail

AbstractActionArgs

protected AbstractActionArgs()

Method Detail

getClusterName

public String getClusterName()

get the name: relies on arg 1 being the cluster name in all operations

Returns:

the name argument, null if there is none

getMinParams

public int getMinParams()

Get the min #of params expected

Returns:

the min number of params in the parameters field

getActionName

public abstract String getActionName()

Get the name of the action

Returns:

the action name

getMaxParams

public int getMaxParams()

Get the max #of params expected

Returns:

the number of params in the parameters field;

validate

public void validate()
              throws BadCommandArgumentsException,
                     UsageException

Throws:

BadCommandArgumentsException

UsageException

toString

public String toString()

Overrides:

toString in class Object

getHadoopServicesRequired

public boolean getHadoopServicesRequired()

Override point: Flag to indicate that core hadoop API services are needed (HDFS, YARN, etc) —and that validation of the client state should take place.

Returns:

a flag to indicate that the core hadoop services will be needed.

disableSecureLogin

public boolean disableSecureLogin()

Flag to disable secure login. This MUST only be set if the action is bypassing security or setting it itself

Returns:

true if login at slider client init time is to be skipped