org.apache.jackrabbit.oak.plugins.blob

Interface BlobGCMBean

All Known Implementing Classes:

BlobGC

public interface BlobGCMBean

MBean for starting and monitoring the progress of blob garbage collection.

See Also:

RepositoryManagementMBean

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE

Method Summary

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

Field Detail

TYPE

static final java.lang.String TYPE

See Also:

Constant Field Values

Method Detail

startBlobGC

javax.management.openmbean.CompositeData startBlobGC(@Name(value="markOnly") @Description(value="Set to true to only mark references and not sweep in the mark and sweep operation. This mode is to be used when the underlying BlobStore is shared between multiple different repositories. For all other cases set it to false to perform full garbage collection")
                                                     boolean markOnly)

Initiate a data store garbage collection operation.

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

javax.management.openmbean.CompositeData startBlobGC(@Name(value="markOnly") @Description(value="Set to true to only mark references and not sweep in the mark and sweep operation. This mode is to be used when the underlying BlobStore is shared between multiple different repositories. For all other cases set it to false to perform full garbage collection")
                                                     boolean markOnly,
                                                     @Name(value="forceBlobIdRetrieve") @Description(value="Set to true to force retrieve all ids from the datastore bypassing any local tracking")
                                                     boolean forceBlobIdRetrieve)

Initiate a data store garbage collection operation.

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
@NotNull javax.management.openmbean.CompositeData getBlobGCStatus()

Data store garbage collection status

Returns:

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

getGlobalMarkStats

javax.management.openmbean.TabularData getGlobalMarkStats()

Show details of the data Store garbage collection process.

Returns:

List of available repositories and their status

getOperationStats

javax.management.openmbean.TabularData getOperationStats()

Show details of the data Store garbage collection invocations.

Returns:

Data about all the previous gc invocations

checkConsistency

javax.management.openmbean.CompositeData checkConsistency()

Data Store consistency check

Returns:

the missing blobs

getConsistencyCheckStatus

@NotNull
@NotNull javax.management.openmbean.CompositeData getConsistencyCheckStatus()

Consistency check status

Returns:

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