org.nuxeo.ecm.blob

Class AbstractBinaryGarbageCollector<T extends CachingBinaryManager>

java.lang.Object

org.nuxeo.ecm.blob.AbstractBinaryGarbageCollector<T>

All Implemented Interfaces:

BinaryGarbageCollector

Direct Known Subclasses:

AzureGarbageCollector, S3BinaryManager.S3BinaryGarbageCollector

public abstract class AbstractBinaryGarbageCollector<T extends CachingBinaryManager>
extends Object
implements BinaryGarbageCollector

Since:

7.10

Author:

Arnaud Kervern

Field Summary

Fields

Modifier and Type	Field and Description
protected T	binaryManager
protected Set<String>	marked
protected long	startTime
protected BinaryManagerStatus	status

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBinaryGarbageCollector(T binaryManager)

Method Summary

Modifier and Type	Method and Description
BinaryManagerStatus	getStatus() Gets the status of the binaries to GC and of those that won't be.
abstract Set<String>	getUnmarkedBlobs()
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

Methods inherited from interface org.nuxeo.ecm.core.blob.binary.BinaryGarbageCollector

getId

Field Detail

binaryManager

protected T extends CachingBinaryManager binaryManager

status

protected BinaryManagerStatus status

startTime

protected volatile long startTime

marked

protected Set<String> marked

Constructor Detail

AbstractBinaryGarbageCollector

protected AbstractBinaryGarbageCollector(T binaryManager)

Method Detail

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

getUnmarkedBlobs

public abstract Set<String> getUnmarkedBlobs()

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

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