com.mesosphere.sdk.http

Class StateResource

java.lang.Object

com.mesosphere.sdk.http.StateResource

public class StateResource
extends java.lang.Object

An API for reading task and frameworkId state from persistent storage, and resetting the state store cache if one is being used.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.nio.charset.Charset	FILE_ENCODING
protected static java.lang.String	FILE_NAME_PREFIX
protected static int	FILE_SIZE
protected static java.lang.String	NO_FILE_ERROR_MESSAGE
protected static java.lang.String	UPLOAD_TOO_BIG_ERROR_MESSAGE

Constructor Summary

Constructors

Constructor and Description
StateResource(StateStore stateStore) Creates a new StateResource which cannot deserialize Properties.
StateResource(StateStore stateStore, PropertyDeserializer propertyDeserializer) Creates a new StateResource which can deserialize Properties.

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	getFile(StateStore stateStore, java.lang.String fileName) Retrieves the contents of a file based on file name.
Response	getFile(java.lang.String fileName)
protected static java.util.Collection<java.lang.String>	getFileNames(StateStore stateStore) Gets the name of the files that are stored in the state store.
Response	getFiles()
Response	getFrameworkId() Produces the configured ID of the framework, or returns an error if reading that data failed.
Response	getProperty(java.lang.String key) Produces the TaskInfo for the provided task name, or returns an error if that name doesn't exist or the data couldn't be read.
Response	getPropertyKeys()
Response	getTaskIPsToZones(java.lang.String podType, java.lang.String ip) Returns the Zone information for a given pod type and an IP address.
Response	getTaskNamesToZones() Returns the Zone information for all of the tasks of the service.
Response	getTaskNameToZone(java.lang.String taskName) Returns the Zone information for a given task.
Response	putFile(java.io.InputStream uploadedInputStream, FormDataContentDisposition fileDetails) Endpoint for uploading arbitrary files of size up to 1024 Bytes.
Response	refreshCache() Refreshes the state store cache to reflect current data on ZK.
protected static void	storeFile(StateStore stateStore, java.lang.String fileName, java.io.InputStream uploadedInputStream, FormDataContentDisposition fileDetails) Stores the file in the state store.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_NAME_PREFIX

protected static final java.lang.String FILE_NAME_PREFIX

See Also:

Constant Field Values

FILE_ENCODING

protected static final java.nio.charset.Charset FILE_ENCODING

FILE_SIZE

protected static final int FILE_SIZE

See Also:

Constant Field Values

UPLOAD_TOO_BIG_ERROR_MESSAGE

protected static final java.lang.String UPLOAD_TOO_BIG_ERROR_MESSAGE

See Also:

Constant Field Values

NO_FILE_ERROR_MESSAGE

protected static final java.lang.String NO_FILE_ERROR_MESSAGE

See Also:

Constant Field Values

Constructor Detail

StateResource

public StateResource(StateStore stateStore)

Creates a new StateResource which cannot deserialize Properties. Callers will receive a "204 NO_CONTENT" HTTP response when attempting to view the content of a property.

Parameters:

stateStore - the source of data to be returned to callers

StateResource

public StateResource(StateStore stateStore,
                     PropertyDeserializer propertyDeserializer)

Creates a new StateResource which can deserialize Properties. Callers will be able to view the content of individual Properties.

Parameters:

stateStore - the source of data to be returned to callers

propertyDeserializer - a deserializer which can turn any Property in the provided stateStore to valid JSON

Method Detail

getFrameworkId

public Response getFrameworkId()

Produces the configured ID of the framework, or returns an error if reading that data failed.

getPropertyKeys

public Response getPropertyKeys()

getFiles

public Response getFiles()

getFile

public Response getFile(java.lang.String fileName)

putFile

public Response putFile(java.io.InputStream uploadedInputStream,
                        FormDataContentDisposition fileDetails)

Endpoint for uploading arbitrary files of size up to 1024 Bytes.

Parameters:

uploadedInputStream - The input stream containing the data.

fileDetails - The details of the file to upload.

Returns:

response indicating result of put operation.

getTaskNamesToZones

public Response getTaskNamesToZones()

Returns the Zone information for all of the tasks of the service.

getTaskNameToZone

public Response getTaskNameToZone(java.lang.String taskName)

Returns the Zone information for a given task.

getTaskIPsToZones

public Response getTaskIPsToZones(java.lang.String podType,
                                  java.lang.String ip)

Returns the Zone information for a given pod type and an IP address.

getProperty

public Response getProperty(java.lang.String key)

Produces the TaskInfo for the provided task name, or returns an error if that name doesn't exist or the data couldn't be read.

refreshCache

public Response refreshCache()

Refreshes the state store cache to reflect current data on ZK. Should only be needed if ZK was edited behind the scheduler's back, or if there's a bug in the cache handling.

getFile

protected static java.lang.String getFile(StateStore stateStore,
                                          java.lang.String fileName)
                                   throws java.io.UnsupportedEncodingException

Retrieves the contents of a file based on file name.

Parameters:

stateStore - The state store to get file content from.

fileName - The name of the file to retrieve.

Returns:

Contents of the file.

Throws:

java.io.UnsupportedEncodingException

storeFile

protected static void storeFile(StateStore stateStore,
                                java.lang.String fileName,
                                java.io.InputStream uploadedInputStream,
                                FormDataContentDisposition fileDetails)
                         throws StateStoreException,
                                java.io.IOException

Stores the file in the state store.

Parameters:

stateStore - The state store to store the file in.

fileName - The name of the file to store.

uploadedInputStream - The input stream holding the content of the file.

Throws:

StateStoreException

java.io.IOException

getFileNames

protected static java.util.Collection<java.lang.String> getFileNames(StateStore stateStore)

Gets the name of the files that are stored in the state store. The files stored in the state store are prefixed with "file_".

Parameters:

stateStore - The state store to get files names from.

Returns:

The set of all file names stored.