Package org.forgerock.opendj.setup.cli

Class SetupProfileCli

  • All Implemented Interfaces:
    Closeable, AutoCloseable
    public final class SetupProfileCli
extends com.forgerock.opendj.cli.Tool
    setup-profile command line tool main class.
    See Also:
    main(String[])

    • 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)
      Runs this tool with the provided the command-line arguments and terminates the running JVM with an int representing the code returned by the tool.
      com.forgerock.opendj.cli.ReturnCode run​(String... args)
      Run setup-profile tool with the provided arguments.

      • 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)
        Runs this tool with the provided the command-line arguments and terminates the running JVM with an int representing the code returned by the tool.

        This method is only meant to be called by scripts.

        Parameters:
        args - The set of command-line arguments provided to this program.

      • run

        public com.forgerock.opendj.cli.ReturnCode run​(String... args)
                                        throws com.forgerock.opendj.cli.ClientException
        Run setup-profile tool with the provided arguments.

        Note: Exception handling is not fully delegated to Utils.runTool(Tool, String...) since has this tool shares code with the setup tool, it has to duplicate part of its exception handling behavior as well so that error codes and messages are consistent between both tools.

        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.