org.apache.jackrabbit.oak.plugins.index.lucene

Interface ActiveDeletedBlobCollectorMBean

All Known Implementing Classes:

ActiveDeletedBlobCollectorMBeanImpl

public interface ActiveDeletedBlobCollectorMBean

MBean for starting and monitoring the progress of collection of deleted lucene index blobs.

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
@NotNull javax.management.openmbean.CompositeData	cancelActiveCollection() Cancel a running collection of deleted lucene index blobs operation.
void	flagActiveDeletionSafe() Resets the in-memory flag so that new blobs are not flagged anymore and hence would get marked for active deletion when active deletion is active.
void	flagActiveDeletionUnsafeForCurrentState() Flag current blobs (head state) referred by all indexes so that they won't be marked to be collected by active deletion later.
@NotNull javax.management.openmbean.CompositeData	getActiveCollectionStatus() Status of collection of deleted lucene index blobs.
@NotNull boolean	isActiveDeletionUnsafe()
boolean	isDisabled() Whether active deletion is disabled.
@NotNull javax.management.openmbean.CompositeData	startActiveCollection() Initiate collection operation of deleted lucene index blobs

Field Detail

TYPE

static final java.lang.String TYPE

See Also:

Constant Field Values

Method Detail

startActiveCollection

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

Initiate collection operation of deleted lucene index blobs

Returns:

the status of the operation right after it was initiated

cancelActiveCollection

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

Cancel a running collection of deleted lucene index blobs operation. Does nothing if collection is not running.

Returns:

the status of the operation right after it was initiated

getActiveCollectionStatus

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

Status of collection of deleted lucene index blobs.

Returns:

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

isActiveDeletionUnsafe

@NotNull
@NotNull boolean isActiveDeletionUnsafe()

Returns:

true: if recording deleted blob for active deletion is unsafe; false: otherwise

flagActiveDeletionUnsafeForCurrentState

@NotNull
void flagActiveDeletionUnsafeForCurrentState()

Flag current blobs (head state) referred by all indexes so that they won't be marked to be collected by active deletion later. It would also set an in-memory flag so that new blobs also are flagged to be not marked for deletion by active deletion

flagActiveDeletionSafe

void flagActiveDeletionSafe()

Resets the in-memory flag so that new blobs are not flagged anymore and hence would get marked for active deletion when active deletion is active.

isDisabled

boolean isDisabled()

Whether active deletion is disabled.

Returns:

true if disabled