com.mesosphere.sdk.state

Class StateStoreUtils

java.lang.Object

com.mesosphere.sdk.state.StateStoreUtils

public class StateStoreUtils
extends java.lang.Object

Utilities for implementations and users of StateStore.

Method Summary

Modifier and Type	Method and Description
protected static boolean	fetchBooleanProperty(StateStore stateStore, java.lang.String propertyName)
static java.util.Collection<Protos.TaskInfo>	fetchPodTasks(StateStore stateStore, PodInstance podInstance) Returns all Protos.TaskInfos associated with the provided PodInstance, or an empty list if none were found.
static byte[]	fetchPropertyOrEmptyArray(StateStore stateStore, java.lang.String key) Returns the requested property, or an empty array if the property is not present.
static java.util.Collection<Protos.TaskInfo>	fetchTasksNeedingRecovery(StateStore stateStore, ConfigStore<ServiceSpec> configStore) Fetches and returns all Protos.TaskInfos for tasks needing recovery.
static java.util.Collection<Protos.TaskInfo>	fetchTasksNeedingRecovery(StateStore stateStore, ConfigStore<ServiceSpec> configStore, java.util.Set<java.lang.String> launchableTaskNames) Fetches and returns all Protos.TaskInfos for tasks needing recovery and in the list of launchable Tasks.
static boolean	getDeploymentWasCompleted(StateStore stateStore) Gets whether the service has previously completed deployment.
static java.lang.String	getTaskName(StateStore stateStore, Protos.TaskStatus taskStatus) Verifies that the supplied TaskStatus corresponds to a single TaskInfo in the provided StateStore and returns the TaskInfo.
static java.util.Optional<Protos.TaskStatus>	getTaskStatusFromProperty(StateStore stateStore, java.lang.String taskName) Returns an Optional from the properties in the provided state store for the specified task name.
static boolean	isUninstalling(StateStore stateStore) Returns the current value of the 'uninstall' property in the provided StateStore.
(package private) static void	repairTaskIDs(StateStore stateStore) TaskInfo and TaskStatus objects referring to the same Task name are not written atomically.
static void	setDeploymentWasCompleted(StateStore stateStore) Sets whether the service has previously completed deployment.
static void	setUninstalling(StateStore stateStore) Sets an 'uninstall' property in the provided StateStore to true.
static void	storeTaskStatusAsProperty(StateStore stateStore, java.lang.String taskName, Protos.TaskStatus taskStatus) Stores a TaskStatus as a Property in the provided state store.

Methods inherited from class java.lang.Object

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

Method Detail

fetchPropertyOrEmptyArray

public static byte[] fetchPropertyOrEmptyArray(StateStore stateStore,
                                               java.lang.String key)

Returns the requested property, or an empty array if the property is not present.

fetchTasksNeedingRecovery

public static java.util.Collection<Protos.TaskInfo> fetchTasksNeedingRecovery(StateStore stateStore,
                                                                              ConfigStore<ServiceSpec> configStore,
                                                                              java.util.Set<java.lang.String> launchableTaskNames)
                                                                       throws TaskException

Fetches and returns all Protos.TaskInfos for tasks needing recovery and in the list of launchable Tasks.

Returns:

Terminated TaskInfos

Throws:

TaskException

fetchTasksNeedingRecovery

public static java.util.Collection<Protos.TaskInfo> fetchTasksNeedingRecovery(StateStore stateStore,
                                                                              ConfigStore<ServiceSpec> configStore)
                                                                       throws TaskException

Fetches and returns all Protos.TaskInfos for tasks needing recovery.

Returns:

Terminated TaskInfos

Throws:

TaskException

fetchPodTasks

public static java.util.Collection<Protos.TaskInfo> fetchPodTasks(StateStore stateStore,
                                                                  PodInstance podInstance)
                                                           throws StateStoreException

Returns all Protos.TaskInfos associated with the provided PodInstance, or an empty list if none were found.

Throws:

StateStoreException - in the event of an IO error other than missing tasks

getTaskName

public static java.lang.String getTaskName(StateStore stateStore,
                                           Protos.TaskStatus taskStatus)
                                    throws StateStoreException

Verifies that the supplied TaskStatus corresponds to a single TaskInfo in the provided StateStore and returns the TaskInfo.

Returns:

The singular Protos.TaskInfo if it is present

Throws:

StateStoreException - if zero or multiple corresponding Protos.TaskInfos are found

repairTaskIDs

static void repairTaskIDs(StateStore stateStore)

TaskInfo and TaskStatus objects referring to the same Task name are not written atomically. It is therefore possible for the states across these elements to become out of sync. While the scheduler process is up they remain in sync. This method produces an initial synchronized state. For example:

1. TaskInfo(name=foo, id=1) is written
2. TaskStatus(name=foo, id=1, status=RUNNING) is written
3. Task foo is reconfigured/relaunched
4. TaskInfo(name=foo, id=2) is written
5. Scheduler is restarted before new TaskStatus is written
6. Scheduler comes back and sees TaskInfo(name=foo, id=2) and TaskStatus(name=foo, id=1, status=RUNNING)

isUninstalling

public static boolean isUninstalling(StateStore stateStore)
                              throws StateStoreException

Returns the current value of the 'uninstall' property in the provided StateStore.

Throws:

StateStoreException

setUninstalling

public static void setUninstalling(StateStore stateStore)

Sets an 'uninstall' property in the provided StateStore to true.

fetchBooleanProperty

protected static boolean fetchBooleanProperty(StateStore stateStore,
                                              java.lang.String propertyName)

storeTaskStatusAsProperty

public static void storeTaskStatusAsProperty(StateStore stateStore,
                                             java.lang.String taskName,
                                             Protos.TaskStatus taskStatus)
                                      throws StateStoreException

Stores a TaskStatus as a Property in the provided state store.

Throws:

StateStoreException

getTaskStatusFromProperty

public static java.util.Optional<Protos.TaskStatus> getTaskStatusFromProperty(StateStore stateStore,
                                                                              java.lang.String taskName)

Returns an Optional from the properties in the provided state store for the specified task name.

setDeploymentWasCompleted

public static void setDeploymentWasCompleted(StateStore stateStore)

Sets whether the service has previously completed deployment.

getDeploymentWasCompleted

public static boolean getDeploymentWasCompleted(StateStore stateStore)

Gets whether the service has previously completed deployment. If this is true, then any configuration changes should be treated as an update rather than a new deployment.