org.apache.ambari.server.serveraction

Interface ServerAction

All Known Implementing Classes:

AbstractPrepareKerberosServerAction, AbstractServerAction, AbstractUpgradeServerAction, AddComponentAction, AutoSkipFailedSummaryAction, CleanupServerAction, ComponentVersionCheckAction, ConfigureAction, ConfigureAmbariIdentitiesServerAction, CreateAndConfigureAction, CreateKeytabFilesServerAction, CreatePrincipalsServerAction, DeleteUnsupportedServicesAndComponents, DestroyPrincipalsServerAction, FinalizeKerberosServerAction, FinalizeUpgradeAction, KerberosKeytabsAction, KerberosServerAction, ManualStageAction, PluginUpgradeServerAction, PostUserCreationHookServerAction, PreconfigureKerberosAction, PrepareDisableKerberosServerAction, PrepareEnableKerberosServerAction, PrepareKerberosIdentitiesServerAction, UpdateDesiredRepositoryAction, UpdateKerberosConfigsServerAction, UpgradeUserKerberosDescriptor, YarnNodeManagerCapacityCalculation

public interface ServerAction

ServerAction is an interface to be implemented by all server-based actions/tasks.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_NAME
static String	ACTION_USER_NAME
static int	DEFAULT_LONG_RUNNING_TASK_TIMEOUT_SECONDS The default timeout (in seconds) to use for potentially long running tasks such as creating Kerberos principals and generating Kerberos keytab files
static String	WRAPPED_CLASS_NAME The name of the class that the server action is going to delegate to.

Method Summary

Modifier and Type	Method and Description
CommandReport	execute(ConcurrentMap<String,Object> requestSharedDataContext) Executes this ServerAction This is typically called by the ServerActionExecutor in it's own thread, but there is no guarantee that this is the case.
ExecutionCommand	getExecutionCommand() Gets the ExecutionCommand property of this ServerAction.
HostRoleCommand	getHostRoleCommand() Gets the HostRoleCommand property of this ServerAction.
void	setExecutionCommand(ExecutionCommand command) Sets the ExecutionCommand property of this ServerAction.
void	setHostRoleCommand(HostRoleCommand hostRoleCommand) Sets the HostRoleCommand property of this ServerAction.

Field Detail

ACTION_NAME

static final String ACTION_NAME

See Also:

Constant Field Values

ACTION_USER_NAME

static final String ACTION_USER_NAME

See Also:

Constant Field Values

WRAPPED_CLASS_NAME

static final String WRAPPED_CLASS_NAME

The name of the class that the server action is going to delegate to. This is used in cases were a server action is being told to run another non-server action, such as during an upgrade.

See Also:

Constant Field Values

DEFAULT_LONG_RUNNING_TASK_TIMEOUT_SECONDS

static final int DEFAULT_LONG_RUNNING_TASK_TIMEOUT_SECONDS

The default timeout (in seconds) to use for potentially long running tasks such as creating Kerberos principals and generating Kerberos keytab files

See Also:

Constant Field Values

Method Detail

getExecutionCommand

ExecutionCommand getExecutionCommand()

Gets the ExecutionCommand property of this ServerAction.

Returns:

the ExecutionCommand property of this ServerAction

setExecutionCommand

void setExecutionCommand(ExecutionCommand command)

Sets the ExecutionCommand property of this ServerAction.

This property is expected to be set by the creator of this ServerAction before calling execute.

Parameters:

command - the ExecutionCommand data to set

getHostRoleCommand

HostRoleCommand getHostRoleCommand()

Gets the HostRoleCommand property of this ServerAction.

Returns:

the HostRoleCommand property of this ServerAction

setHostRoleCommand

void setHostRoleCommand(HostRoleCommand hostRoleCommand)

Sets the HostRoleCommand property of this ServerAction.

This property is expected to be set by the creator of this ServerAction before calling execute.

Parameters:

hostRoleCommand - the HostRoleCommand data to set

execute

CommandReport execute(ConcurrentMap<String,Object> requestSharedDataContext)
               throws org.apache.ambari.server.AmbariException,
                      InterruptedException

Executes this ServerAction

This is typically called by the ServerActionExecutor in it's own thread, but there is no guarantee that this is the case. It is expected that the ExecutionCommand and HostRoleCommand properties are set before calling this method.

Parameters:

requestSharedDataContext - a Map to be used a shared data among all ServerActions related to a given request

Returns:

a CommandReport declaring the status of the task

Throws:

org.apache.ambari.server.AmbariException

InterruptedException