Package org.apache.jackrabbit.oak.plugins.blob

Class BlobGC

java.lang.Object

javax.management.StandardMBean

org.apache.jackrabbit.oak.commons.jmx.AnnotatedStandardMBean

org.apache.jackrabbit.oak.plugins.blob.BlobGC

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, BlobGCMBean

public class BlobGC
extends AnnotatedStandardMBean
implements BlobGCMBean

Default implementation of BlobGCMBean based on a BlobGarbageCollector.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONSISTENCY_OP_NAME
static String	OP_NAME

Fields inherited from interface org.apache.jackrabbit.oak.plugins.blob.BlobGCMBean

TYPE

Constructor Summary

Constructors

Constructor	Description
BlobGC(@NotNull BlobGarbageCollector blobGarbageCollector, @NotNull Executor executor)

Method Summary

Modifier and Type	Method	Description
CompositeData	checkConsistency()	Data Store consistency check
@NotNull CompositeData	getBlobGCStatus()	Data store garbage collection status
@NotNull CompositeData	getConsistencyCheckStatus()	Consistency check status
TabularData	getGlobalMarkStats()	Show details of the data Store garbage collection process.
TabularData	getOperationStats()	Show details of the data Store garbage collection invocations.
@NotNull CompositeData	startBlobGC(boolean markOnly)	Initiate a data store garbage collection operation.
CompositeData	startBlobGC(boolean markOnly, boolean forceBlobIdRetrieve)	Initiate a data store garbage collection operation.

Methods inherited from class org.apache.jackrabbit.oak.commons.jmx.AnnotatedStandardMBean

getDescription, getDescription, getDescription, getDescription, getImpact, getParameterName

Methods inherited from class javax.management.StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object

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

Field Detail

OP_NAME

public static final String OP_NAME

See Also:

Constant Field Values

CONSISTENCY_OP_NAME

public static final String CONSISTENCY_OP_NAME

See Also:

Constant Field Values

Constructor Detail

BlobGC

public BlobGC(@NotNull
              @NotNull BlobGarbageCollector blobGarbageCollector,
              @NotNull
              @NotNull Executor executor)

Parameters:

blobGarbageCollector - Blob garbage collector

executor - executor for running the garbage collection task

Method Detail

startBlobGC

@NotNull
public @NotNull CompositeData startBlobGC(boolean markOnly)

Description copied from interface: BlobGCMBean

Initiate a data store garbage collection operation.

Specified by:

startBlobGC in interface BlobGCMBean

Parameters:

markOnly - whether to only mark references and not sweep in the mark and sweep operation.

Returns:

the status of the operation right after it was initiated

startBlobGC

public CompositeData startBlobGC(boolean markOnly,
                                 boolean forceBlobIdRetrieve)

Description copied from interface: BlobGCMBean

Initiate a data store garbage collection operation.

Specified by:

startBlobGC in interface BlobGCMBean

Parameters:

markOnly - whether to only mark references and not sweep in the mark and sweep operation.

forceBlobIdRetrieve - whether to force retrieve blob ids from datastore

Returns:

the status of the operation right after it was initiated

getBlobGCStatus

@NotNull
public @NotNull CompositeData getBlobGCStatus()

Description copied from interface: BlobGCMBean

Data store garbage collection status

Specified by:

getBlobGCStatus in interface BlobGCMBean

Returns:

the status of the ongoing operation or if none the terminal status of the last operation or Status not available if none.

checkConsistency

public CompositeData checkConsistency()

Description copied from interface: BlobGCMBean

Data Store consistency check

Specified by:

checkConsistency in interface BlobGCMBean

Returns:

the missing blobs

getConsistencyCheckStatus

@NotNull
public @NotNull CompositeData getConsistencyCheckStatus()

Description copied from interface: BlobGCMBean

Consistency check status

Specified by:

getConsistencyCheckStatus in interface BlobGCMBean

Returns:

the status of the ongoing operation or if none the terminal status of the last operation or Status not available if none.

getGlobalMarkStats

public TabularData getGlobalMarkStats()

Description copied from interface: BlobGCMBean

Show details of the data Store garbage collection process.

Specified by:

getGlobalMarkStats in interface BlobGCMBean

Returns:

List of available repositories and their status

getOperationStats

public TabularData getOperationStats()

Description copied from interface: BlobGCMBean

Show details of the data Store garbage collection invocations.

Specified by:

getOperationStats in interface BlobGCMBean

Returns:

Data about all the previous gc invocations