org.apache.ambari.server.controller

Class AmbariCustomCommandExecutionHelper

java.lang.Object

org.apache.ambari.server.controller.AmbariCustomCommandExecutionHelper

public class AmbariCustomCommandExecutionHelper
extends Object

Helper class containing logic to process custom command execution requests . This class has special support needed for SERVICE_CHECK and DECOMMISSION. These commands are not pass through as Ambari has specific persistence requirements.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_DECOMMISSIONED_HOSTS
static String	DECOM_EXCLUDED_HOSTS
static String	DECOM_INCLUDED_HOSTS
static String	DECOM_SLAVE_COMPONENT
static String	DECOMMISSION_COMMAND_NAME
static String	HBASE_MARK_DRAINING_ONLY
protected static String	INSTALL_COMMAND_NAME
static String	IS_ADD_OR_DELETE_SLAVE_REQUEST
static int	MIN_STRICT_SERVICE_CHECK_TIMEOUT
protected static String	RESTART_COMMAND_NAME
protected static String	SERVICE_CHECK_COMMAND_NAME
protected static String	START_COMMAND_NAME
static String	UPDATE_FILES_ONLY

Constructor Summary

Constructors

Constructor and Description
AmbariCustomCommandExecutionHelper()

Method Summary

Modifier and Type	Method and Description
void	addExecutionCommandsToStage(ActionExecutionContext actionExecutionContext, Stage stage, Map<String,String> requestParams, ExecuteCommandJson executeCommandJson) Other than Service_Check and Decommission all other commands are pass-through
void	addServiceCheckAction(Stage stage, String hostname, String smokeTestRole, long nowTimestamp, String serviceName, String componentName, Map<String,String> actionParameters, boolean retryAllowed, boolean autoSkipFailure, boolean useLatestConfigs) Creates and populates service check EXECUTION_COMMAND for host.
ExecuteCommandJson	getCommandJson(ActionExecutionContext actionExecContext, Cluster cluster, StackId stackId, String requestContext) Helper method to fill execution command information.
String	getStatusCommandTimeout(ServiceInfo serviceInfo)
boolean	isTopologyRefreshRequired(String actionName, String clusterName, String serviceName) Determine whether or not the action should trigger a topology refresh.
void	validateAction(ExecuteActionRequest actionRequest) Validate custom command and throw exception is invalid request.

Methods inherited from class java.lang.Object

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

Field Detail

DECOM_INCLUDED_HOSTS

public static final String DECOM_INCLUDED_HOSTS

See Also:

Constant Field Values

DECOM_EXCLUDED_HOSTS

public static final String DECOM_EXCLUDED_HOSTS

See Also:

Constant Field Values

ALL_DECOMMISSIONED_HOSTS

public static final String ALL_DECOMMISSIONED_HOSTS

See Also:

Constant Field Values

DECOM_SLAVE_COMPONENT

public static final String DECOM_SLAVE_COMPONENT

See Also:

Constant Field Values

HBASE_MARK_DRAINING_ONLY

public static final String HBASE_MARK_DRAINING_ONLY

See Also:

Constant Field Values

UPDATE_FILES_ONLY

public static final String UPDATE_FILES_ONLY

See Also:

Constant Field Values

IS_ADD_OR_DELETE_SLAVE_REQUEST

public static final String IS_ADD_OR_DELETE_SLAVE_REQUEST

See Also:

Constant Field Values

MIN_STRICT_SERVICE_CHECK_TIMEOUT

public static final int MIN_STRICT_SERVICE_CHECK_TIMEOUT

See Also:

Constant Field Values

SERVICE_CHECK_COMMAND_NAME

protected static final String SERVICE_CHECK_COMMAND_NAME

See Also:

Constant Field Values

START_COMMAND_NAME

protected static final String START_COMMAND_NAME

See Also:

Constant Field Values

RESTART_COMMAND_NAME

protected static final String RESTART_COMMAND_NAME

See Also:

Constant Field Values

INSTALL_COMMAND_NAME

protected static final String INSTALL_COMMAND_NAME

See Also:

Constant Field Values

DECOMMISSION_COMMAND_NAME

public static final String DECOMMISSION_COMMAND_NAME

See Also:

Constant Field Values

Constructor Detail

AmbariCustomCommandExecutionHelper

public AmbariCustomCommandExecutionHelper()

Method Detail

addServiceCheckAction

public void addServiceCheckAction(Stage stage,
                                  String hostname,
                                  String smokeTestRole,
                                  long nowTimestamp,
                                  String serviceName,
                                  String componentName,
                                  Map<String,String> actionParameters,
                                  boolean retryAllowed,
                                  boolean autoSkipFailure,
                                  boolean useLatestConfigs)
                           throws org.apache.ambari.server.AmbariException

Creates and populates service check EXECUTION_COMMAND for host. Not all EXECUTION_COMMAND parameters are populated here because they are not needed by service check.

Throws:

org.apache.ambari.server.AmbariException

validateAction

public void validateAction(ExecuteActionRequest actionRequest)
                    throws org.apache.ambari.server.AmbariException

Validate custom command and throw exception is invalid request.

Parameters:

actionRequest - the action request

Throws:

org.apache.ambari.server.AmbariException - if the action can not be validated

addExecutionCommandsToStage

public void addExecutionCommandsToStage(ActionExecutionContext actionExecutionContext,
                                        Stage stage,
                                        Map<String,String> requestParams,
                                        ExecuteCommandJson executeCommandJson)
                                 throws org.apache.ambari.server.AmbariException

Other than Service_Check and Decommission all other commands are pass-through

Parameters:

actionExecutionContext - received request to execute a command

stage - the initial stage for task creation

requestParams - the request params

executeCommandJson - set of json arguments passed to the request

Throws:

org.apache.ambari.server.AmbariException - if the commands can not be added

getCommandJson

public ExecuteCommandJson getCommandJson(ActionExecutionContext actionExecContext,
                                         Cluster cluster,
                                         StackId stackId,
                                         String requestContext)
                                  throws org.apache.ambari.server.AmbariException

Helper method to fill execution command information.

Parameters:

actionExecContext - the context

cluster - the cluster for the command

stackId - the stack id used to load service metainfo.

Returns:

a wrapper of the important JSON structures to add to a stage

Throws:

org.apache.ambari.server.AmbariException

isTopologyRefreshRequired

public boolean isTopologyRefreshRequired(String actionName,
                                         String clusterName,
                                         String serviceName)
                                  throws org.apache.ambari.server.AmbariException

Determine whether or not the action should trigger a topology refresh.

Parameters:

actionName - the action name (i.e. START, RESTART)

clusterName - the cluster name

serviceName - the service name

Returns:

true if a topology refresh is required for the action

Throws:

org.apache.ambari.server.AmbariException

getStatusCommandTimeout

public String getStatusCommandTimeout(ServiceInfo serviceInfo)
                               throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException