java.lang.Object
- org.nuxeo.ecm.core.mongodb.transientstore.MongoDBTransientStore

All Implemented Interfaces:

TransientStore, TransientStoreProvider
```
public class MongoDBTransientStore
extends Object
implements TransientStoreProvider
```
Transient Store optimized for MongoDB, using a blob provider for binaries. It can replace the KeyValueBlobTransientStore implementation, it uses the same configuration.
A MongoDB collection is created per store, the name is prefixed by "transient.". If not provided the blob provider is created using a default configuration with "transient_" prefix that gives the required transient property.
The storage format is the following:
```
 { "_id" : $KEY, "completed" : false, "ttl" : ISODate("2022-11-17T12:10:16.568Z"),
   "params" : { "chunked" : "false" } },
   "blobs" : [ { "key" : ..., "mimetype" : ..., "encoding" : ..., "filename" : ..., "length" : NumberLong(131984), "digest" : ... } ],
   "blobSize" : NumberLong(131984), "blobCount" : 1 }
 
```
The total size of the storage is computed with an aggregation on the blobSize property.
Since:

2021.30

Field Summary

Fields
Modifier and Type	Field	Description
`protected long`	`absoluteMaxSize`
`static String`	`BLOB_COUNT_KEY`
`static String`	`BLOB_SIZE_KEY`
`protected String`	`blobProviderId`
`static String`	`BLOBS_KEY`
`protected com.mongodb.client.MongoCollection<org.bson.Document>`	`coll`
`static String`	`COLLECTION_NAME_PROPERTY`
`static String`	`COMPLETED_KEY`
`protected TransientStoreConfig`	`config`
`static String`	`CONFIG_BLOB_PROVIDER`
`static String`	`CONFIG_DEFAULT_BLOB_PROVIDER`
`static String`	`CONFIG_DEFAULT_BLOB_PROVIDER_DEFAULT`
`static String`	`DEFAULT_COLLECTION_NAME`
`protected String`	`defaultBlobProviderId`
`static String`	`DIGEST`
`static String`	`ENCODING`
`static String`	`FILENAME`
`protected int`	`firstLevelTTL`
`static String`	`ID_KEY`
`static String`	`KEY`
`static String`	`LENGTH`
`static String`	`MIMETYPE`
`static Double`	`ONE`
`protected int`	`secondLevelTTL`
`protected long`	`targetMaxSize`
`static String`	`TRANSIENT_DATABASE_ID`
`static String`	`TTL_KEY`
`protected static long`	`WARN_DURATION_MS_THRESHOLD`

Constructor Summary

Constructors
Constructor Description

MongoDBTransientStore()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected org.bson.Document`	`createEntry(String key)`
`protected Serializable`	`deSerializeValue(Object value)`
`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`.
`BlobProvider`	`getBlobProvider()`
`List<Blob>`	`getBlobs(String key)`	Gets the blobs associated with the entry with the given `key`.
`protected com.mongodb.client.MongoCollection<org.bson.Document>`	`getColl()`
`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.
`long`	`getStorageSize()`	Returns the size (in bytes) of the disk storage used for blobs.
`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.
`Stream<String>`	`keyStream()`	Returns a `Stream` of keys for all entries.
`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.
`protected Object`	`serializeValue(Serializable value)`
`void`	`setCompleted(String key, boolean completed)`	Marks the entry with the given `key` as ready.
`protected void`	`setTTL(org.bson.Document entry, int ttlSeconds)`
`void`	`shutdown()`	Shuts down the store.

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

Methods inherited from interface org.nuxeo.ecm.core.transientstore.api.TransientStoreProvider
getStorageSizeMB, keySet

- Field Detail
  - COLLECTION_NAME_PROPERTY
```
public static final String COLLECTION_NAME_PROPERTY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_COLLECTION_NAME
```
public static final String DEFAULT_COLLECTION_NAME
```
    See Also:
    
    Constant Field Values
  - TRANSIENT_DATABASE_ID
```
public static final String TRANSIENT_DATABASE_ID
```
    See Also:
    
    Constant Field Values
  - CONFIG_BLOB_PROVIDER
```
public static final String CONFIG_BLOB_PROVIDER
```
    See Also:
    
    Constant Field Values
  - CONFIG_DEFAULT_BLOB_PROVIDER
```
public static final String CONFIG_DEFAULT_BLOB_PROVIDER
```
    See Also:
    
    Constant Field Values
  - CONFIG_DEFAULT_BLOB_PROVIDER_DEFAULT
```
public static final String CONFIG_DEFAULT_BLOB_PROVIDER_DEFAULT
```
    See Also:
    
    Constant Field Values
  - KEY
```
public static final String KEY
```
    See Also:
    
    Constant Field Values
  - MIMETYPE
```
public static final String MIMETYPE
```
    See Also:
    
    Constant Field Values
  - ENCODING
```
public static final String ENCODING
```
    See Also:
    
    Constant Field Values
  - FILENAME
```
public static final String FILENAME
```
    See Also:
    
    Constant Field Values
  - LENGTH
```
public static final String LENGTH
```
    See Also:
    
    Constant Field Values
  - DIGEST
```
public static final String DIGEST
```
    See Also:
    
    Constant Field Values
  - ID_KEY
```
public static final String ID_KEY
```
    See Also:
    
    Constant Field Values
  - TTL_KEY
```
public static final String TTL_KEY
```
    See Also:
    
    Constant Field Values
  - COMPLETED_KEY
```
public static final String COMPLETED_KEY
```
    See Also:
    
    Constant Field Values
  - BLOBS_KEY
```
public static final String BLOBS_KEY
```
    See Also:
    
    Constant Field Values
  - BLOB_SIZE_KEY
```
public static final String BLOB_SIZE_KEY
```
    See Also:
    
    Constant Field Values
  - BLOB_COUNT_KEY
```
public static final String BLOB_COUNT_KEY
```
    See Also:
    
    Constant Field Values
  - ONE
```
public static final Double ONE
```
  - WARN_DURATION_MS_THRESHOLD
```
protected static final long WARN_DURATION_MS_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - coll
```
protected com.mongodb.client.MongoCollection<org.bson.Document> coll
```
  - config
```
protected TransientStoreConfig config
```
  - firstLevelTTL
```
protected int firstLevelTTL
```
  - secondLevelTTL
```
protected int secondLevelTTL
```
  - blobProviderId
```
protected String blobProviderId
```
  - defaultBlobProviderId
```
protected String defaultBlobProviderId
```
  - absoluteMaxSize
```
protected long absoluteMaxSize
```
  - targetMaxSize
```
protected long targetMaxSize
```
- Constructor Detail
  - MongoDBTransientStore
```
public MongoDBTransientStore()
```
- Method Detail
  - init
```
public void init(TransientStoreConfig config)
```
    Description copied from interface: TransientStoreProvider
    
    Initializes the store from the given config.
    
    Specified by:
    
    init in interface TransientStoreProvider
  - getColl
```
protected com.mongodb.client.MongoCollection<org.bson.Document> getColl()
```
  - shutdown
```
public void shutdown()
```
    Description copied from interface: TransientStoreProvider
    
    Shuts down the store.
    
    Specified by:
    
    shutdown in interface TransientStoreProvider
  - keyStream
```
public Stream<String> keyStream()
```
    Description copied from interface: TransientStoreProvider
    
    Returns a Stream of keys for all entries.
    
    Specified by:
    
    keyStream in interface TransientStoreProvider
  - getStorageSize
```
public long getStorageSize()
```
    Description copied from interface: TransientStoreProvider
    
    Returns the size (in bytes) of the disk storage used for blobs.
    
    Specified by:
    
    getStorageSize in interface TransientStoreProvider
    
    Returns:
    
    the number of bytes used by stored blobs
  - doGC
```
public void doGC()
```
    Description copied from interface: TransientStoreProvider
    
    Runs garbage collecting to delete the file system resources that are associated with entries that were removed.
    
    Specified by:
    
    doGC in interface TransientStoreProvider
  - removeAll
```
public void removeAll()
```
    Description copied from interface: TransientStoreProvider
    
    Removes all entries from the store.
    
    Specified by:
    
    removeAll in interface TransientStoreProvider
  - exists
```
public boolean exists(String key)
```
    Description copied from interface: TransientStore
    
    Returns true if an entry exists with the given key.
    
    Specified by:
    
    exists in interface TransientStore
  - putParameter
```
public void putParameter(String key,
                         String parameter,
                         Serializable value)
```
    Description copied from interface: TransientStore
    
    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.
    
    Specified by:
    
    putParameter in interface TransientStore
  - getParameter
```
public Serializable getParameter(String key,
                                 String parameter)
```
    Description copied from interface: TransientStore
    
    Gets the value of parameter in the entry with the given key.
    Returns null if entry or parameter does not exist.
    
    Specified by:
    
    getParameter in interface TransientStore
  - deSerializeValue
```
protected Serializable deSerializeValue(Object value)
```
  - serializeValue
```
protected Object serializeValue(Serializable value)
```
  - putParameters
```
public void putParameters(String key,
                          Map<String,Serializable> parameters)
```
    Description copied from interface: TransientStore
    
    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.
    
    Specified by:
    
    putParameters in interface TransientStore
  - getParameters
```
public Map<String,Serializable> getParameters(String key)
```
    Description copied from interface: TransientStore
    
    Gets values of the parameters in the entry with the given key.
    Returns null if entry does not exist.
    
    Specified by:
    
    getParameters in interface TransientStore
  - putBlobs
```
public void putBlobs(String key,
                     List<Blob> blobs)
```
    Description copied from interface: TransientStore
    
    Associates the given blobs with the entry with the given key.
    If entry does not exist a new entry is created.
    
    Specified by:
    
    putBlobs in interface TransientStore
  - getBlobs
```
public List<Blob> getBlobs(String key)
```
    Description copied from interface: TransientStore
    
    Gets the blobs associated with the entry with the given key.
    Returns null if entry does not exist.
    
    Specified by:
    
    getBlobs in interface TransientStore
  - getSize
```
public long getSize(String key)
```
    Description copied from interface: TransientStore
    
    Returns the size of the blobs associated with the entry with the given key or -1 if entry does not exist.
    
    Specified by:
    
    getSize in interface TransientStore
  - isCompleted
```
public boolean isCompleted(String key)
```
    Description copied from interface: TransientStore
    
    Returns true if the entry with the given key is ready.
    
    Specified by:
    
    isCompleted in interface TransientStore
  - setCompleted
```
public void setCompleted(String key,
                         boolean completed)
```
    Description copied from interface: TransientStore
    
    Marks the entry with the given key as ready.
    If entry does not exist a new entry is created.
    
    Specified by:
    
    setCompleted in interface TransientStore
  - setTTL
```
protected void setTTL(org.bson.Document entry,
                      int ttlSeconds)
```
  - createEntry
```
protected org.bson.Document createEntry(String key)
```
  - remove
```
public void remove(String key)
```
    Description copied from interface: TransientStore
    
    Removes entry with the given key.
    Has no effect if entry does not exist.
    
    Specified by:
    
    remove in interface TransientStore
  - release
```
public void release(String key)
```
    Description copied from interface: TransientStore
    
    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.
    
    Specified by:
    
    release in interface TransientStore
  - getBlobProvider
```
public BlobProvider getBlobProvider()
```

Class MongoDBTransientStore

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.nuxeo.ecm.core.transientstore.api.TransientStoreProvider

Field Detail

COLLECTION_NAME_PROPERTY

DEFAULT_COLLECTION_NAME

TRANSIENT_DATABASE_ID

CONFIG_BLOB_PROVIDER

CONFIG_DEFAULT_BLOB_PROVIDER

CONFIG_DEFAULT_BLOB_PROVIDER_DEFAULT

KEY

MIMETYPE

ENCODING

FILENAME

LENGTH

DIGEST

ID_KEY

TTL_KEY

COMPLETED_KEY

BLOBS_KEY

BLOB_SIZE_KEY

BLOB_COUNT_KEY

ONE

WARN_DURATION_MS_THRESHOLD

coll

config

firstLevelTTL

secondLevelTTL

blobProviderId

defaultBlobProviderId

absoluteMaxSize

targetMaxSize

Constructor Detail

MongoDBTransientStore

Method Detail

init

getColl

shutdown

keyStream

getStorageSize

doGC

removeAll

exists

putParameter

getParameter

deSerializeValue

serializeValue

putParameters

getParameters

putBlobs

getBlobs

getSize

isCompleted

setCompleted

setTTL

createEntry

remove

release

getBlobProvider