Package org.apache.jackrabbit.oak.commons.jmx

Class AbstractCheckpointMBean

  • All Implemented Interfaces:
    org.apache.jackrabbit.oak.api.jmx.CheckpointMBean
    public abstract class AbstractCheckpointMBean
extends java.lang.Object
implements org.apache.jackrabbit.oak.api.jmx.CheckpointMBean
    Abstract base class for CheckpointMBean implementations. This class provides the basic functionality for converting checkpoints into tabular data.

    • Field Summary

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

        TYPE

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected abstract void collectCheckpoints​(javax.management.openmbean.TabularDataSupport tab)
      Called to collect the tabular data for the checkpoints.
      java.util.Date getOldestCheckpointCreationDate()  
      abstract long getOldestCheckpointCreationTimestamp()  
      javax.management.openmbean.TabularData listCheckpoints()  
      protected javax.management.openmbean.CompositeDataSupport toCompositeData​(java.lang.String id, java.lang.String created, java.lang.String expires, java.util.Map<java.lang.String,​java.lang.String> properties)
      Utility method for converting the fields associated with a checkpoint to the composite data format.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.apache.jackrabbit.oak.api.jmx.CheckpointMBean

        createCheckpoint, releaseCheckpoint

    • Constructor Detail

      • AbstractCheckpointMBean

        public AbstractCheckpointMBean()

    • Method Detail

      • collectCheckpoints

        protected abstract void collectCheckpoints​(javax.management.openmbean.TabularDataSupport tab)
                                    throws javax.management.openmbean.OpenDataException
        Called to collect the tabular data for the checkpoints. Each checkpoint should be represented by a single row in tab. Implementors should use the 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.
        Parameters:
        tab -
        Throws:
        javax.management.openmbean.OpenDataException

      • listCheckpoints

        public javax.management.openmbean.TabularData listCheckpoints()
        Specified by:
        listCheckpoints in interface org.apache.jackrabbit.oak.api.jmx.CheckpointMBean

      • getOldestCheckpointCreationTimestamp

        public abstract long getOldestCheckpointCreationTimestamp()
        Specified by:
        getOldestCheckpointCreationTimestamp in interface org.apache.jackrabbit.oak.api.jmx.CheckpointMBean

      • getOldestCheckpointCreationDate

        public java.util.Date getOldestCheckpointCreationDate()
        Specified by:
        getOldestCheckpointCreationDate in interface org.apache.jackrabbit.oak.api.jmx.CheckpointMBean

      • toCompositeData

        protected final javax.management.openmbean.CompositeDataSupport toCompositeData​(java.lang.String id,
                                                                                java.lang.String created,
                                                                                java.lang.String expires,
                                                                                java.util.Map<java.lang.String,​java.lang.String> properties)
                                                                         throws javax.management.openmbean.OpenDataException
        Utility method for converting the fields associated with a checkpoint to the composite data format.
        Parameters:
        id - id of the checkpoint
        created - creation data of the checkpoint
        expires - expiry data of the checkpoint
        Returns:
        composite data representation of the fields associated with the checkpoint
        Throws:
        javax.management.openmbean.OpenDataException