org.apache.ambari.server.serveraction

Class AbstractServerAction

java.lang.Object

org.apache.ambari.server.serveraction.AbstractServerAction

All Implemented Interfaces:

ServerAction

Direct Known Subclasses:

AbstractUpgradeServerAction, KerberosServerAction, PostUserCreationHookServerAction, UpdateKerberosConfigsServerAction

public abstract class AbstractServerAction
extends Object
implements ServerAction

AbstractServerAction is an abstract implementation of a ServerAction.

This abstract implementation provides common facilities for all ServerActions, such as maintaining the ExecutionCommand and HostRoleCommand properties. It also provides a convenient way to generate CommandReports for reporting status.

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionLog	actionLog The ActionLog that used to log execution progress of ServerAction
protected com.google.gson.Gson	gson Used to deserialized JSON.

Fields inherited from interface org.apache.ambari.server.serveraction.ServerAction

ACTION_NAME, ACTION_USER_NAME, DEFAULT_LONG_RUNNING_TASK_TIMEOUT_SECONDS, WRAPPED_CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractServerAction()

Method Summary

Modifier and Type	Method and Description
protected void	auditLog(AuditEvent ae)
protected CommandReport	createCommandReport(int exitCode, HostRoleStatus status, String structuredOut, String stdout, String stderr) Creates a CommandReport used to report back to Ambari the status of this ServerAction.
protected CommandReport	createCompletedCommandReport()
protected Map<String,String>	getCommandParameters() Returns the command parameters value from the ExecutionCommand The returned map should be assumed to be read-only.
protected String	getCommandParameterValue(String propertyName) Attempts to safely retrieve a property with the specified name from the this action's relevant command parameters Map.
ExecutionCommand	getExecutionCommand() Gets the ExecutionCommand property of this ServerAction.
HostRoleCommand	getHostRoleCommand() Gets the HostRoleCommand property of this ServerAction.
void	setExecutionCommand(ExecutionCommand executionCommand) Sets the ExecutionCommand property of this ServerAction.
void	setHostRoleCommand(HostRoleCommand hostRoleCommand) Sets the HostRoleCommand property of this ServerAction.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ambari.server.serveraction.ServerAction

execute

Field Detail

actionLog

protected ActionLog actionLog

The ActionLog that used to log execution progress of ServerAction

gson

@Inject
protected com.google.gson.Gson gson

Used to deserialized JSON.

Constructor Detail

AbstractServerAction

public AbstractServerAction()

Method Detail

getExecutionCommand

public ExecutionCommand getExecutionCommand()

Description copied from interface: ServerAction

Gets the ExecutionCommand property of this ServerAction.

Specified by:

getExecutionCommand in interface ServerAction

Returns:

the ExecutionCommand property of this ServerAction

setExecutionCommand

public void setExecutionCommand(ExecutionCommand executionCommand)

Description copied from interface: ServerAction

Sets the ExecutionCommand property of this ServerAction.

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

Specified by:

setExecutionCommand in interface ServerAction

Parameters:

executionCommand - the ExecutionCommand data to set

getHostRoleCommand

public HostRoleCommand getHostRoleCommand()

Description copied from interface: ServerAction

Gets the HostRoleCommand property of this ServerAction.

Specified by:

getHostRoleCommand in interface ServerAction

Returns:

the HostRoleCommand property of this ServerAction

setHostRoleCommand

public void setHostRoleCommand(HostRoleCommand hostRoleCommand)

Description copied from interface: ServerAction

Sets the HostRoleCommand property of this ServerAction.

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

Specified by:

setHostRoleCommand in interface ServerAction

Parameters:

hostRoleCommand - the HostRoleCommand data to set

createCompletedCommandReport

protected CommandReport createCompletedCommandReport()

Returns:

a command report with 0 exit code and COMPLETED HostRoleStatus

createCommandReport

protected CommandReport createCommandReport(int exitCode,
                                            HostRoleStatus status,
                                            String structuredOut,
                                            String stdout,
                                            String stderr)

Creates a CommandReport used to report back to Ambari the status of this ServerAction.

Parameters:

exitCode - an integer value declaring the exit code for this action - 0 typically indicates success.

status - a HostRoleStatus indicating the status of this action

structuredOut - a String containing the (typically) JSON-formatted data representing the output from this action (this data is stored in the database, along with the command status)

stdout - A string containing the data from the standard out stream (this data is stored in the database, along with the command status)

stderr - A string containing the data from the standard error stream (this data is stored in the database, along with the command status)

Returns:

the generated CommandReport, or null if the HostRoleCommand or ExecutionCommand properties are missing

getCommandParameters

protected Map<String,String> getCommandParameters()

Returns the command parameters value from the ExecutionCommand

The returned map should be assumed to be read-only.

Returns:

the (assumed read-only) command parameters value from the ExecutionCommand

getCommandParameterValue

protected String getCommandParameterValue(String propertyName)

Attempts to safely retrieve a property with the specified name from the this action's relevant command parameters Map.

Parameters:

propertyName - a String declaring the name of the item from commandParameters to retrieve

Returns:

the value of the requested property, or null if not found or set

auditLog

protected void auditLog(AuditEvent ae)