com.mesosphere.sdk.state

Class ConfigStore<T extends Configuration>

java.lang.Object

com.mesosphere.sdk.state.ConfigStore<T>

Type Parameters:

T - The Configuration object to be serialized and deserialized in the implementation of this interface

All Implemented Interfaces:

ConfigTargetStore

public class ConfigStore<T extends Configuration>
extends java.lang.Object
implements ConfigTargetStore

An implementation of ConfigStore which relies on the provided Persister for data persistence.

The ZNode structure in Zookeeper is as follows:
rootPath/
-> ConfigTarget (contains UUID)
-> Configurations/
-> [Config-ID-0] (contains serialized config)
-> [Config-ID-1] (contains serialized config)
-> ...

Constructor Summary

Constructors

Constructor and Description
ConfigStore(ConfigurationFactory<T> factory, Persister persister) Creates a new ConfigStore which uses the provided Persister to access configuration data.

Method Summary

Modifier and Type	Method and Description
void	clear(java.util.UUID id) Deletes the configuration with the provided UUID, or does nothing if no matching configuration is found.
T	fetch(java.util.UUID id) Retrieves and deserializes the Configuration assigned to the provided UUID, or throws an exception if no config with the provided UUID was found.
java.util.UUID	getTargetConfig() Returns the current ID of the active target configuration, or throws an exception if none is set.
java.util.Collection<java.util.UUID>	list() Returns a list of all stored configuration UUIDs, or an empty list if none are found.
void	setTargetConfig(java.util.UUID id) Stores the ID of the active target configuration, replacing any current value.
java.util.UUID	store(T config) Serializes the provided Configuration using its Configuration.getBytes() function, writes it to storage, and returns the UUID which it was stored against.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigStore

public ConfigStore(ConfigurationFactory<T> factory,
                   Persister persister)

Creates a new ConfigStore which uses the provided Persister to access configuration data.

Method Detail

store

public java.util.UUID store(T config)
                     throws ConfigStoreException

Serializes the provided Configuration using its Configuration.getBytes() function, writes it to storage, and returns the UUID which it was stored against.

Throws:

ConfigStoreException - if serialization or writing fails

fetch

public T fetch(java.util.UUID id)
        throws ConfigStoreException

Retrieves and deserializes the Configuration assigned to the provided UUID, or throws an exception if no config with the provided UUID was found.

Parameters:

id - The UUID of the configuration to be fetched

Returns:

The deserialized configuration

Throws:

ConfigStoreException - if retrieval or deserialization fails, or if the requested config is missing

clear

public void clear(java.util.UUID id)
           throws ConfigStoreException

Deletes the configuration with the provided UUID, or does nothing if no matching configuration is found.

Parameters:

id - The UUID of the configuration to be deleted

Throws:

ConfigStoreException - if the configuration is found but deletion fails

list

public java.util.Collection<java.util.UUID> list()
                                          throws ConfigStoreException

Returns a list of all stored configuration UUIDs, or an empty list if none are found.

Throws:

ConfigStoreException - if list retrieval fails

setTargetConfig

public void setTargetConfig(java.util.UUID id)
                     throws ConfigStoreException

Description copied from interface: ConfigTargetStore

Stores the ID of the active target configuration, replacing any current value.

Specified by:

setTargetConfig in interface ConfigTargetStore

Throws:

ConfigStoreException - if writing the ID fails

See Also:

ConfigTargetStore.getTargetConfig()

getTargetConfig

public java.util.UUID getTargetConfig()
                               throws ConfigStoreException

Description copied from interface: ConfigTargetStore

Returns the current ID of the active target configuration, or throws an exception if none is set.

Specified by:

getTargetConfig in interface ConfigTargetStore

Throws:

ConfigStoreException - if reading or deserializing the ID fails, or no value is set

See Also:

ConfigTargetStore.setTargetConfig(UUID)