StorageManager (bullet-core 1.2.3 API)

java.lang.Object
- com.yahoo.bullet.storage.StorageManager<V>

Type Parameters:
V - The type of the Serializable data stored in the underlying storage. Encapsulates the concept of a Storage. It can abstract away a key-value storage as well as other ways of storing data. It uses three main concepts (see below) - namespaces, partitions and criteria to abstract away most storages. It lets you store and retrieve raw byte[] or strings, or objects of the type parameter. It exposes these concepts:
1. The concept of a namespace. This can be used to abstract different concepts like tables if the storage is relational or multiple conceptual storages.
2. The concept of a partition. It is up to the concrete implementation to choose to shard its data if needed and understand how to access its shards given the keys. A partition is defined at each namespace level. If you need partitions for your storage, override the partition specific methods - getPartition(String, int), clear(String, int), numberOfPartitions(String) and repartition(String, int), as well as actually partitioning the data when implementing the byte[] methods. For convenience, a hash(String, int) is provided. By default, unless the specific storage manager says so, the storage is assumed to be unpartitioned.
3. The concept of a criteria. A criteria is a general query. A specific StorageManager can provide storage-specific Criteria for storage-specific querying needs. Note that the Criteria methods, retrieveAll(Criteria) and getAll(Criteria) do not take a namespace since those are handled by the Criteria implementations. The apply(Criteria, Object) can be used as a general method to apply arbitrary changes to the storage.
Implementors of this class should implement the various raw byte[] methods - the accessors - as well as the clear and wipe methods. To change the default conversion to and from the type of the StorageManager and the byte[], you can override the convert(Serializable) and convert(byte[]) methods. For convenience,
1. All the accessors are provided with their String variants to store and retrieve values as Strings in addition to the type of data stored in the storage. If you wish to control how the encoding happens, you may override toString(byte[]) and toBytes(String). The map flavors are available as toByteArrayMap(Map) and toStringMap(Map) methods.
2. All the accessors (including the ones in 1. above) are provided without requiring a namespace. These methods use the DEFAULT_NAMESPACE when invoking the corresponding methods that do require a namespace. If you wish to control the default namespace used, override the getDefaultNamespace() method.
All Implemented Interfaces:

Serializable, AutoCloseable

Direct Known Subclasses:

MemoryStorageManager, MultiMemoryStorageManager, NullStorageManager
```
public abstract class StorageManager<V extends Serializable>
extends Object
implements Serializable
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected BulletConfig config

static String DEFAULT_NAMESPACE

Fields
Modifier and Type	Field and Description
`protected BulletConfig`	`config`
`static String`	`DEFAULT_NAMESPACE`

Constructor Summary

Constructors
Constructor and Description

StorageManager(BulletConfig config)
Constructor that takes a BulletConfig.

Constructors
Constructor and Description
`StorageManager(BulletConfig config)` Constructor that takes a `BulletConfig`.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`<T,R> CompletableFuture<R>`	`apply(Criteria<T,R> criteria, T query)` Applies the given `Criteria` to this storage.
`CompletableFuture<Boolean>`	`clear()` Clears the default namespace.
`CompletableFuture<Boolean>`	`clear(int partition)` Clears the specified partition under the default namespace.
`CompletableFuture<Boolean>`	`clear(Set<String> ids)` Removes a given set of IDs from the storage under the default namespace.
`abstract CompletableFuture<Boolean>`	`clear(String namespace)` Clears the specified namespace.
`CompletableFuture<Boolean>`	`clear(String namespace, int partition)` Clears the specified partition under the given namespace.
`abstract CompletableFuture<Boolean>`	`clear(String namespace, Set<String> ids)` Removes a given set of IDs from the storage under the given namespace.
`void`	`close()` .
`protected V`	`convert(byte[] bytes)` Converts a @`byte[]` to a type of the given object.
`protected byte[]`	`convert(V object)` Converts an object of the given type to a @`byte[]`.
`static StorageManager`	`from(BulletConfig config)` Create a `StorageManager` instance using the class specified in the config file.
`static <S> Map<String,byte[]>`	`fromObjectMap(Map<String,S> input, Function<S,byte[]> converter)` Converts a `Map` of String and the given type to a `Map` of String to byte[].
`CompletableFuture<V>`	`get(String id)` Retrieves data stored for a given String identifier in the default namespace as a `Serializable` object.
`CompletableFuture<V>`	`get(String namespace, String id)` Retrieves data stored for a given String identifier in the given namespace as a `Serializable` object.
`CompletableFuture<Map<String,V>>`	`getAll()` Retrieves all the IDs from the default namespace in the storage as a `Map` of IDs to their `Serializable` values.
`<T,R> CompletableFuture<Map<String,V>>`	`getAll(Criteria<T,R> criteria)` Retrieves all the IDs matching the specified `Criteria` from the storage as the type of the storage.
`CompletableFuture<Map<String,V>>`	`getAll(Set<String> ids)` Retrieves the values for the provided IDs from the default namespace in the storage as a `Map` of IDs to their `Serializable` values.
`CompletableFuture<Map<String,V>>`	`getAll(String namespace)` Retrieves all the IDs from the given namespace in the storage as a `Map` of IDs to their `Serializable` values.
`CompletableFuture<Map<String,V>>`	`getAll(String namespace, Set<String> ids)` Retrieves the values for the provided IDs from the given namespace in the storage as a `Map` of IDs to their `Serializable` values.
`protected abstract CompletableFuture<Map<String,byte[]>>`	`getAllRaw(String namespace)` Retrieves all the IDs from the given namespace in the storage as byte[].
`protected CompletableFuture<Map<String,byte[]>>`	`getAllRaw(String namespace, Set<String> ids)` Retrieves the values for the provided IDs from the given namespace in the storage as byte[].
`CompletableFuture<Map<String,String>>`	`getAllString()` Retrieves all the IDs from the default namespace in the storage as a `Map` of IDs to their String values.
`CompletableFuture<Map<String,String>>`	`getAllString(Set<String> ids)` Retrieves the values for the provided IDs from the default namespace in the storage as a `Map` of IDs to their String values.
`CompletableFuture<Map<String,String>>`	`getAllString(String namespace)` Retrieves all the IDs from the given namespace in the storage as a `Map` of IDs to their String values.
`CompletableFuture<Map<String,String>>`	`getAllString(String namespace, Set<String> ids)` Retrieves the values for the provided IDs from the given namespace in the storage as a `Map` of IDs to their String values.
`protected String`	`getDefaultNamespace()` Gets the default namespace to store data under.
`CompletableFuture<Map<String,V>>`	`getPartition(int partition)` Retrieves the IDs stored in the provided partition for the default namespace.
`CompletableFuture<Map<String,V>>`	`getPartition(String namespace, int partition)` Retrieves the IDs stored in the provided partition for the given namespace.
`protected CompletableFuture<Map<String,byte[]>>`	`getPartitionRaw(String namespace, int partition)` Retrieves the IDs stored in the provided partition for the given namespace.
`CompletableFuture<Map<String,String>>`	`getPartitionString(String namespace, int partition)` Retrieves the IDs stored in the provided partition for the given namespace.
`protected abstract CompletableFuture<byte[]>`	`getRaw(String namespace, String id)` Retrieves a given ID from the given namespace in the storage.
`CompletableFuture<String>`	`getString(String id)` Retrieves data stored for a given String identifier in the default namespace as a String.
`CompletableFuture<String>`	`getString(String namespace, String id)` Retrieves data stored for a given String identifier in the given namespace as a String.
`static int`	`hash(String key, int numberOfPartitions)` A default hash function for a given String that places the String into 0 to numberOfPartitions exclusive.
`int`	`numberOfPartitions()` Returns the number of partitions stored in this storage manager for the default namespace.
`int`	`numberOfPartitions(String namespace)` Returns the number of partitions stored in this storage manager for the given namespace.
`CompletableFuture<Boolean>`	`put(String namespace, String id, V value)` Stores any `Serializable` object for a given String identifier in the given namespace.
`CompletableFuture<Boolean>`	`put(String id, V data)` Stores any `Serializable` object for a given String identifier in the default namespace.
`CompletableFuture<Boolean>`	`putAll(Map<String,V> data)` Stores a map of IDs and values into the storage in the default namespace.
`CompletableFuture<Boolean>`	`putAll(String namespace, Map<String,V> data)` Stores a map of IDs and values into the storage in the given namespace.
`protected CompletableFuture<Boolean>`	`putAllRaw(String namespace, Map<String,byte[]> data)` Stores a map of IDs and values into the storage in the given namespace.
`CompletableFuture<Boolean>`	`putAllString(Map<String,String> data)` Stores a map of IDs and String values into the storage in the default namespace.
`CompletableFuture<Boolean>`	`putAllString(String namespace, Map<String,String> data)` Stores a map of IDs and String values into the storage in the given namespace.
`protected abstract CompletableFuture<Boolean>`	`putRaw(String namespace, String id, byte[] value)` Store a given ID and value for that ID into the given namespace in the storage.
`CompletableFuture<Boolean>`	`putString(String id, String value)` Stores a String for a given String identifier in the default namespace.
`CompletableFuture<Boolean>`	`putString(String namespace, String id, String value)` Stores a String for a given String identifier in the given namespace.
`CompletableFuture<V>`	`remove(String id)` Retrieves and removes data stored for a given String identifier as a `Serializable` object in the default namespace.
`CompletableFuture<V>`	`remove(String namespace, String id)` Retrieves and removes data stored for a given String identifier as a `Serializable` object in the given namespace.
`protected abstract CompletableFuture<byte[]>`	`removeRaw(String namespace, String id)` Removes a given ID from the given namespace in the storage.
`CompletableFuture<String>`	`removeString(String id)` Retrieves and removes data stored for a given String identifier as a String in the default namespace.
`CompletableFuture<String>`	`removeString(String namespace, String id)` Retrieves and removes data stored for a given String identifier as a String in the given namespace.
`CompletableFuture<Boolean>`	`repartition(int newPartitionCount)` Repartitions the data into the given new number of partitions in the default namespace.
`CompletableFuture<Boolean>`	`repartition(String namespace, int newPartitionCount)` Repartitions the data into the given new number of partitions for the given namespace.
`<T,R> CompletableFuture<R>`	`retrieveAll(Criteria<T,R> criteria)` Retrieves all the data matching the specified `Criteria` as the types of the `Criteria`.
`static Map<String,byte[]>`	`toByteArrayMap(Map<String,String> input)` Converts a `Map` of String to byte[] to a `Map` of String to String.
`static byte[]`	`toBytes(String input)` Converts a `String` to a byte[].
`static <S> Map<String,S>`	`toObjectMap(Map<String,byte[]> input, Function<byte[],S> converter)` Converts a `Map` of String to byte[] to a `Map` of String to the given type.
`static String`	`toString(byte[] input)` Converts a byte[] input to a String.
`static Map<String,String>`	`toStringMap(Map<String,byte[]> input)` Converts a `Map` of String to byte[] to a `Map` of String to String.
`abstract CompletableFuture<Boolean>`	`wipe()` Removes all the IDs from the storage across all namespaces.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_NAMESPACE
```
public static final String DEFAULT_NAMESPACE
```
    See Also:
    
    Constant Field Values
  - config
```
protected BulletConfig config
```
- Constructor Detail
  - StorageManager
```
public StorageManager(BulletConfig config)
```
    Constructor that takes a BulletConfig.
    
    Parameters:
    
    config - The config to use.
- Method Detail
  - getAll
```
public <T,R> CompletableFuture<Map<String,V>> getAll(Criteria<T,R> criteria)
```
    Retrieves all the IDs matching the specified Criteria from the storage as the type of the storage.
    
    Type Parameters:
    
    T - The type of query taken by the Criteria.
    
    R - The type of result returned by the Criteria.
    
    Parameters:
    
    criteria - The Criteria understood by this storage.
    
    Returns:
    
    A CompletableFuture that resolves to a Map of IDs to their stored values.
  - retrieveAll
```
public <T,R> CompletableFuture<R> retrieveAll(Criteria<T,R> criteria)
```
    Retrieves all the data matching the specified Criteria as the types of the Criteria.
    
    Type Parameters:
    
    T - The type of query taken by the Criteria.
    
    R - The type of result returned by the Criteria.
    
    Parameters:
    
    criteria - The Criteria understood by this storage.
    
    Returns:
    
    A CompletableFuture that resolves to the type returned by the Criteria.
  - apply
```
public <T,R> CompletableFuture<R> apply(Criteria<T,R> criteria,
                                        T query)
```
    Applies the given Criteria to this storage. It is up to the Criteria what it does.
    
    Type Parameters:
    
    T - The type of query taken by the Criteria.
    
    R - The type of result returned by the Criteria.
    
    Parameters:
    
    criteria - The Criteria to apply.
    
    query - The query that the Criteria uses to apply.
    
    Returns:
    
    A CompletableFuture that resolves to the type returned by the Criteria.
  - getDefaultNamespace
```
protected String getDefaultNamespace()
```
    Gets the default namespace to store data under.
    
    Returns:
    
    The default namespace.
  - clear
```
public CompletableFuture<Boolean> clear()
```
    Clears the default namespace.
    
    Returns:
    
    A CompletableFuture that resolves to true if the wipe was successful.
  - clear
```
public CompletableFuture<Boolean> clear(int partition)
```
    Clears the specified partition under the default namespace.
    
    Parameters:
    
    partition - The partition to clear.
    
    Returns:
    
    A CompletableFuture that resolves to true if the wipe was successful.
  - clear
```
public CompletableFuture<Boolean> clear(Set<String> ids)
```
    Removes a given set of IDs from the storage under the default namespace.
    
    Parameters:
    
    ids - The set of IDs to remove from the storage for the default namespace.
    
    Returns:
    
    A CompletableFuture that resolves to true if the wipe was successful.
  - put
```
public CompletableFuture<Boolean> put(String id,
                                      V data)
```
    Stores any Serializable object for a given String identifier in the default namespace.
    
    Parameters:
    
    id - The ID to store this data under.
    
    data - The object to store as the data.
    
    Returns:
    
    A CompletableFuture that resolves to true if the store succeeded.
  - get
```
public CompletableFuture<V> get(String id)
```
    Retrieves data stored for a given String identifier in the default namespace as a Serializable object.
    
    Parameters:
    
    id - The ID of the data.
    
    Returns:
    
    A CompletableFuture that resolves to the data.
  - putAll
```
public CompletableFuture<Boolean> putAll(Map<String,V> data)
```
    Stores a map of IDs and values into the storage in the default namespace.
    
    Parameters:
    
    data - The map of IDs and values to store.
    
    Returns:
    
    A CompletableFuture that resolves to true if the storage was completely successful.
  - getAll
```
public CompletableFuture<Map<String,V>> getAll()
```
    Retrieves all the IDs from the default namespace in the storage as a Map of IDs to their Serializable values.
    
    Returns:
    
    A CompletableFuture that resolves to a Map of IDs to their stored values.
  - getAll
```
public CompletableFuture<Map<String,V>> getAll(Set<String> ids)
```
    Retrieves the values for the provided IDs from the default namespace in the storage as a Map of IDs to their Serializable values.
    
    Parameters:
    
    ids - The Set of IDs to retrieve.
    
    Returns:
    
    A CompletableFuture that resolves to a Map of IDs to their stored values.
  - remove
```
public CompletableFuture<V> remove(String id)
```
    Retrieves and removes data stored for a given String identifier as a Serializable object in the default namespace.
    
    Parameters:
    
    id - The ID of the data.
    
    Returns:
    
    A CompletableFuture that resolves to the data.
  - numberOfPartitions
```
public int numberOfPartitions()
```
    Returns the number of partitions stored in this storage manager for the default namespace. Partitions can be sharded in storage and can also be used as a smaller unit of processing to reduce memory requirements. Partitions are numbered with integers from 0 inclusive to numberOfPartitions() exclusive for the namespace. By default, the storage manager is unpartitioned.
    
    Returns:
    
    The number of partitions in this storage manager.
  - getPartition
```
public CompletableFuture<Map<String,V>> getPartition(int partition)
```
    Retrieves the IDs stored in the provided partition for the default namespace.
    
    Parameters:
    
    partition - The partition number to return.
    
    Returns:
    
    A CompletableFuture that resolves to a Map of IDs to their stored values as byte arrays or null if no data is present.
  - repartition
```
public CompletableFuture<Boolean> repartition(int newPartitionCount)
```
    Repartitions the data into the given new number of partitions in the default namespace.
    
    Parameters:
    
    newPartitionCount - The new number of partitions to use.
    
    Returns:
    
    A CompletableFuture that resolves to true if the repartitioning was successful.
  - putString
```
public CompletableFuture<Boolean> putString(String id,
                                            String value)
```
    Stores a String for a given String identifier in the default namespace.
    
    Parameters:
    
    id - The ID to store this value under.
    
    value - The object to store as the value.
    
    Returns:
    
    A CompletableFuture that resolves to true if the store succeeded.
  - getString
```
public CompletableFuture<String> getString(String id)
```
    Retrieves data stored for a given String identifier in the default namespace as a String.
    
    Parameters:
    
    id - The ID of the data.
    
    Returns:
    
    A CompletableFuture that resolves to the data.
  - putAllString
```
public CompletableFuture<Boolean> putAllString(Map<String,String> data)
```
    Stores a map of IDs and String values into the storage in the default namespace.
    
    Parameters:
    
    data - The map of IDs and values to store.
    
    Returns:
    
    A CompletableFuture that resolves to true if the storage was completely successful.
  - getAllString
```
public CompletableFuture<Map<String,String>> getAllString()
```
    Retrieves all the IDs from the default namespace in the storage as a Map of IDs to their String values.
    
    Returns:
    
    A CompletableFuture that resolves to a Map of IDs to their String values.
  - getAllString
```
public CompletableFuture<Map<String,String>> getAllString(Set<String> ids)
```
    Retrieves the values for the provided IDs from the default namespace in the storage as a Map of IDs to their String values.
    
    Parameters:
    
    ids - The Set of IDs to retrieve.
    
    Returns:
    
    A CompletableFuture that resolves to a Map of IDs to their String values.
  - removeString
```
public CompletableFuture<String> removeString(String id)
```
    Retrieves and removes data stored for a given String identifier as a String in the default namespace.
    
    Parameters:
    
    id - The ID of the data.
    
    Returns:
    
    A CompletableFuture that resolves to the data.
  - hash
```
public static int hash(String key,
                       int numberOfPartitions)
```
    A default hash function for a given String that places the String into 0 to numberOfPartitions exclusive. Note that numberOfPartitions must be a whole number.
    
    Parameters:
    
    key - The String key to hash.
    
    numberOfPartitions - The number of partitions. Must be zero or positive.
    
    Returns:
    
    An integer from 0 to numberOfPartitions.
  - from
```
public static StorageManager from(BulletConfig config)
```
    Create a StorageManager instance using the class specified in the config file.
    
    Parameters:
    
    config - The non-null BulletConfig containing the class name and StorageManager settings.
    
    Returns:
    
    an instance of specified class initialized with settings from the input file and defaults.
  - putString
```
public CompletableFuture<Boolean> putString(String namespace,
                                            String id,
                                            String value)
```
    Stores a String for a given String identifier in the given namespace.
    
    Parameters:
    
    namespace - The namespace to store this value under.
    
    id - The ID to store this value under.
    
    value - The object to store as the value.
    
    Returns:
    
    A CompletableFuture that resolves to true if the store succeeded.
  - getString
```
public CompletableFuture<String> getString(String namespace,
                                           String id)
```
    Retrieves data stored for a given String identifier in the given namespace as a String.
    
    Parameters:
    
    namespace - The namespace of the data.
    
    id - The ID of the data.
    
    Returns:
    
    A CompletableFuture that resolves to the data.
  - putAllString
```
public CompletableFuture<Boolean> putAllString(String namespace,
                                               Map<String,String> data)
```
    Stores a map of IDs and String values into the storage in the given namespace.
    
    Parameters:
    
    namespace - The namespace to store the entries in.
    
    data - The map of IDs and values to store.
    
    Returns:
    
    A CompletableFuture that resolves to true if the storage was completely successful.
  - getAllString
```
public CompletableFuture<Map<String,String>> getAllString(String namespace)
```
    Retrieves all the IDs from the given namespace in the storage as a Map of IDs to their String values.
    
    Parameters:
    
    namespace - The namespace to retrieve from.
    
    Returns:
    
    A CompletableFuture that resolves to a Map of IDs to their String values.
  - getAllString
```
public CompletableFuture<Map<String,String>> getAllString(String namespace,
                                                          Set<String> ids)
```
    Retrieves the values for the provided IDs from the given namespace in the storage as a Map of IDs to their String values.
    
    Parameters:
    
    namespace - The namespace of the IDs.
    
    ids - The Set of IDs to retrieve.
    
    Returns:
    
    A CompletableFuture that resolves to a Map of IDs to their String values.
  - removeString
```
public CompletableFuture<String> removeString(String namespace,
                                              String id)
```
    Retrieves and removes data stored for a given String identifier as a String in the given namespace.
    
    Parameters:
    
    namespace - The namespace of the data.
    
    id - The ID of the data.
    
    Returns:
    
    A CompletableFuture that resolves to the data.
  - getPartitionString
```
public CompletableFuture<Map<String,String>> getPartitionString(String namespace,
                                                                int partition)
```
    Retrieves the IDs stored in the provided partition for the given namespace. By default, if the storage manager is unpartitioned, this works the same as getAll(String)
    
    Parameters:
    
    namespace - The namespace to retrieve the IDs from.
    
    partition - The partition number to return.
    
    Returns:
    
    A CompletableFuture that resolves to a Map of IDs to their stored values as Strings or null if no data is present.
  - toBytes
```
public static byte[] toBytes(String input)
```
    Converts a String to a byte[].
    
    Parameters:
    
    input - The String input.
    
    Returns:
    
    The byte[] encoding of the input.
  - toString
```
public static String toString(byte[] input)
```
    Converts a byte[] input to a String.
    
    Parameters:
    
    input - The byte[] input.
    
    Returns:
    
    The String decoded from the byte[].
  - toStringMap
```
public static Map<String,String> toStringMap(Map<String,byte[]> input)
```
    Converts a Map of String to byte[] to a Map of String to String.
    
    Parameters:
    
    input - The String to byte[] map.
    
    Returns:
    
    The String to String converted map.
  - toByteArrayMap
```
public static Map<String,byte[]> toByteArrayMap(Map<String,String> input)
```
    Converts a Map of String to byte[] to a Map of String to String.
    
    Parameters:
    
    input - The String to byte[] map.
    
    Returns:
    
    The String to String converted map.
  - close
```
public void close()
```
    . By default, close does nothing. If the particular storage needs to release resources, this is the place to do it.
    
    Specified by:
    
    close in interface AutoCloseable
  - putRaw
```
protected abstract CompletableFuture<Boolean> putRaw(String namespace,
                                                     String id,
                                                     byte[] value)
```
    Store a given ID and value for that ID into the given namespace in the storage.
    
    Parameters:
    
    namespace - The namespace to store the entry in.
    
    id - The unique ID to represent this entry.
    
    value - The value to store for this entry.
    
    Returns:
    
    A CompletableFuture that resolves to true if the storage was successful.
  - getRaw
```
protected abstract CompletableFuture<byte[]> getRaw(String namespace,
                                                    String id)
```
    Retrieves a given ID from the given namespace in the storage.
    
    Parameters:
    
    namespace - The namespace to retrieve from.
    
    id - The unique ID to retrieve from the storage.
    
    Returns:
    
    A CompletableFuture that resolves to the byte[] value for this ID or null if it does not exist.
  - putAllRaw
```
protected CompletableFuture<Boolean> putAllRaw(String namespace,
                                               Map<String,byte[]> data)
```
    Stores a map of IDs and values into the storage in the given namespace. By default, calls putRaw(String, String, byte[]) in parallel.
    
    Parameters:
    
    namespace - The namespace to store the entries in.
    
    data - The map of IDs and values to store.
    
    Returns:
    
    A CompletableFuture that resolves to true if the storage was completely successful.
  - getAllRaw
```
protected abstract CompletableFuture<Map<String,byte[]>> getAllRaw(String namespace)
```
    Retrieves all the IDs from the given namespace in the storage as byte[].
    
    Parameters:
    
    namespace - The namespace to retrieve from.
    
    Returns:
    
    A CompletableFuture that resolves to a Map of IDs to their stored values as byte[].
  - getAllRaw
```
protected CompletableFuture<Map<String,byte[]>> getAllRaw(String namespace,
                                                          Set<String> ids)
```
    Retrieves the values for the provided IDs from the given namespace in the storage as byte[]. By default, calls getRaw(String, String) repeatedly on each of the given IDs in parallel.
    
    Parameters:
    
    namespace - The namespace of the IDs.
    
    ids - The Set of IDs to retrieve.
    
    Returns:
    
    A CompletableFuture that resolves to a Map of IDs to their stored values as byte[].
  - removeRaw
```
protected abstract CompletableFuture<byte[]> removeRaw(String namespace,
                                                       String id)
```
    Removes a given ID from the given namespace in the storage.
    
    Parameters:
    
    namespace - The namespace of the ID.
    
    id - The unique ID to remove from the storage.
    
    Returns:
    
    A CompletableFuture that resolves to the byte[] value for this ID or null if it does not exist.
  - wipe
```
public abstract CompletableFuture<Boolean> wipe()
```
    Removes all the IDs from the storage across all namespaces.
    
    Returns:
    
    A CompletableFuture that resolves to true if the wipe was successful.
  - clear
```
public abstract CompletableFuture<Boolean> clear(String namespace)
```
    Clears the specified namespace.
    
    Parameters:
    
    namespace - The namespace to clear.
    
    Returns:
    
    A CompletableFuture that resolves to true if the wipe was successful.
  - clear
```
public abstract CompletableFuture<Boolean> clear(String namespace,
                                                 Set<String> ids)
```
    Removes a given set of IDs from the storage under the given namespace.
    
    Parameters:
    
    namespace - The namespace that has these IDs.
    
    ids - The set of IDs to remove from the storage for the given namespace.
    
    Returns:
    
    A CompletableFuture that resolves to true if the wipe was successful and throws otherwise.
  - put
```
public CompletableFuture<Boolean> put(String namespace,
                                      String id,
                                      V value)
```
    Stores any Serializable object for a given String identifier in the given namespace.
    
    Parameters:
    
    namespace - The namespace to store this value under.
    
    id - The ID to store this value under.
    
    value - The object to store as the value.
    
    Returns:
    
    A CompletableFuture that resolves to true if the store succeeded.
  - get
```
public CompletableFuture<V> get(String namespace,
                                String id)
```
    Retrieves data stored for a given String identifier in the given namespace as a Serializable object.
    
    Parameters:
    
    namespace - The namespace of the data.
    
    id - The ID of the data.
    
    Returns:
    
    A CompletableFuture that resolves to the data.
  - putAll
```
public CompletableFuture<Boolean> putAll(String namespace,
                                         Map<String,V> data)
```
    Stores a map of IDs and values into the storage in the given namespace.
    
    Parameters:
    
    namespace - The namespace to store the entries in.
    
    data - The map of IDs and values to store.
    
    Returns:
    
    A CompletableFuture that resolves to true if the storage was completely successful.
  - getAll
```
public CompletableFuture<Map<String,V>> getAll(String namespace)
```
    Retrieves all the IDs from the given namespace in the storage as a Map of IDs to their Serializable values.
    
    Parameters:
    
    namespace - The namespace to retrieve from.
    
    Returns:
    
    A CompletableFuture that resolves to a Map of IDs to their stored values.
  - getAll
```
public CompletableFuture<Map<String,V>> getAll(String namespace,
                                               Set<String> ids)
```
    Retrieves the values for the provided IDs from the given namespace in the storage as a Map of IDs to their Serializable values.
    
    Parameters:
    
    namespace - The namespace of the IDs.
    
    ids - The Set of IDs to retrieve.
    
    Returns:
    
    A CompletableFuture that resolves to a Map of IDs to their stored values.
  - remove
```
public CompletableFuture<V> remove(String namespace,
                                   String id)
```
    Retrieves and removes data stored for a given String identifier as a Serializable object in the given namespace.
    
    Parameters:
    
    namespace - The namespace of the data.
    
    id - The ID of the data.
    
    Returns:
    
    A CompletableFuture that resolves to the data.
  - numberOfPartitions
```
public int numberOfPartitions(String namespace)
```
    Returns the number of partitions stored in this storage manager for the given namespace. Partitions can be sharded in storage and can also be used as a smaller unit of processing to reduce memory requirements. Partitions are numbered with integers from 0 inclusive to numberOfPartitions(String) exclusive for the namespace. By default, if the storage manager is unpartitioned, this returns 0.
    
    Parameters:
    
    namespace - The namespace whose partitions are being asked for.
    
    Returns:
    
    The number of partitions in this storage manager.
  - getPartitionRaw
```
protected CompletableFuture<Map<String,byte[]>> getPartitionRaw(String namespace,
                                                                int partition)
```
    Retrieves the IDs stored in the provided partition for the given namespace. By default, if the storage manager is unpartitioned, this works the same as getAllRaw(String)
    
    Parameters:
    
    namespace - The namespace to retrieve the IDs from.
    
    partition - The partition number to return.
    
    Returns:
    
    A CompletableFuture that resolves to a Map of IDs to their stored values as byte arrays or null if no data is present.
  - getPartition
```
public CompletableFuture<Map<String,V>> getPartition(String namespace,
                                                     int partition)
```
    Retrieves the IDs stored in the provided partition for the given namespace. By default, if the storage manager is unpartitioned, this works the same as getAll(String)
    
    Parameters:
    
    namespace - The namespace to retrieve the IDs from.
    
    partition - The partition number to return.
    
    Returns:
    
    A CompletableFuture that resolves to a Map of IDs to their stored values as Serializable objects or null if no data is present.
  - clear
```
public CompletableFuture<Boolean> clear(String namespace,
                                        int partition)
```
    Clears the specified partition under the given namespace.
    
    Parameters:
    
    namespace - The namespace for the partition.
    
    partition - The partition to clear.
    
    Returns:
    
    A CompletableFuture that resolves to true if the wipe was successful.
  - repartition
```
public CompletableFuture<Boolean> repartition(String namespace,
                                              int newPartitionCount)
```
    Repartitions the data into the given new number of partitions for the given namespace. If the storage manager is unpartitioned, this does nothing.
    
    Parameters:
    
    namespace - The namespace to repartition.
    
    newPartitionCount - The new number of partitions to use.
    
    Returns:
    
    A CompletableFuture that resolves to true if the repartitioning was successful.
  - convert
```
protected V convert(byte[] bytes)
```
    Converts a @byte[] to a type of the given object. By default, uses SerializerDeserializer to deserialize using Java deserialization.
    
    Parameters:
    
    bytes - The byte[] to convert.
    
    Returns:
    
    The converted object or null if the input was null or the conversion was unable to be performed.
  - convert
```
protected byte[] convert(V object)
```
    Converts an object of the given type to a @byte[]. By default, uses SerializerDeserializer to serialize using Java serialization.
    
    Parameters:
    
    object - The object to convert.
    
    Returns:
    
    The converted byte[] or null if the input was null or the conversion was unable to be performed.
  - fromObjectMap
```
public static <S> Map<String,byte[]> fromObjectMap(Map<String,S> input,
                                                   Function<S,byte[]> converter)
```
    Converts a Map of String and the given type to a Map of String to byte[].
    
    Type Parameters:
    
    S - The type to convert from.
    
    Parameters:
    
    input - The String to the given type map.
    
    converter - The Function that converts from the given type to byte[].
    
    Returns:
    
    The String to byte[] converted map.
  - toObjectMap
```
public static <S> Map<String,S> toObjectMap(Map<String,byte[]> input,
                                            Function<byte[],S> converter)
```
    Converts a Map of String to byte[] to a Map of String to the given type.
    
    Type Parameters:
    
    S - The type to convert to.
    
    Parameters:
    
    input - The String to byte[] map.
    
    converter - The Function that converts from byte[] to the given type.
    
    Returns:
    
    The String to the given type converted map.

Class StorageManager<V extends Serializable>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_NAMESPACE

config

Constructor Detail

StorageManager

Method Detail

getAll

retrieveAll

apply

getDefaultNamespace

clear

clear

clear

put

get

putAll

getAll

getAll

remove

numberOfPartitions

getPartition

repartition

putString

getString

putAllString

getAllString

getAllString

removeString

hash

from

putString

getString

putAllString

getAllString

getAllString

removeString

getPartitionString

toBytes

toString

toStringMap

toByteArrayMap

close

putRaw

getRaw

putAllRaw

getAllRaw

getAllRaw

removeRaw

wipe

clear

clear

put

get

putAll

getAll

getAll

remove

numberOfPartitions

getPartitionRaw

getPartition

clear

repartition

convert

convert

fromObjectMap

toObjectMap