Package org.apache.jackrabbit.oak.plugins.document

Class DocumentCheckpointMBean

java.lang.Object

org.apache.jackrabbit.oak.commons.jmx.AbstractCheckpointMBean

org.apache.jackrabbit.oak.plugins.document.DocumentCheckpointMBean

All Implemented Interfaces:

CheckpointMBean

public class DocumentCheckpointMBean
extends AbstractCheckpointMBean

CheckpointMBean implementation for the DocumentNodeStore.

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.api.jmx.CheckpointMBean

TYPE

Constructor Summary

Constructors

Constructor	Description
DocumentCheckpointMBean(DocumentNodeStore store)

Method Summary

Modifier and Type	Method	Description
protected void	collectCheckpoints(TabularDataSupport tab)	Called to collect the tabular data for the checkpoints.
String	createCheckpoint(long lifetime)	Create a new checkpoint with the given lifetime.
long	getOldestCheckpointCreationTimestamp()
boolean	releaseCheckpoint(String checkpoint)	Release the checkpoint with the given id.

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

getOldestCheckpointCreationDate, listCheckpoints, toCompositeData

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentCheckpointMBean

public DocumentCheckpointMBean(DocumentNodeStore store)

Method Detail

collectCheckpoints

protected void collectCheckpoints(TabularDataSupport tab)
                           throws OpenDataException

Description copied from class: AbstractCheckpointMBean

Called to collect the tabular data for the checkpoints. Each checkpoint should be represented by a single row in tab. Implementors should use the AbstractCheckpointMBean.toCompositeData(java.lang.String, java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>) utility method for converting the individual fields associated with a checkpoint into the correct composite data format.

Specified by:

collectCheckpoints in class AbstractCheckpointMBean

Throws:

OpenDataException

getOldestCheckpointCreationTimestamp

public long getOldestCheckpointCreationTimestamp()

Specified by:

getOldestCheckpointCreationTimestamp in interface CheckpointMBean

Specified by:

getOldestCheckpointCreationTimestamp in class AbstractCheckpointMBean

Returns:

creation timestamp of oldest checkpoint.

createCheckpoint

public String createCheckpoint(long lifetime)

Description copied from interface: CheckpointMBean

Create a new checkpoint with the given lifetime. See org.apache.jackrabbit.oak.spi.state.NodeStore#checkpoint

Returns:

the id of the newly created checkpoint

releaseCheckpoint

public boolean releaseCheckpoint(String checkpoint)

Description copied from interface: CheckpointMBean

Release the checkpoint with the given id. See org.apache.jackrabbit.oak.spi.state.NodeStore#checkpoint

Returns:

true on success, false otherwise.