org.nuxeo.ecm.core.transientstore.api

Interface StorageEntry

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractStorageEntry, StorageEntryImpl

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

Represents an entry that can be stored inside a TransientStore. The entry is will be stored in 2 sub parts : the Blobs that will be stored in file system, and the java attributes that will be kept in memory

Since:

7.2

Author:

Tiry

Method Summary

Methods

Modifier and Type	Method and Description
List<Blob>	addBlob(Blob blob) Adds a Blob to the list of persisted Blobs
void	beforeRemove() Callback to do some cleanup before entry is removed from the TransientStore
Serializable	get(String key) Reads the value of named parameters
List<Blob>	getBlobs()
String	getId() Returns the id associated with an entry In the default implementation this id must an ascii alphanumeric string
long	getLastStorageSize() Returns the size last time the entry was stored
long	getSize() Returns the size of the persisted Blobs
void	load(File directory) Called by TransientStore to load Blobs from disk
void	persist(File directory) Called by TransientStore to persist the Blobs to disk and then be sure that the entry can be Serialized without loosing any data
void	put(String key, Serializable value) Add a named parameter to the entry
void	setBlobs(List<Blob> blobs) Set the Blobs that must be associated with the entry

Method Detail

getId

String getId()

Returns the id associated with an entry In the default implementation this id must an ascii alphanumeric string

Returns:

the id of the entry

setBlobs

void setBlobs(List<Blob> blobs)

Set the Blobs that must be associated with the entry

Parameters:

blobs -

addBlob

List<Blob> addBlob(Blob blob)

Adds a Blob to the list of persisted Blobs

Parameters:

blob -

Returns:

getBlobs

List<Blob> getBlobs()

Returns:

the Blobs that are associated to the entry

put

void put(String key,
       Serializable value)

Add a named parameter to the entry

Parameters:

key - the name of the parameter

value - the Serializable value

get

Serializable get(String key)

Reads the value of named parameters

Parameters:

key -

Returns:

beforeRemove

void beforeRemove()

Callback to do some cleanup before entry is removed from the TransientStore

persist

void persist(File directory)
             throws IOException

Called by TransientStore to persist the Blobs to disk and then be sure that the entry can be Serialized without loosing any data

Parameters:

directory -

Throws:

IOException

load

void load(File directory)
          throws IOException

Called by TransientStore to load Blobs from disk

Parameters:

directory -

Throws:

IOException

getSize

long getSize()

Returns the size of the persisted Blobs

Returns:

getLastStorageSize

long getLastStorageSize()

Returns the size last time the entry was stored

Returns: