org.nuxeo.ecm.core.storage.binary

Class CachingBinaryManager

java.lang.Object

org.nuxeo.ecm.core.storage.binary.AbstractBinaryManager

org.nuxeo.ecm.core.storage.binary.CachingBinaryManager

All Implemented Interfaces:

Closeable, AutoCloseable, BinaryManager

Direct Known Subclasses:

JCloudsBinaryManager, S3BinaryManager, SQLBinaryManager

public abstract class CachingBinaryManager
extends AbstractBinaryManager

Abstract class for a BinaryManager that uses a cache for its files because fetching them is expensive.

Initialization of the BinaryManager must call initializeCache(java.io.File, long, org.nuxeo.ecm.core.storage.binary.FileStorage) from the initialize(org.nuxeo.ecm.core.storage.binary.BinaryManagerDescriptor) method.

Since:

5.7

Field Summary

Fields

Modifier and Type	Field and Description
FileCache	fileCache

Fields inherited from class org.nuxeo.ecm.core.storage.binary.AbstractBinaryManager

DEFAULT_DEPTH, DEFAULT_DIGEST, MAX_BUF_SIZE, MIN_BUF_SIZE

Constructor Summary

Constructors

Constructor and Description
CachingBinaryManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the binary manager and releases all resources and temporary objects held by it.
Binary	getBinary(String digest) Returns a Binary corresponding to the given digest.
File	getFile(String digest) Gets a file from cache or storage.
Long	getLength(String digest) Gets a file length from cache or storage.
void	initialize(BinaryManagerDescriptor binaryManagerDescriptor) Initializer.
void	initializeCache(File dir, long maxSize, FileStorage fileStorage) Initialize the cache.
void	initializeCache(String cacheSizeStr, FileStorage fileStorage) Initialize the cache.

Methods inherited from class org.nuxeo.ecm.core.storage.binary.AbstractBinaryManager

getBinary, getGarbageCollector, toHexString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fileCache

public FileCache fileCache

Constructor Detail

CachingBinaryManager

public CachingBinaryManager()

Method Detail

initialize

public void initialize(BinaryManagerDescriptor binaryManagerDescriptor)
                throws IOException

Description copied from interface: BinaryManager

Initializer.

Specified by:

initialize in interface BinaryManager

Specified by:

initialize in class AbstractBinaryManager

Throws:

IOException

initializeCache

public void initializeCache(File dir,
                   long maxSize,
                   FileStorage fileStorage)

Initialize the cache.

Parameters:

dir - the directory to use to store cached files

maxSize - the maximum size of the cache (in bytes)

fileStorage - the file storage mechanism to use to store and fetch files

Since:

5.9.2

initializeCache

public void initializeCache(String cacheSizeStr,
                   FileStorage fileStorage)
                     throws IOException

Initialize the cache.

Parameters:

cacheSizeStr - the maximum size of the cache (as a String)

fileStorage - the file storage mechanism to use to store and fetch files

Throws:

IOException

Since:

6.0

See Also:

initializeCache(File, long, FileStorage), SizeUtils.parseSizeInBytes(String)

close

public void close()

Description copied from interface: BinaryManager

Closes the binary manager and releases all resources and temporary objects held by it.

getBinary

public Binary getBinary(String digest)

Description copied from interface: BinaryManager

Returns a Binary corresponding to the given digest.

A null is returned if the digest could not be found.

Specified by:

getBinary in interface BinaryManager

Specified by:

getBinary in class AbstractBinaryManager

Parameters:

digest - the digest, or null

Returns:

the corresponding binary

getFile

public File getFile(String digest)
             throws IOException

Gets a file from cache or storage.

Used by LazyBinary.

Throws:

IOException

getLength

public Long getLength(String digest)
               throws IOException

Gets a file length from cache or storage.

Use by LazyBinary.

Throws:

IOException