Class ChangelogStat

  • All Implemented Interfaces:
    Closeable, AutoCloseable

    public final class ChangelogStat
    extends com.forgerock.opendj.cli.Tool
    Tool that may be used to debug a replication changelog. It can:
    • dump the content of the change number DB
    • dump the content of the replica DB for a given domain and replica ID
    • dump the content of a given replica changelog file
    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 int main​(String[] args, OutputStream outStream, OutputStream 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)
      Run this Tool tool with the provided arguments.
      • Methods inherited from class com.forgerock.opendj.cli.Tool

        askConfirmation, 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, 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 int main​(String[] args,
                               OutputStream outStream,
                               OutputStream 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
        Description copied from class: com.forgerock.opendj.cli.Tool
        Run this Tool tool with the provided arguments. Output and errors will be written on the provided streams.

        This method can be used to run the tool programmatically.

        Overrides:
        run in class com.forgerock.opendj.cli.Tool
        Parameters:
        args - Arguments set to pass to the tool.
        Returns:
        The tool ReturnCode.
        Throws:
        com.forgerock.opendj.cli.ClientException - If an error occurs while running the tool.