org.apache.ambari.server.customactions

Class ActionDefinition

java.lang.Object

org.apache.ambari.server.customactions.ActionDefinition

public class ActionDefinition
extends Object

The resource describing the definition of an action

Constructor Summary

Constructors

Constructor and Description
ActionDefinition(String actionName, ActionType actionType, String inputs, String targetService, String targetComponent, String description, TargetHostType targetType, Integer defaultTimeout, Set<RoleAuthorization> permissions) Create an instance of ActionDefinition

Method Summary

Modifier and Type	Method and Description
ActionResponse	convertToResponse()
String	getActionName()
ActionType	getActionType()
Integer	getDefaultTimeout()
String	getDescription()
String	getInputs()
Set<RoleAuthorization>	getPermissions()
String	getTargetComponent()
String	getTargetService()
TargetHostType	getTargetType()
void	setActionName(String actionName)
void	setActionType(ActionType actionType)
void	setDefaultTimeout(Integer defaultTimeout)
void	setDescription(String description)
void	setInputs(String inputs)
void	setPermissions(Set<RoleAuthorization> permissions)
void	setTargetComponent(String targetComponent)
void	setTargetService(String targetService)
void	setTargetType(TargetHostType targetType)

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionDefinition

public ActionDefinition(String actionName,
                        ActionType actionType,
                        String inputs,
                        String targetService,
                        String targetComponent,
                        String description,
                        TargetHostType targetType,
                        Integer defaultTimeout,
                        Set<RoleAuthorization> permissions)

Create an instance of ActionDefinition

Parameters:

actionName - The name of the action

actionType - The type fo the action

inputs - Expected input of the action

targetService - Target service type (e.g. HDFS)

targetComponent - Target component type (e.g. DATANODE)

description - Short description of the action

targetType - Selection criteria for target hosts

defaultTimeout - The timeout value for this action when executed

permissions - A set of permissions to use when verifiying authorization to execute this action

Method Detail

getActionName

public String getActionName()

setActionName

public void setActionName(String actionName)

getActionType

public ActionType getActionType()

setActionType

public void setActionType(ActionType actionType)

getInputs

public String getInputs()

setInputs

public void setInputs(String inputs)

getTargetService

public String getTargetService()

setTargetService

public void setTargetService(String targetService)

getTargetComponent

public String getTargetComponent()

setTargetComponent

public void setTargetComponent(String targetComponent)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getTargetType

public TargetHostType getTargetType()

setTargetType

public void setTargetType(TargetHostType targetType)

getDefaultTimeout

public Integer getDefaultTimeout()

setDefaultTimeout

public void setDefaultTimeout(Integer defaultTimeout)

setPermissions

public void setPermissions(Set<RoleAuthorization> permissions)

getPermissions

public Set<RoleAuthorization> getPermissions()

convertToResponse

public ActionResponse convertToResponse()