org.apache.ambari.server.controller.internal

Class CalculatedStatus

java.lang.Object

org.apache.ambari.server.controller.internal.CalculatedStatus

public class CalculatedStatus
extends Object

Status of a request resource, calculated from a set of tasks or stages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CalculatedStatus.StatusType kind of HostRoleStatus persisted by Stage and Request

Field Summary

Fields

Modifier and Type	Field and Description
static CalculatedStatus	ABORTED A status which represents an ABORTED state at -1%
static CalculatedStatus	COMPLETED A status which represents a COMPLETED state at 100%
static CalculatedStatus	PENDING A status which represents a PENDING state at 0%

Method Summary

Modifier and Type	Method and Description
static HostRoleStatus	calculateStageStatus(List<HostRoleCommand> hostRoleCommands, Map<HostRoleStatus,Integer> counters, Map<Role,Float> successFactors, boolean skippable)
static Map<HostRoleStatus,Integer>	calculateStatusCounts(Collection<HostRoleStatus> hostRoleStatuses) Returns counts of tasks that are in various states.
static Map<CalculatedStatus.StatusType,Map<HostRoleStatus,Integer>>	calculateStatusCountsForStage(Collection<TaskStatusListener.ActiveStage> stages) Returns map for counts of stages that are in various states.
static Map<HostRoleStatus,Integer>	calculateStatusCountsForTasks(Collection<HostRoleCommand> hostRoleCommands) Returns counts of tasks that are in various states.
static Map<HostRoleStatus,Integer>	calculateStatusCountsForTasks(Collection<HostRoleCommand> hostRoleCommands, StageEntityPK stage) Returns counts of tasks that are in various states.
static HostRoleStatus	calculateSummaryDisplayStatus(Map<HostRoleStatus,Integer> counters, int total, boolean skippable) Calculate an overall display status based on the given status counts.
static HostRoleStatus	calculateSummaryStatus(Map<HostRoleStatus,Integer> counters, int total, boolean skippable) Calculate overall status of a stage or upgrade based on the given status counts.
static HostRoleStatus	calculateSummaryStatusFromPartialSet(Map<HostRoleStatus,Integer> counters, boolean skippable)
protected static HostRoleStatus	calculateSummaryStatusOfUpgrade(Map<HostRoleStatus,Integer> counters, int total) Calculate overall status of an upgrade.
static Map<HostRoleStatus,Integer>	calculateTaskEntityStatusCounts(Collection<HostRoleCommandEntity> tasks) Returns counts of task entities that are in various states.
static Map<HostRoleStatus,Integer>	calculateTaskStatusCounts(Map<Long,HostRoleCommandStatusSummaryDTO> stageDto, Set<Long> stageIds) Return counts of task statuses.
protected static Boolean	didStageFailed(List<HostRoleCommand> hostRoleCommands, Set<Role> roles, Map<Role,Float> successFactors)
HostRoleStatus	getDisplayStatus() Get the calculated display status.
protected static List<HostRoleCommand>	getFailedHostRoleCommands(List<HostRoleCommand> hostRoleCommands)
protected static List<HostRoleCommand>	getHostRoleCommandsOfRole(List<HostRoleCommand> hostRoleCommands, Role role)
static HostRoleStatus	getOverallDisplayStatusForRequest(Collection<HostRoleStatus> hostRoleStatuses) Calculate overall display status from collection of statuses
static HostRoleStatus	getOverallStatusForRequest(Collection<HostRoleStatus> hostRoleStatuses) Calculate overall status from collection of statuses
double	getPercent() Get the calculated percent complete.
protected static Set<Role>	getRolesOfAbortedTasks(List<HostRoleCommand> hostRoleCommands) Get all Role any of whose tasks is in HostRoleStatus.ABORTED
protected static Set<Role>	getRolesOfFailedTasks(List<HostRoleCommand> hostRoleCommands) Get all Role any of whose tasks is in HostRoleStatus.FAILED
protected static Set<Role>	getRolesOfTasks(List<HostRoleCommand> hostRoleCommands, HostRoleStatus status) Get all Role any of whose tasks are in given status
protected static Set<Role>	getRolesOfTimedOutTasks(List<HostRoleCommand> hostRoleCommands) Get all Role any of whose tasks is in HostRoleStatus.TIMEDOUT
HostRoleStatus	getStatus() Get the calculated status.
static CalculatedStatus	statusFromRequest(HostRoleCommandDAO s_hostRoleCommandDAO, TopologyManager topologyManager, Long requestId) Calculates the status for specified request by id.
static CalculatedStatus	statusFromStageEntities(Collection<StageEntity> stages) Factory method to create a calculated status.
static CalculatedStatus	statusFromStages(Collection<Stage> stages) Factory method to create a calculated status.
static CalculatedStatus	statusFromStageSummary(Map<Long,HostRoleCommandStatusSummaryDTO> stageDto, Set<Long> stageIds) Calculates the overall status of an upgrade.
static CalculatedStatus	statusFromTaskEntities(Collection<HostRoleCommandEntity> tasks, boolean skippable) Factory method to create a calculated status.

Methods inherited from class java.lang.Object

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

Field Detail

COMPLETED

public static final CalculatedStatus COMPLETED

A status which represents a COMPLETED state at 100%

PENDING

public static final CalculatedStatus PENDING

A status which represents a PENDING state at 0%

ABORTED

public static final CalculatedStatus ABORTED

A status which represents an ABORTED state at -1%

Method Detail

getStatus

public HostRoleStatus getStatus()

Get the calculated status.

Returns:

the status

getDisplayStatus

public HostRoleStatus getDisplayStatus()

Get the calculated display status. The display_status field is used as a hint for UI. It's effective only on UpgradeGroup level. We should expose it for the following states: SKIPPED_FAILED FAILED

Returns:

the display status

getPercent

public double getPercent()

Get the calculated percent complete.

Returns:

the percent complete

statusFromTaskEntities

public static CalculatedStatus statusFromTaskEntities(Collection<HostRoleCommandEntity> tasks,
                                                      boolean skippable)

Factory method to create a calculated status. Calculate request status from the given collection of task entities.

Parameters:

tasks - the collection of task entities

skippable - true if a single failed status should NOT result in an overall failed status

Returns:

a calculated status

statusFromStageEntities

public static CalculatedStatus statusFromStageEntities(Collection<StageEntity> stages)

Factory method to create a calculated status. Calculate request status from the given collection of stage entities.

Parameters:

stages - the collection of stage entities

Returns:

a calculated status

statusFromStages

public static CalculatedStatus statusFromStages(Collection<Stage> stages)

Factory method to create a calculated status. Calculate request status from the given collection of stages.

Parameters:

stages - the collection of stages

Returns:

a calculated status

calculateStatusCounts

public static Map<HostRoleStatus,Integer> calculateStatusCounts(Collection<HostRoleStatus> hostRoleStatuses)

Returns counts of tasks that are in various states.

Parameters:

hostRoleStatuses - the collection of tasks

Returns:

a map of counts of tasks keyed by the task status

calculateStatusCountsForTasks

public static Map<HostRoleStatus,Integer> calculateStatusCountsForTasks(Collection<HostRoleCommand> hostRoleCommands)

Returns counts of tasks that are in various states.

Parameters:

hostRoleCommands - collection of beans HostRoleCommand

Returns:

a map of counts of tasks keyed by the task status

calculateStatusCountsForStage

public static Map<CalculatedStatus.StatusType,Map<HostRoleStatus,Integer>> calculateStatusCountsForStage(Collection<TaskStatusListener.ActiveStage> stages)

Returns map for counts of stages that are in various states.

Parameters:

stages - collection of beans TaskStatusListener.ActiveStage

Returns:

a map of counts of tasks keyed by the task status

calculateStatusCountsForTasks

public static Map<HostRoleStatus,Integer> calculateStatusCountsForTasks(Collection<HostRoleCommand> hostRoleCommands,
                                                                        StageEntityPK stage)

Returns counts of tasks that are in various states.

Parameters:

hostRoleCommands - collection of beans HostRoleCommand

Returns:

a map of counts of tasks keyed by the task status

calculateTaskEntityStatusCounts

public static Map<HostRoleStatus,Integer> calculateTaskEntityStatusCounts(Collection<HostRoleCommandEntity> tasks)

Returns counts of task entities that are in various states.

Parameters:

tasks - the collection of task entities

Returns:

a map of counts of tasks keyed by the task status

calculateTaskStatusCounts

public static Map<HostRoleStatus,Integer> calculateTaskStatusCounts(Map<Long,HostRoleCommandStatusSummaryDTO> stageDto,
                                                                    Set<Long> stageIds)

Return counts of task statuses.

Parameters:

stageDto - the map of stage-to-summary value objects

stageIds - the stage ids to consider from the value objects

Returns:

the map of status to counts

statusFromRequest

public static CalculatedStatus statusFromRequest(HostRoleCommandDAO s_hostRoleCommandDAO,
                                                 TopologyManager topologyManager,
                                                 Long requestId)

Calculates the status for specified request by id.

Parameters:

s_hostRoleCommandDAO - is used to retrieve the map of stage-to-summary value objects

topologyManager - topology manager

requestId - the request id

Returns:

the calculated status

statusFromStageSummary

public static CalculatedStatus statusFromStageSummary(Map<Long,HostRoleCommandStatusSummaryDTO> stageDto,
                                                      Set<Long> stageIds)

Calculates the overall status of an upgrade. If there are no tasks, then a status of HostRoleStatus.COMPLETED is returned.

Parameters:

stageDto - the map of stage-to-summary value objects

stageIds - the stage ids to consider from the value objects

Returns:

the calculated status

calculateSummaryStatus

public static HostRoleStatus calculateSummaryStatus(Map<HostRoleStatus,Integer> counters,
                                                    int total,
                                                    boolean skippable)

Calculate overall status of a stage or upgrade based on the given status counts.

Parameters:

counters - counts of resources that are in various states

total - total number of resources in request. NOTE, completed tasks may be counted twice.

skippable - true if a single failed status should NOT result in an overall failed status return

Returns:

summary request status based on statuses of tasks in different states.

calculateSummaryStatusFromPartialSet

public static HostRoleStatus calculateSummaryStatusFromPartialSet(Map<HostRoleStatus,Integer> counters,
                                                                  boolean skippable)

Parameters:

counters - counts of resources that are in various states

skippable - {Boolean} TRUE if failure of any of the task should not fail the stage

Returns:

HostRoleStatus

calculateStageStatus

public static HostRoleStatus calculateStageStatus(List<HostRoleCommand> hostRoleCommands,
                                                  Map<HostRoleStatus,Integer> counters,
                                                  Map<Role,Float> successFactors,
                                                  boolean skippable)

Parameters:

hostRoleCommands - list of HostRoleCommand for a stage

counters - counts of resources that are in various states

successFactors - Map of roles to their successfactor for a stage

skippable - {Boolean} TRUE if failure of any of the task should not fail the stage

Returns:

HostRoleStatus based on success factor

getRolesOfFailedTasks

protected static Set<Role> getRolesOfFailedTasks(List<HostRoleCommand> hostRoleCommands)

Get all Role any of whose tasks is in HostRoleStatus.FAILED

Parameters:

hostRoleCommands - list of HostRoleCommand

Returns:

Set of Role

getRolesOfTimedOutTasks

protected static Set<Role> getRolesOfTimedOutTasks(List<HostRoleCommand> hostRoleCommands)

Get all Role any of whose tasks is in HostRoleStatus.TIMEDOUT

Parameters:

hostRoleCommands - list of HostRoleCommand

Returns:

Set of Role

getRolesOfAbortedTasks

protected static Set<Role> getRolesOfAbortedTasks(List<HostRoleCommand> hostRoleCommands)

Get all Role any of whose tasks is in HostRoleStatus.ABORTED

Parameters:

hostRoleCommands - list of HostRoleCommand

Returns:

Set of Role

getRolesOfTasks

protected static Set<Role> getRolesOfTasks(List<HostRoleCommand> hostRoleCommands,
                                           HostRoleStatus status)

Get all Role any of whose tasks are in given status

Parameters:

hostRoleCommands - list of HostRoleCommand

status - HostRoleStatus

Returns:

Set of Role

didStageFailed

protected static Boolean didStageFailed(List<HostRoleCommand> hostRoleCommands,
                                        Set<Role> roles,
                                        Map<Role,Float> successFactors)

Parameters:

hostRoleCommands - list of HostRoleCommand for a stage

roles - set of roles to be checked for meeting success criteria

successFactors - map of role to it's success factor

Returns:

{Boolean} TRUE if stage failed due to hostRoleCommands of any role not meeting success criteria

getHostRoleCommandsOfRole

protected static List<HostRoleCommand> getHostRoleCommandsOfRole(List<HostRoleCommand> hostRoleCommands,
                                                                 Role role)

Parameters:

hostRoleCommands - list of HostRoleCommand

role - Role

Returns:

list of HostRoleCommand that belongs to Role

getFailedHostRoleCommands

protected static List<HostRoleCommand> getFailedHostRoleCommands(List<HostRoleCommand> hostRoleCommands)

Parameters:

hostRoleCommands - list of HostRoleCommand

Returns:

list of HostRoleCommand with failed status

getOverallStatusForRequest

public static HostRoleStatus getOverallStatusForRequest(Collection<HostRoleStatus> hostRoleStatuses)

Calculate overall status from collection of statuses

Parameters:

hostRoleStatuses - list of all stage's HostRoleStatus

Returns:

overall status of a request

getOverallDisplayStatusForRequest

public static HostRoleStatus getOverallDisplayStatusForRequest(Collection<HostRoleStatus> hostRoleStatuses)

Calculate overall display status from collection of statuses

Parameters:

hostRoleStatuses - list of all stage's HostRoleStatus

Returns:

overall display status of a request

calculateSummaryStatusOfUpgrade

protected static HostRoleStatus calculateSummaryStatusOfUpgrade(Map<HostRoleStatus,Integer> counters,
                                                                int total)

Calculate overall status of an upgrade.

Parameters:

counters - counts of resources that are in various states

total - total number of resources in request

Returns:

summary request status based on statuses of tasks in different states.

calculateSummaryDisplayStatus

public static HostRoleStatus calculateSummaryDisplayStatus(Map<HostRoleStatus,Integer> counters,
                                                           int total,
                                                           boolean skippable)

Calculate an overall display status based on the given status counts.

Parameters:

counters - counts of resources that are in various states

total - total number of resources in request

skippable - true if a single failed status should NOT result in an overall failed status return

Returns:

summary request status based on statuses of tasks in different states.