Package org.opends.server.tools

Class ManageTasks

  • All Implemented Interfaces:
    Closeable, AutoCloseable
    public final class ManageTasks
extends com.forgerock.opendj.cli.InteractiveTool
    Tool for getting information and managing tasks in the Directory Server.

    • 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)
      The main method for TaskInfo tool.
      static int mainManageTasks​(String[] args, PrintStream out, PrintStream err)
      Processes the command-line arguments and invokes the export process.
      com.forgerock.opendj.cli.ReturnCode run​(String... args)
      Run this Tool tool with the provided arguments.

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

        getErrStream, isFullyInteractive

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

        askPort, close, confirmAction, enableConsoleLoggingIfVerbose, errPrintln, errPrintln, errPrintln, errPrintlnSurroundedByBlankLines, errPrintVerboseMessage, flush, flushLogStream, getErrorStream, getInputStream, getOutputStream, 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)
        The main method for TaskInfo tool.
        Parameters:
        args - The command-line arguments provided to this program.

      • mainManageTasks

        public static int mainManageTasks​(String[] args,
                                  PrintStream out,
                                  PrintStream err)
        Processes the command-line arguments and invokes the export process.
        Parameters:
        args - The command-line arguments provided to this
        out - The output stream to use for standard output, or null if standard output is not needed.
        err - The output stream to use for standard error, or null if standard error is not needed.
        Returns:
        int return code

      • 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:
        0 if all processing completed successfully, or non-zero if an error occurred.
        Throws:
        com.forgerock.opendj.cli.ClientException - If an error occurs while running the tool.