org.apache.ambari.server.actionmanager

Class HostRoleCommand

java.lang.Object

org.apache.ambari.server.actionmanager.HostRoleCommand

public class HostRoleCommand
extends Object

This class encapsulates the information for an task on a host for a particular role which action manager needs. It doesn't capture actual command and parameters, but just the stuff enough for action manager to track the request.

Since this class is cached by the ActionDBAccessor, it should not hold references to JPA entities. It's possible that by holding onto JPA entities, they will inadvertently hold onto the entire cache of entities in the L1 cache.

Field Summary

Fields

Modifier and Type	Field and Description
String	errorLog
String	outputLog

Constructor Summary

Constructors

Constructor and Description
HostRoleCommand(HostRoleCommandEntity hostRoleCommandEntity, HostDAO hostDAO, ExecutionCommandDAO executionCommandDAO, ExecutionCommandWrapperFactory ecwFactory)
HostRoleCommand(Host host, Role role, ServiceComponentHostEvent event, RoleCommand roleCommand, boolean retryAllowed, boolean autoSkipFailure, HostDAO hostDAO, ExecutionCommandDAO executionCommandDAO, ExecutionCommandWrapperFactory ecwFactory)
HostRoleCommand(String hostName, Role role, ServiceComponentHostEvent event, RoleCommand roleCommand, boolean retryAllowed, boolean autoSkipFailure, HostDAO hostDAO, ExecutionCommandDAO executionCommandDAO, ExecutionCommandWrapperFactory ecwFactory) Simple constructor, should be created using the Factory class.
HostRoleCommand(String hostName, Role role, ServiceComponentHostEvent event, RoleCommand command, HostDAO hostDAO, ExecutionCommandDAO executionCommandDAO, ExecutionCommandWrapperFactory ecwFactory) Simple constructor, should be created using the Factory class.

Method Summary

Modifier and Type	Method and Description
HostRoleCommandEntity	constructNewPersistenceEntity()
boolean	equals(Object other)
short	getAttemptCount()
String	getCommandDetail()
String	getCustomCommandName()
long	getEndTime()
String	getErrorLog()
ServiceComponentHostEventWrapper	getEvent()
ExecutionCommandWrapper	getExecutionCommandWrapper()
int	getExitCode()
long	getHostId()
String	getHostName()
long	getLastAttemptTime()
String	getOpsDisplayName()
long	getOriginalStartTime()
String	getOutputLog()
long	getRequestId()
Role	getRole()
RoleCommand	getRoleCommand()
long	getStageId()
long	getStartTime()
HostRoleStatus	getStatus()
String	getStderr()
String	getStdout()
String	getStructuredOut()
long	getTaskId()
int	hashCode()
void	incrementAttemptCount()
boolean	isBackgroundCommand() Gets whether this command runs in the background and does not block other commands.
boolean	isFailureAutoSkipped() Gets whether commands which fail and are retryable are automatically skipped and marked with HostRoleStatus.SKIPPED_FAILED.
boolean	isRetryAllowed()
void	setBackgroundCommand(boolean isBackgroundCommand) Sets whether this command runs in the background and does not block other commands.
void	setCommandDetail(String commandDetail)
void	setCustomCommandName(String customCommandName)
void	setEndTime(long endTime)
void	setErrorLog(String errorLog)
void	setExecutionCommandWrapper(ExecutionCommandWrapper executionCommandWrapper)
void	setExitCode(int exitCode)
void	setHost(long hostId, String hostName) Sets the host ID and name for the host associated with this command.
void	setLastAttemptTime(long lastAttemptTime)
void	setOpsDisplayName(String opsDisplayName)
void	setOriginalStartTime(long originalStartTime)
void	setOutputLog(String outputLog)
void	setRequestId(long requestId)
void	setRoleCommand(RoleCommand roleCommand)
void	setStageId(long stageId)
void	setStartTime(long startTime)
void	setStatus(HostRoleStatus status)
void	setStderr(String stderr)
void	setStdout(String stdout)
void	setStructuredOut(String structuredOut)
void	setTaskId(long taskId)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

outputLog

public String outputLog

errorLog

public String errorLog

Constructor Detail

HostRoleCommand

public HostRoleCommand(String hostName,
                       Role role,
                       ServiceComponentHostEvent event,
                       RoleCommand command,
                       HostDAO hostDAO,
                       ExecutionCommandDAO executionCommandDAO,
                       ExecutionCommandWrapperFactory ecwFactory)

Simple constructor, should be created using the Factory class.

Parameters:

hostName - Host name

role - Action to run

event - Event on the host and component

command - Type of command

hostDAO - HostDAO instance being injected

HostRoleCommand

public HostRoleCommand(String hostName,
                       Role role,
                       ServiceComponentHostEvent event,
                       RoleCommand roleCommand,
                       boolean retryAllowed,
                       boolean autoSkipFailure,
                       HostDAO hostDAO,
                       ExecutionCommandDAO executionCommandDAO,
                       ExecutionCommandWrapperFactory ecwFactory)

Simple constructor, should be created using the Factory class.

Parameters:

hostName - Host name

role - Action to run

event - Event on the host and component

roleCommand - Type of command

retryAllowed - Whether the command can be repeated

hostDAO - HostDAO instance being injected

HostRoleCommand

public HostRoleCommand(Host host,
                       Role role,
                       ServiceComponentHostEvent event,
                       RoleCommand roleCommand,
                       boolean retryAllowed,
                       boolean autoSkipFailure,
                       HostDAO hostDAO,
                       ExecutionCommandDAO executionCommandDAO,
                       ExecutionCommandWrapperFactory ecwFactory)

HostRoleCommand

public HostRoleCommand(HostRoleCommandEntity hostRoleCommandEntity,
                       HostDAO hostDAO,
                       ExecutionCommandDAO executionCommandDAO,
                       ExecutionCommandWrapperFactory ecwFactory)

Method Detail

constructNewPersistenceEntity

public HostRoleCommandEntity constructNewPersistenceEntity()

getTaskId

public long getTaskId()

setRequestId

public void setRequestId(long requestId)

setStageId

public void setStageId(long stageId)

setTaskId

public void setTaskId(long taskId)

setHost

public void setHost(long hostId,
                    String hostName)

Sets the host ID and name for the host associated with this command.

Parameters:

hostId -

hostName -

getHostName

public String getHostName()

getHostId

public long getHostId()

getRole

public Role getRole()

getCommandDetail

public String getCommandDetail()

setCommandDetail

public void setCommandDetail(String commandDetail)

getOpsDisplayName

public String getOpsDisplayName()

setOpsDisplayName

public void setOpsDisplayName(String opsDisplayName)

getCustomCommandName

public String getCustomCommandName()

setCustomCommandName

public void setCustomCommandName(String customCommandName)

getStatus

public HostRoleStatus getStatus()

setStatus

public void setStatus(HostRoleStatus status)

getEvent

public ServiceComponentHostEventWrapper getEvent()

getStdout

public String getStdout()

setStdout

public void setStdout(String stdout)

getStderr

public String getStderr()

setStderr

public void setStderr(String stderr)

getOutputLog

public String getOutputLog()

setOutputLog

public void setOutputLog(String outputLog)

getErrorLog

public String getErrorLog()

setErrorLog

public void setErrorLog(String errorLog)

getExitCode

public int getExitCode()

setExitCode

public void setExitCode(int exitCode)

getStartTime

public long getStartTime()

setStartTime

public void setStartTime(long startTime)

getOriginalStartTime

public long getOriginalStartTime()

setOriginalStartTime

public void setOriginalStartTime(long originalStartTime)

getLastAttemptTime

public long getLastAttemptTime()

setLastAttemptTime

public void setLastAttemptTime(long lastAttemptTime)

getAttemptCount

public short getAttemptCount()

incrementAttemptCount

public void incrementAttemptCount()

isRetryAllowed

public boolean isRetryAllowed()

getStructuredOut

public String getStructuredOut()

setStructuredOut

public void setStructuredOut(String structuredOut)

getEndTime

public long getEndTime()

setEndTime

public void setEndTime(long endTime)

getExecutionCommandWrapper

public ExecutionCommandWrapper getExecutionCommandWrapper()

setExecutionCommandWrapper

public void setExecutionCommandWrapper(ExecutionCommandWrapper executionCommandWrapper)

getRoleCommand

public RoleCommand getRoleCommand()

setRoleCommand

public void setRoleCommand(RoleCommand roleCommand)

getStageId

public long getStageId()

getRequestId

public long getRequestId()

isBackgroundCommand

public boolean isBackgroundCommand()

Gets whether this command runs in the background and does not block other commands.

Returns:

true if this command runs in the background, false otherise.

setBackgroundCommand

public void setBackgroundCommand(boolean isBackgroundCommand)

Sets whether this command runs in the background and does not block other commands.

Parameters:

isBackgroundCommand - true if this command runs in the background, false otherise.

isFailureAutoSkipped

public boolean isFailureAutoSkipped()

Gets whether commands which fail and are retryable are automatically skipped and marked with HostRoleStatus.SKIPPED_FAILED.

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object