Package org.opends.server.tools

Class CreateRcScript

  • All Implemented Interfaces:
    Closeable, AutoCloseable
    public final class CreateRcScript
extends com.forgerock.opendj.cli.Tool
    This program provides a tool that may be used to generate either an RC script that can be used to start, stop, restart and get status of the Directory Server, OR to a systemd(1) service file for Linux. It is only intended for use on UNIX-based systems.

    • 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)
      Parse the command line arguments and create an RC script or service that can be used to control the server.
      static int mainCreateRcScript​(String[] args, PrintStream outStream, PrintStream errStream)
      Processes the command-line arguments and creates an RC script or service that can be used to control the server.
      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

        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)
        Parse the command line arguments and create an RC script or service that can be used to control the server.
        Parameters:
        args - The command-line arguments provided to this program.

      • mainCreateRcScript

        public static int mainCreateRcScript​(String[] args,
                                     PrintStream outStream,
                                     PrintStream errStream)
        Processes the command-line arguments and creates an RC script or service that can be used to control the server.
        Parameters:
        args - The command-line arguments provided to this program.
        outStream - The output stream to use for standard output, or null if standard output is not needed.
        errStream - The output stream to use for standard error, or null if standard error is not needed.
        Returns:
        The tool 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.