Package org.opends.server.backends.pluggable

Class BackendStat

  • All Implemented Interfaces:
    Closeable, AutoCloseable
    public final class BackendStat
extends com.forgerock.opendj.cli.Tool
    This program provides a utility that may be used to debug a Pluggable Backend. This tool provides the ability to:
    • list root containers
    • list entry containers
    • list Trees in a Backend or Storage
    • gather information about Backend indexes
    • dump the contents of a Tree either at the Backend or the Storage layer.
    This will be a process that is intended to run outside of Directory Server and not internally within the server process (e.g., via the tasks interface); it still requires configuration information and access to Directory Server instance data.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.forgerock.opendj.cli.Tool

        com.forgerock.opendj.cli.Tool.Style

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static void main​(String[] args)
      Provides the command-line arguments to the main tool for processing.
      static com.forgerock.opendj.cli.ReturnCode main​(String[] args, PrintStream outStream, PrintStream errStream)
      Provides the command-line arguments to the main tool for processing and returns the exit code as an integer.
      com.forgerock.opendj.cli.ReturnCode run​(String... args)
      Parses the provided command-line arguments and makes the appropriate changes to the Directory Server configuration.

      • Methods inherited from class com.forgerock.opendj.cli.Tool

        askPort, close, confirmAction, enableConsoleLoggingIfVerbose, errPrintln, errPrintln, errPrintln, errPrintlnSurroundedByBlankLines, errPrintVerboseMessage, flush, flushLogStream, getErrorStream, getErrStream, getInputStream, getOutputStream, isFullyInteractive, isQuiet, isScriptFriendly, isVerbose, logVerboseMessage, mayPrompt, parseArguments, pressReturnToContinue, print, println, println, println, printlnNoWrap, printlnSurroundedByBlankLines, printNoWrap, readInput, readInput, readInputAllowEmpty, readLineOfInput, readPassword, readValidatedInput, readValidatedInputOrThrow, report

    • Method Detail

      • main

        public static void main​(String[] args)
        Provides the command-line arguments to the main tool for processing.
        Parameters:
        args - The set of command-line arguments provided to this program.

      • main

        public static com.forgerock.opendj.cli.ReturnCode main​(String[] args,
                                                       PrintStream outStream,
                                                       PrintStream errStream)
        Provides the command-line arguments to the main tool for processing and returns the exit code as an integer.
        Parameters:
        args - The set of command-line arguments provided to this program.
        outStream - The output stream for standard output.
        errStream - The output stream for standard error.
        Returns:
        Zero to indicate that the program completed successfully, or non-zero to indicate that an error occurred.

      • run

        public com.forgerock.opendj.cli.ReturnCode run​(String... args)
                                        throws com.forgerock.opendj.cli.ClientException
        Parses the provided command-line arguments and makes the appropriate changes to the Directory Server configuration.
        Overrides:
        run in class com.forgerock.opendj.cli.Tool
        Parameters:
        args - The command-line arguments provided to this program.
        Returns:
        The exit code from the configuration processing. A nonzero value indicates that there was some kind of problem during the configuration processing.
        Throws:
        com.forgerock.opendj.cli.ClientException - If an error occurs while running the tool.