Package org.apache.jackrabbit.oak.api.jmx

Interface NodeCounterMBean

public interface NodeCounterMBean
An MBean that provides an approximate node count for a given path.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TYPE
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getEstimatedChildNodeCounts(String path, int level)
    Get the estimated number of nodes for the child nodes of a given path.
    long
    getEstimatedNodeCount(String path)
    Get the estimated number of nodes below a given path.

  • Field Details

  • Method Details

    • getEstimatedNodeCount

      @Description("Get the estimated number of nodes below a given path.") long getEstimatedNodeCount(@Description("the path") @Name("path") String path)
      Get the estimated number of nodes below a given path.
      Parameters:
      path - the path
      Returns:
      the estimated number of nodes, or -1 if unknown (if not index is available)

    • getEstimatedChildNodeCounts

      @Description("Get the estimated number of nodes below a given path.") String getEstimatedChildNodeCounts(@Description("the path") @Name("path") String path, @Description("the depth of the child nodes to list (the higher the number, the slower)") @Name("level") int level)
      Get the estimated number of nodes for the child nodes of a given path.
      Parameters:
      path - the path
      level - the depth of the child nodes to list
      Returns:
      a comma separated list of child nodes with the respective estimated counts