org.nuxeo.ecm.core.storage.sql

Class BinaryFileCache

java.lang.Object

org.nuxeo.common.file.LRUFileCache

org.nuxeo.ecm.core.storage.sql.BinaryFileCache

All Implemented Interfaces:

FileCache

Direct Known Subclasses:

JCloudsBinaryManager.JCloudsBinaryFileCache, S3BinaryManager.S3BinaryFileCache, SQLBinaryManager.SQLBinaryFileCache

public abstract class BinaryFileCache
extends LRUFileCache

An abstract base class to implement a FileCache based on fetchFile(java.lang.String, java.io.File) and fetchLength(java.lang.String) methods.

Field Summary

Fields inherited from class org.nuxeo.common.file.LRUFileCache

SIMPLE_ASCII

Constructor Summary

Constructors

Constructor and Description
BinaryFileCache(File dir, long maxSize)

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	fetchFile(String key, File tmp) Fetches the file from the cache or the remote database.
abstract Long	fetchLength(String key) Fetches the length from the remote database.
File	getFile(String key) Gets a file from the cache.
Long	getLength(String key)

Methods inherited from class org.nuxeo.common.file.LRUFileCache

clear, getNumberOfItems, getSize, getTempFile, putFile, putFile

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryFileCache

public BinaryFileCache(File dir,
               long maxSize)

Method Detail

fetchFile

public abstract boolean fetchFile(String key,
                File tmp)

Fetches the file from the cache or the remote database.

If something is retrieved from the database, it is put in cache.

Parameters:

key - identify the file in cache

tmp - the temporary file to use to store the file

Returns:

true if a file was fetched, false if the expected blob is missing from the database.

fetchLength

public abstract Long fetchLength(String key)

Fetches the length from the remote database.

Parameters:

key - identify the file in cache

Returns:

the length, or null if the expected blob is missing from the database.

getLength

public Long getLength(String key)

getFile

public File getFile(String key)

Description copied from interface: FileCache

Gets a file from the cache.

A returned file will never be deleted from the filesystem while the returned file object is still referenced, although it may be purged from the cache.

Specified by:

getFile in interface FileCache

Overrides:

getFile in class LRUFileCache

Parameters:

key - the cache key

Returns:

the cached file, or null if absent