org.nuxeo.ecm.core.transientstore.api

Interface TransientStoreService

All Known Implementing Classes:

TransientStorageComponent

@Experimental(comment="https://jira.nuxeo.com/browse/NXP-16577")
public interface TransientStoreService

Service to expose access to TransientStore

Since:

7.2

Author:

Tiry

Method Summary

Methods

Modifier and Type	Method and Description
void	doGC() Triggers Garbage collecting of all TransientStore
TransientStore	getStore(String name) Retrieve a TransientStore by it's name
TransientStoreConfig	getStoreConfig(String name) Read configuration for the target named TransientStore
TransientStore	registerStore(TransientStoreConfig config) Dynamically register a new TransientStore from it's config

Method Detail

getStore

TransientStore getStore(String name)

Retrieve a TransientStore by it's name

Parameters:

name - the name of the target TransientStore

Returns:

the target TransientStore or null if not found

getStoreConfig

TransientStoreConfig getStoreConfig(String name)
                                    throws IOException

Read configuration for the target named TransientStore

Parameters:

name - the name of the target TransientStore

Returns:

the TransientStoreConfig of the target store or null if not found

Throws:

IOException

registerStore

TransientStore registerStore(TransientStoreConfig config)

Dynamically register a new TransientStore from it's config

Parameters:

config - the TransientStoreConfig for the new TransientStore

Returns:

the newly registered TransientStore

doGC

void doGC()

Triggers Garbage collecting of all TransientStore