TransientStore (Nuxeo ECM Projects 7.10-SNAPSHOT API)

All Known Implementing Classes:

AbstractTransientStore, RedisTransientStore, SimpleTransientStore
```
public interface TransientStore
```
Service Interface for managing a transient store.
Allows to store entries in 2 sub parts: a list of blobs stored on a file system along with a map of parameters.

Since:

7.2

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`doGC()` Runs garbage collecting to delete the file system resources that are associated with entries that were removed.
`boolean`	`exists(String key)` Returns `true` if an entry exists with the given `key`.
`List<Blob>`	`getBlobs(String key)` Gets the blobs associated with the entry with the given `key`.
`Serializable`	`getParameter(String key, String parameter)` Gets the value of `parameter` in the entry with the given `key`.
`Map<String,Serializable>`	`getParameters(String key)` Gets values of the parameters in the entry with the given `key`.
`long`	`getSize(String key)` Returns the size of the blobs associated with the entry with the given `key` or `-1` if entry does not exist.
`int`	`getStorageSizeMB()` Returns the size of the used disk storage in MB.
`void`	`init(TransientStoreConfig config)` Initializes the store from the given `config`.
`boolean`	`isCompleted(String key)` Returns `true` if the entry with the given `key` is ready.
`void`	`putBlobs(String key, List<Blob> blobs)` Associates the given `blobs` with the entry with the given `key`.
`void`	`putParameter(String key, String parameter, Serializable value)` Sets `parameter` to `value` in the entry with the given `key`.
`void`	`putParameters(String key, Map<String,Serializable> parameters)` Puts `parameters` in the entry with the given `key`.
`void`	`release(String key)` Informs the store that the entry with the given `key` can be released if TTL or GC parameters require to do some cleanup.
`void`	`remove(String key)` Removes entry with the given `key`.
`void`	`removeAll()` Removes all entries from the store.
`void`	`setCompleted(String key, boolean completed)` Marks the entry with the given `key` as ready.
`void`	`shutdown()` Shuts down the store.

- Method Detail
  - init
```
void init(TransientStoreConfig config)
```
    Initializes the store from the given config.
  - shutdown
```
void shutdown()
```
    Shuts down the store.
  - exists
```
boolean exists(String key)
```
    Returns true if an entry exists with the given key.
    
    Since:
    
    7.10
  - putParameter
```
void putParameter(String key,
                  String parameter,
                  Serializable value)
```
    Sets parameter to value in the entry with the given key.
    If entry does not exist a new entry is created. If parameter already exists in the entry it is overwritten.
    
    Since:
    
    7.10
  - getParameter
```
Serializable getParameter(String key,
                          String parameter)
```
    Gets the value of parameter in the entry with the given key.
    Returns null if entry or parameter does not exist.
    
    Since:
    
    7.10
  - putParameters
```
void putParameters(String key,
                   Map<String,Serializable> parameters)
```
    Puts parameters in the entry with the given key. Overwrites any existing parameter in the entry.
    If entry does not exist a new entry is created.
    
    Since:
    
    7.10
  - getParameters
```
Map<String,Serializable> getParameters(String key)
```
    Gets values of the parameters in the entry with the given key.
    Returns null if entry does not exist.
    
    Since:
    
    7.10
  - putBlobs
```
void putBlobs(String key,
              List<Blob> blobs)
```
    Associates the given blobs with the entry with the given key.
    If entry does not exist a new entry is created.
    
    Since:
    
    7.10
  - getBlobs
```
List<Blob> getBlobs(String key)
```
    Gets the blobs associated with the entry with the given key.
    Returns null if entry does not exist.
    
    Since:
    
    7.10
  - getSize
```
long getSize(String key)
```
    Returns the size of the blobs associated with the entry with the given key or -1 if entry does not exist.
    
    Since:
    
    7.10
  - isCompleted
```
boolean isCompleted(String key)
```
    Returns true if the entry with the given key is ready.
    
    Since:
    
    7.10
  - setCompleted
```
void setCompleted(String key,
                  boolean completed)
```
    Marks the entry with the given key as ready.
    If entry does not exist a new entry is created.
    
    Since:
    
    7.10
  - remove
```
void remove(String key)
```
    Removes entry with the given key.
    Has no effect if entry does not exist.
  - release
```
void release(String key)
```
    Informs the store that the entry with the given key can be released if TTL or GC parameters require to do some cleanup.
    Has no effect if entry does not exist.
  - getStorageSizeMB
```
int getStorageSizeMB()
```
    Returns the size of the used disk storage in MB.
  - doGC
```
void doGC()
```
    Runs garbage collecting to delete the file system resources that are associated with entries that were removed.
  - removeAll
```
void removeAll()
```
    Removes all entries from the store.

Interface TransientStore

Method Summary

Method Detail

init

shutdown

exists

putParameter

getParameter

putParameters

getParameters

putBlobs

getBlobs

getSize

isCompleted

setCompleted

remove

release

getStorageSizeMB

doGC

removeAll