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

Class ActiveDeletedBlobCollectorMBeanImpl

java.lang.Object

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

All Implemented Interfaces:

ActiveDeletedBlobCollectorMBean

public class ActiveDeletedBlobCollectorMBeanImpl
extends Object
implements ActiveDeletedBlobCollectorMBean

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.plugins.index.lucene.ActiveDeletedBlobCollectorMBean

TYPE

Constructor Summary

Constructors

Constructor

Description

ActiveDeletedBlobCollectorMBeanImpl(@NotNull org.apache.jackrabbit.oak.plugins.index.lucene.directory.ActiveDeletedBlobCollectorFactory.ActiveDeletedBlobCollector activeDeletedBlobCollector, @NotNull Whiteboard whiteboard, @NotNull NodeStore store, @NotNull IndexPathService indexPathService, @NotNull AsyncIndexInfoService asyncIndexInfoService, @NotNull GarbageCollectableBlobStore blobStore, @NotNull Executor executor)

Method Summary

Modifier and Type	Method	Description
@NotNull 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 CompositeData	getActiveCollectionStatus()	Status of collection of deleted lucene index blobs.
boolean	isActiveDeletionUnsafe()
boolean	isDisabled()	Whether active deletion is disabled.
@NotNull CompositeData	startActiveCollection()	Initiate collection operation of deleted lucene index blobs

Methods inherited from class java.lang.Object

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

Constructor Details

ActiveDeletedBlobCollectorMBeanImpl

public ActiveDeletedBlobCollectorMBeanImpl(@NotNull
 @NotNull org.apache.jackrabbit.oak.plugins.index.lucene.directory.ActiveDeletedBlobCollectorFactory.ActiveDeletedBlobCollector activeDeletedBlobCollector,
 @NotNull
 @NotNull Whiteboard whiteboard,
 @NotNull
 @NotNull NodeStore store,
 @NotNull
 @NotNull IndexPathService indexPathService,
 @NotNull
 @NotNull AsyncIndexInfoService asyncIndexInfoService,
 @NotNull
 @NotNull GarbageCollectableBlobStore blobStore,
 @NotNull
 @NotNull Executor executor)

Parameters:

activeDeletedBlobCollector - deleted index blobs collector

whiteboard - An instance of Whiteboard. It will be used to get checkpoing manager mbean.

store - NodeStore instance to access repository state

indexPathService - IndexPathService instance to collect indexes available in the repository

asyncIndexInfoService - AsyncIndexInfoService instance to acess state of async indexer lanes

blobStore - An instance of GarbageCollectableBlobStore. It will be used to purge blobs which have been deleted from lucene indexes.

executor - executor for running the collection task

Method Details

isDisabled

public boolean isDisabled()

Description copied from interface: ActiveDeletedBlobCollectorMBean

Whether active deletion is disabled.

Specified by:

isDisabled in interface ActiveDeletedBlobCollectorMBean

Returns:

true if disabled

startActiveCollection

@NotNull
public @NotNull CompositeData startActiveCollection()

Description copied from interface: ActiveDeletedBlobCollectorMBean

Initiate collection operation of deleted lucene index blobs

Specified by:

startActiveCollection in interface ActiveDeletedBlobCollectorMBean

Returns:

the status of the operation right after it was initiated

cancelActiveCollection

@NotNull
public @NotNull CompositeData cancelActiveCollection()

Description copied from interface: ActiveDeletedBlobCollectorMBean

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

Specified by:

cancelActiveCollection in interface ActiveDeletedBlobCollectorMBean

Returns:

the status of the operation right after it was initiated

getActiveCollectionStatus

@NotNull
public @NotNull CompositeData getActiveCollectionStatus()

Description copied from interface: ActiveDeletedBlobCollectorMBean

Status of collection of deleted lucene index blobs.

Specified by:

getActiveCollectionStatus in interface ActiveDeletedBlobCollectorMBean

Returns:

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

isActiveDeletionUnsafe

public boolean isActiveDeletionUnsafe()

Specified by:

isActiveDeletionUnsafe in interface ActiveDeletedBlobCollectorMBean

Returns:

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

flagActiveDeletionUnsafeForCurrentState

public void flagActiveDeletionUnsafeForCurrentState()

Description copied from interface: ActiveDeletedBlobCollectorMBean

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

Specified by:

flagActiveDeletionUnsafeForCurrentState in interface ActiveDeletedBlobCollectorMBean

flagActiveDeletionSafe

public void flagActiveDeletionSafe()

Description copied from interface: ActiveDeletedBlobCollectorMBean

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.

Specified by:

flagActiveDeletionSafe in interface ActiveDeletedBlobCollectorMBean