com.mesosphere.sdk.offer

Class TaskUtils

java.lang.Object

com.mesosphere.sdk.offer.TaskUtils

public class TaskUtils
extends java.lang.Object

Various utility methods for manipulating data in TaskInfos.

Method Summary

Modifier and Type	Method and Description
static boolean	areDifferent(TaskSpec oldTaskSpec, TaskSpec newTaskSpec) Determines whether two TaskSpecs are different.
static java.util.Collection<TaskInfo>	clearReservations(java.util.Collection<TaskInfo> taskInfos) Returns TaskInfos will all reservations and persistence IDs removed from their Resources.
static GoalState	getGoalState(PodInstance podInstance, java.lang.String taskName) Gets the GoalState of Task.
static PodInstance	getPodInstance(ConfigStore<ServiceSpec> configStore, TaskInfo taskInfo)
static PodInstance	getPodInstance(PodSpec podSpec, TaskInfo taskInfo)
static java.util.List<PodInstanceRequirement>	getPodRequirements(ConfigStore<ServiceSpec> configStore, java.util.Collection<TaskInfo> failedTasks, java.util.Collection<TaskInfo> allLaunchedTasks) Given a list of all tasks and failed tasks, returns a list of tasks (via returned PodInstanceRequirement.getTasksToLaunch()) that should be relaunched.
static java.util.Optional<PodSpec>	getPodSpec(ServiceSpec serviceSpec, TaskInfo taskInfo) Returns the TaskSpec in the provided DefaultServiceSpec which matches the provided TaskInfo, or null if no match could be found.
static java.util.List<TaskInfo>	getPodTasks(PodInstance podInstance, StateStore stateStore) Returns the TaskInfos associated with a PodInstance if its ever been launched.
static java.lang.String	getStepName(PodInstance podInstance, java.util.Collection<java.lang.String> tasksToLaunch) Returns a default name for a Step given a PodInstance and the tasks to be launched in it.
static java.lang.String	getTaskIPAddress(TaskStatus taskStatus) Gets the IP address associated with the task.
static java.util.List<java.lang.String>	getTaskNames(PodInstance podInstance) Returns all the Task names for a PodInstance.
static java.util.List<java.lang.String>	getTaskNames(PodInstance podInstance, java.util.Collection<java.lang.String> tasksToLaunch) Returns all the task names for a pod, after filtering based on the passed in list of tasks to launch.
static java.util.Optional<TaskSpec>	getTaskSpec(ConfigStore<ServiceSpec> configStore, Protos.TaskInfo taskInfo)
static java.util.Optional<TaskSpec>	getTaskSpec(PodInstance podInstance, java.lang.String taskName)
static java.util.Optional<TaskSpec>	getTaskSpec(ServiceSpec serviceSpec, java.lang.String podType, java.lang.String taskName)
static java.lang.String	getTaskZone(TaskInfo taskInfo) Gets the zone of a task.
static boolean	hasTasksWithTLS(ServiceSpec serviceSpec) Returns whether any tasks within the provided ServiceSpec have transport encryption specs defined.
static boolean	isRecoveryNeeded(TaskStatus taskStatus) Returns whether the provided TaskStatus shows that the task needs to recover.
static boolean	isSamePodInstance(TaskInfo taskInfo, PodInstance podInstance) Returns whether the provided TaskInfo (representing a launched task) and PodInstance (from the ServiceSpec) are both effectively for the same pod instance.
static boolean	isSamePodInstance(TaskInfo taskInfo, java.lang.String type, int index) Returns whether the provided TaskInfo is in the provided pod type and index.
static boolean	isTerminal(TaskState taskState) Returns whether the provided TaskState has reached a terminal state.
static boolean	isTerminal(TaskStatus taskStatus) Returns whether the provided TaskStatus has reached a terminal state.
static boolean	needsRecovery(TaskSpec taskSpec, TaskStatus taskStatus) Determines whether a Task needs to be recovered based on its current definition (TaskSpec) and status (TaskStatus).
static boolean	taskHasZone(TaskInfo taskInfo) Determines if a task is launched in any zones.
static boolean	volumesEqual(TaskSpec first, TaskSpec second) Utility method for checking if volumes changed between the two provided TaskSpecs.

Methods inherited from class java.lang.Object

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

Method Detail

getPodSpec

public static java.util.Optional<PodSpec> getPodSpec(ServiceSpec serviceSpec,
                                                     TaskInfo taskInfo)
                                              throws TaskException

Returns the TaskSpec in the provided DefaultServiceSpec which matches the provided TaskInfo, or null if no match could be found.

Throws:

TaskException

getTaskNames

public static java.util.List<java.lang.String> getTaskNames(PodInstance podInstance)

Returns all the Task names for a PodInstance.

Parameters:

podInstance - A PodInstance

Returns:

A List of all the task names.

getTaskNames

public static java.util.List<java.lang.String> getTaskNames(PodInstance podInstance,
                                                            java.util.Collection<java.lang.String> tasksToLaunch)

Returns all the task names for a pod, after filtering based on the passed in list of tasks to launch.

Parameters:

podInstance - A PodInstance

tasksToLaunch - The names of TaskSpecs which should be launched.

Returns:

A list of the appropriate task names.

hasTasksWithTLS

public static boolean hasTasksWithTLS(ServiceSpec serviceSpec)

Returns whether any tasks within the provided ServiceSpec have transport encryption specs defined.

getPodTasks

public static java.util.List<TaskInfo> getPodTasks(PodInstance podInstance,
                                                   StateStore stateStore)

Returns the TaskInfos associated with a PodInstance if its ever been launched. The list will be empty if the PodInstance has never been launched.

Parameters:

podInstance - A PodInstance

stateStore - A StateStore to search for the appropriate TaskInfos.

Returns:

The list of TaskInfos associated with a PodInstance.

isSamePodInstance

public static boolean isSamePodInstance(TaskInfo taskInfo,
                                        PodInstance podInstance)
                                 throws TaskException

Returns whether the provided TaskInfo (representing a launched task) and PodInstance (from the ServiceSpec) are both effectively for the same pod instance.

Throws:

TaskException

isSamePodInstance

public static boolean isSamePodInstance(TaskInfo taskInfo,
                                        java.lang.String type,
                                        int index)
                                 throws TaskException

Returns whether the provided TaskInfo is in the provided pod type and index.

Throws:

TaskException

areDifferent

public static boolean areDifferent(TaskSpec oldTaskSpec,
                                   TaskSpec newTaskSpec)

Determines whether two TaskSpecs are different.

Parameters:

oldTaskSpec - The previous definition of a Task.

newTaskSpec - The new definition of a Task.

Returns:

true if the Tasks are different, false otherwise.

volumesEqual

public static boolean volumesEqual(TaskSpec first,
                                   TaskSpec second)

Utility method for checking if volumes changed between the two provided TaskSpecs.

Returns:

whether the volume lists are equal

getGoalState

public static GoalState getGoalState(PodInstance podInstance,
                                     java.lang.String taskName)
                              throws TaskException

Gets the GoalState of Task.

Parameters:

podInstance - A PodInstance containing tasks.

taskName - The name of the Task whose goal state is desired

Returns:

The GoalState of the task.

Throws:

TaskException - is thrown when unable to determine a task's GoalState

getTaskSpec

public static java.util.Optional<TaskSpec> getTaskSpec(ConfigStore<ServiceSpec> configStore,
                                                       Protos.TaskInfo taskInfo)
                                                throws TaskException

Throws:

TaskException

getTaskSpec

public static java.util.Optional<TaskSpec> getTaskSpec(PodInstance podInstance,
                                                       java.lang.String taskName)

getTaskSpec

public static java.util.Optional<TaskSpec> getTaskSpec(ServiceSpec serviceSpec,
                                                       java.lang.String podType,
                                                       java.lang.String taskName)

getPodRequirements

public static java.util.List<PodInstanceRequirement> getPodRequirements(ConfigStore<ServiceSpec> configStore,
                                                                        java.util.Collection<TaskInfo> failedTasks,
                                                                        java.util.Collection<TaskInfo> allLaunchedTasks)

Given a list of all tasks and failed tasks, returns a list of tasks (via returned PodInstanceRequirement.getTasksToLaunch()) that should be relaunched.

Parameters:

failedTasks - tasks marked as needing recovery

allLaunchedTasks - all launched tasks in the service

Returns:

list of pods, each with contained named tasks to be relaunched

getPodInstance

public static PodInstance getPodInstance(ConfigStore<ServiceSpec> configStore,
                                         TaskInfo taskInfo)
                                  throws TaskException

Throws:

TaskException

getPodInstance

public static PodInstance getPodInstance(PodSpec podSpec,
                                         TaskInfo taskInfo)
                                  throws TaskException

Throws:

TaskException

isRecoveryNeeded

public static boolean isRecoveryNeeded(TaskStatus taskStatus)

Returns whether the provided TaskStatus shows that the task needs to recover.

isTerminal

public static boolean isTerminal(TaskStatus taskStatus)

Returns whether the provided TaskStatus has reached a terminal state.

isTerminal

public static boolean isTerminal(TaskState taskState)

Returns whether the provided TaskState has reached a terminal state.

needsRecovery

public static boolean needsRecovery(TaskSpec taskSpec,
                                    TaskStatus taskStatus)

Determines whether a Task needs to be recovered based on its current definition (TaskSpec) and status (TaskStatus).

Parameters:

taskSpec - The definition of a task

taskStatus - The status of the task.

Returns:

true if recovery is needed, false otherwise.

getStepName

public static java.lang.String getStepName(PodInstance podInstance,
                                           java.util.Collection<java.lang.String> tasksToLaunch)

Returns a default name for a Step given a PodInstance and the tasks to be launched in it.

Parameters:

podInstance - The PodInstance to be launched by a Step.

tasksToLaunch - The tasks to be launched in the Pod.

Returns:

The Step name

clearReservations

public static java.util.Collection<TaskInfo> clearReservations(java.util.Collection<TaskInfo> taskInfos)

Returns TaskInfos will all reservations and persistence IDs removed from their Resources.

taskHasZone

public static boolean taskHasZone(TaskInfo taskInfo)

Determines if a task is launched in any zones.

Parameters:

taskInfo - The TaskInfo to get zone information from.

Returns:

A boolean indicating whether the task is in a zone.

getTaskZone

public static java.lang.String getTaskZone(TaskInfo taskInfo)

Gets the zone of a task.

Parameters:

taskInfo - The TaskInfo to get zone information from.

Returns:

A string indicating the zone the task is in.

getTaskIPAddress

public static java.lang.String getTaskIPAddress(TaskStatus taskStatus)
                                         throws java.lang.IllegalStateException

Gets the IP address associated with the task.

Parameters:

taskStatus - the TaskStatus to get the IP address from.

Returns:

A String indicating the IP address associated with the task.

Throws:

java.lang.IllegalStateException