org.nuxeo.ecm.core.storage.binary

Class LocalBinaryManager

java.lang.Object

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

org.nuxeo.ecm.core.storage.binary.LocalBinaryManager

All Implemented Interfaces:

Closeable, AutoCloseable, BinaryManager

Direct Known Subclasses:

AESBinaryManager, DefaultBinaryManager

public class LocalBinaryManager
extends AbstractBinaryManager

A simple filesystem-based binary manager. It stores the binaries according to their digest (hash), which means that no transactional behavior needs to be implemented.

A garbage collection is needed to purge unused binaries.

The format of the binaries directory is:

• data/ hierarchy with the actual binaries in subdirectories,
• tmp/ temporary storage during creation,
• config.xml a file containing the configuration used.

Since:

5.6

Author:

Florent Guillaume

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalBinaryManager.DefaultBinaryGarbageCollector

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_FILE
static String	DATA
static String	DEFAULT_PATH
static String	TMP

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
LocalBinaryManager()

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	getFileForDigest(String digest, boolean createDir) Gets a file representing the storage for a given digest.
File	getStorageDir()
void	initialize(BinaryManagerDescriptor binaryManagerDescriptor) Initializer.
static void	touch(File file) Sets the last modification date to now on a file

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

DEFAULT_PATH

public static final String DEFAULT_PATH

See Also:

Constant Field Values

DATA

public static final String DATA

See Also:

Constant Field Values

TMP

public static final String TMP

See Also:

Constant Field Values

CONFIG_FILE

public static final String CONFIG_FILE

See Also:

Constant Field Values

Constructor Detail

LocalBinaryManager

public LocalBinaryManager()

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

close

public void close()

Description copied from interface: BinaryManager

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

getStorageDir

public File getStorageDir()

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

getFileForDigest

public File getFileForDigest(String digest,
                    boolean createDir)

Gets a file representing the storage for a given digest.

Parameters:

digest - the digest

createDir - true if the directory containing the file itself must be created

Returns:

the file for this digest

touch

public static void touch(File file)

Sets the last modification date to now on a file

Parameters:

file - the file