Package org.nuxeo.ecm.core.storage.mongodb

Class GridFSBinaryManager.GridFSBinaryGarbageCollector

java.lang.Object

org.nuxeo.ecm.core.storage.mongodb.GridFSBinaryManager.GridFSBinaryGarbageCollector

All Implemented Interfaces:

BinaryGarbageCollector

Enclosing class:

GridFSBinaryManager

public class GridFSBinaryManager.GridFSBinaryGarbageCollector
extends Object
implements BinaryGarbageCollector

Field Summary

Fields

Modifier and Type	Field	Description
protected String	bucket
protected static String	MARK_KEY_PREFIX
protected String	msKey
protected long	startTime
protected BinaryManagerStatus	status

Constructor Summary

Constructors

Constructor	Description
GridFSBinaryGarbageCollector(String bucket)

Method Summary

Modifier and Type	Method	Description
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 digest)	Marks a binary as being in use.
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).

Methods inherited from class java.lang.Object

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

Field Detail

bucket

protected final String bucket

status

protected BinaryManagerStatus status

startTime

protected volatile long startTime

MARK_KEY_PREFIX

protected static final String MARK_KEY_PREFIX

See Also:

Constant Field Values

msKey

protected String msKey

Constructor Detail

GridFSBinaryGarbageCollector

public GridFSBinaryGarbageCollector(String bucket)

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

mark

public void mark(String digest)

Description copied from interface: BinaryGarbageCollector

Marks a binary as being in use.

Specified by:

mark in interface BinaryGarbageCollector

Parameters:

digest - the binary's digest

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

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