Package org.nuxeo.ecm.core.blob

Class LocalBlobStore.LocalBlobGarbageCollector

java.lang.Object

org.nuxeo.ecm.core.blob.LocalBlobStore.LocalBlobGarbageCollector

All Implemented Interfaces:

BinaryGarbageCollector

Enclosing class:

LocalBlobStore

public class LocalBlobStore.LocalBlobGarbageCollector
extends Object
implements BinaryGarbageCollector

Field Summary

Fields

Modifier and Type	Field	Description
boolean	markInMemory
protected long	startTime
protected BinaryManagerStatus	status
static long	TIME_RESOLUTION	Windows FAT filesystems have a time resolution of 2s.
protected Set<String>	toDelete

Constructor Summary

Constructors

Constructor	Description
LocalBlobGarbageCollector()

Method Summary

Modifier and Type	Method	Description
protected void	computeToDelete(File file, long minTime)
protected void	deleteOld(File file, long minTime, int depth, boolean delete)
String	getId()	Gets a unique identifier for this garbage collector.
BinaryManagerStatus	getStatus()	Gets the status of the binaries to GC and of those that won't be.
boolean	isInProgress()	Checks if a GC is in progress.
void	mark(String key)	Marks a binary as being in use.
protected void	removeUnmarkedBlobsAndUpdateStatus(boolean delete)
void	start()	Starts the garbage collection process.
void	stop(boolean delete)	Stops the garbage collection process and deletes all binaries that have not been marked (sweep).
protected void	touch(File file)	Sets the last modification date to now on a file.

Methods inherited from class java.lang.Object

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

Field Detail

TIME_RESOLUTION

public static final long TIME_RESOLUTION

Windows FAT filesystems have a time resolution of 2s. Other common filesystems have 1s.

See Also:

Constant Field Values

startTime

protected volatile long startTime

status

protected BinaryManagerStatus status

markInMemory

public volatile boolean markInMemory

toDelete

protected Set<String> toDelete

Constructor Detail

LocalBlobGarbageCollector

public LocalBlobGarbageCollector()

Method Detail

getId

public String getId()

Description copied from interface: BinaryGarbageCollector

Gets a unique identifier for this garbage collector. Two garbage collectors that would impact the same files must have the same identifier.

Specified by:

getId in interface BinaryGarbageCollector

Returns:

a unique identifier

getStatus

public BinaryManagerStatus getStatus()

Description copied from interface: BinaryGarbageCollector

Gets the status of the binaries to GC and of those that won't be.

Available after BinaryGarbageCollector.stop(boolean).

Specified by:

getStatus in interface BinaryGarbageCollector

Returns:

the status

isInProgress

public boolean isInProgress()

Description copied from interface: BinaryGarbageCollector

Checks if a GC is in progress.

A GC is in progress is #start has been called but not #stop.

It's only useful to call this from a separate thread from the one that calls BinaryGarbageCollector.mark(java.lang.String).

Specified by:

isInProgress in interface BinaryGarbageCollector

Returns:

true if a GC is in progress

start

public void start()

Description copied from interface: BinaryGarbageCollector

Starts the garbage collection process.

After this, all active binaries must be fed to the BinaryGarbageCollector.mark(java.lang.String) method.

Specified by:

start in interface BinaryGarbageCollector

computeToDelete

protected void computeToDelete(File file,
                               long minTime)

mark

public void mark(String key)

Description copied from interface: BinaryGarbageCollector

Marks a binary as being in use.

Specified by:

mark in interface BinaryGarbageCollector

Parameters:

key - the binary's digest

stop

public void stop(boolean delete)

Description copied from interface: BinaryGarbageCollector

Stops the garbage collection process and deletes all binaries that have not been marked (sweep).

Specified by:

stop in interface BinaryGarbageCollector

Parameters:

delete - true if actual deletion must be performed, false if the binaries to delete should simply be counted in the status

removeUnmarkedBlobsAndUpdateStatus

protected void removeUnmarkedBlobsAndUpdateStatus(boolean delete)

deleteOld

protected void deleteOld(File file,
                         long minTime,
                         int depth,
                         boolean delete)

touch

protected void touch(File file)

Sets the last modification date to now on a file.