org.apache.ambari.server.controller

Class ActionExecutionContext

java.lang.Object

org.apache.ambari.server.controller.ActionExecutionContext

public class ActionExecutionContext
extends Object

The context required to create tasks and stages for a custom action

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ActionExecutionContext.ExecutionCommandVisitor Interface that allows a final attempt to setting values on an ExecutionCommand

Constructor Summary

Constructors

Constructor and Description
ActionExecutionContext(String clusterName, String actionName, List<RequestResourceFilter> resourceFilters)
ActionExecutionContext(String clusterName, String commandName, List<RequestResourceFilter> resourceFilters, Map<String,String> parameters)
ActionExecutionContext(String clusterName, String actionName, List<RequestResourceFilter> resourceFilters, Map<String,String> parameters, TargetHostType targetType, Integer timeout, String expectedServiceName, String expectedComponentName) Create an ActionExecutionContext to execute an action from a request

Method Summary

Modifier and Type	Method and Description
void	addVisitor(ActionExecutionContext.ExecutionCommandVisitor visitor) Adds a command visitor that will be invoked after a command is created.
String	getActionName()
String	getClusterName()
String	getExpectedComponentName()
String	getExpectedServiceName()
RequestOperationLevel	getOperationLevel()
Map<String,String>	getParameters()
List<RequestResourceFilter>	getResourceFilters()
StackId	getStackId() Gets the stack to use for generating stack-associated values for a command.
TargetHostType	getTargetType()
Integer	getTimeout()
boolean	isFailureAutoSkipped() Gets whether skippable actions that failed are automatically skipped.
boolean	isFutureCommand() Gets whether Ambari should skip all kinds of command verifications while scheduling since this command runs in the future and might not be considered "valid".
boolean	isMaintenanceModeHostExcluded() Gets whether hosts in maintenance mode should be excluded from the command.
boolean	isRetryAllowed() Gets whether the action can be retried if it failed.
void	setAutoSkipFailures(boolean autoSkipFailures) Sets whether skippable action that failed are automatically skipped.
void	setIsFutureCommand(boolean isFutureCommand) Sets whether Ambari should skip all kinds of command verifications while scheduling since this command runs in the future and might not be considered "valid".
void	setMaintenanceModeHostExcluded(boolean excluded) Sets whether hosts in maintenance mode should be excluded from the command.
void	setOperationLevel(RequestOperationLevel operationLevel)
void	setRetryAllowed(boolean allowRetry) Sets whether the action can be retried if it fails.
void	setStackId(StackId stackId) Sets the stack to use for generating stack-associated values for a command.
void	setTimeout(Integer timeout)
String	toString()
void	visitAll(ExecutionCommand command) Called as a way to post-process the command after it has been created and various objects have been set.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionExecutionContext

public ActionExecutionContext(String clusterName,
                              String actionName,
                              List<RequestResourceFilter> resourceFilters,
                              Map<String,String> parameters,
                              TargetHostType targetType,
                              Integer timeout,
                              String expectedServiceName,
                              String expectedComponentName)

Create an ActionExecutionContext to execute an action from a request

ActionExecutionContext

public ActionExecutionContext(String clusterName,
                              String actionName,
                              List<RequestResourceFilter> resourceFilters)

ActionExecutionContext

public ActionExecutionContext(String clusterName,
                              String commandName,
                              List<RequestResourceFilter> resourceFilters,
                              Map<String,String> parameters)

Method Detail

getClusterName

public String getClusterName()

getActionName

public String getActionName()

getParameters

public Map<String,String> getParameters()

getTargetType

public TargetHostType getTargetType()

getTimeout

public Integer getTimeout()

setTimeout

public void setTimeout(Integer timeout)

getResourceFilters

public List<RequestResourceFilter> getResourceFilters()

getOperationLevel

public RequestOperationLevel getOperationLevel()

setOperationLevel

public void setOperationLevel(RequestOperationLevel operationLevel)

getExpectedServiceName

public String getExpectedServiceName()

getExpectedComponentName

public String getExpectedComponentName()

isRetryAllowed

public boolean isRetryAllowed()

Gets whether the action can be retried if it failed. The default is true).

Returns:

true if the action can be retried if it fails.

setRetryAllowed

public void setRetryAllowed(boolean allowRetry)

Sets whether the action can be retried if it fails.

Parameters:

allowRetry - true if the action can be retried if it fails.

isFailureAutoSkipped

public boolean isFailureAutoSkipped()

Gets whether skippable actions that failed are automatically skipped.

Returns:

the autoSkipFailures

setAutoSkipFailures

public void setAutoSkipFailures(boolean autoSkipFailures)

Sets whether skippable action that failed are automatically skipped.

Parameters:

autoSkipFailures - true to automatically skip failures which are marked as skippable.

getStackId

public StackId getStackId()

Gets the stack to use for generating stack-associated values for a command. In some cases the cluster's stack is not the correct one to use, such as when distributing a repository.

Returns:

the stack to use when generating stack-specific content for the command.

setStackId

public void setStackId(StackId stackId)

Sets the stack to use for generating stack-associated values for a command. In some cases the cluster's stack is not the correct one to use, such as when distributing a repository.

Parameters:

stackId - the stackId to use for stack-based properties on the command.

addVisitor

public void addVisitor(ActionExecutionContext.ExecutionCommandVisitor visitor)

Adds a command visitor that will be invoked after a command is created. Provides access to the command.

Parameters:

visitor - the visitor

toString

public String toString()

Overrides:

toString in class Object

isMaintenanceModeHostExcluded

public boolean isMaintenanceModeHostExcluded()

Gets whether hosts in maintenance mode should be excluded from the command.

Returns:

true to exclude any hosts in maintenance mode from the command, false to include hosts which are in maintenance mode.

setMaintenanceModeHostExcluded

public void setMaintenanceModeHostExcluded(boolean excluded)

Sets whether hosts in maintenance mode should be excluded from the command.

Parameters:

excluded - true to exclude any hosts in maintenance mode from the command, false to include hosts which are in maintenance mode.

visitAll

public void visitAll(ExecutionCommand command)

Called as a way to post-process the command after it has been created and various objects have been set.

Parameters:

command - the command

isFutureCommand

public boolean isFutureCommand()

Gets whether Ambari should skip all kinds of command verifications while scheduling since this command runs in the future and might not be considered "valid".

A use case for this would be during an upgrade where trying to schedule commands for a component which has yet to be added to the cluster (since it's added as part of the upgrade).

Returns:

true if the command is scheduled to run in the future.

setIsFutureCommand

public void setIsFutureCommand(boolean isFutureCommand)

Sets whether Ambari should skip all kinds of command verifications while scheduling since this command runs in the future and might not be considered "valid".

A use case for this would be during an upgrade where trying to schedule commands for a component which has yet to be added to the cluster (since it's added as part of the upgrade).

Parameters:

isFutureCommand - true to have Ambari skip verification of things like component hosts while scheduling commands.