Package org.opends.server.tools

Class InstallDS

java.lang.Object

com.forgerock.opendj.cli.ConsoleApplication

org.opends.server.tools.InstallDS

public class InstallDS
extends ConsoleApplication

This class provides a very simple mechanism for installing the OpenDS Directory Service. It performs the following tasks:

• Checks if the server is already installed and running
• Ask the user what base DN should be used for the data
• Ask the user whether to create the base entry, or to import LDIF
• Ask the user for the administration port and make sure it's available
• Ask the user for the LDAP port and make sure it's available
• Ask the user for the default root DN and password
• Ask the user to enable SSL or not and for the type of certificate that the server must use
• Ask the user if they want to start the server when done installing

Nested Class Summary

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

ConsoleApplication.Style

Method Summary

Modifier and Type	Method	Description
boolean	isAdvancedMode()	Indicates whether the user has requested advanced mode.
boolean	isInteractive()	Indicates whether the user has requested interactive behavior.
boolean	isMenuDrivenMode()	Indicates whether this console application is running in its menu-driven mode.
boolean	isQuiet()	Indicates whether the user has requested quiet output.
boolean	isScriptFriendly()	Indicates whether the user has requested script-friendly output.
boolean	isVerbose()	Indicates whether the user has requested verbose output.
static int	mainCLI(String[] args, OutputStream outStream, OutputStream errStream, Supplier<TempLogFile> tempLogFile)	Parses the provided command-line arguments and uses that information to run the setup tool.
static int	mainCLI(String[] args, OutputStream outStream, OutputStream errStream, TempLogFile tempLogFile)	Parses the provided command-line arguments and uses that information to run the setup tool.
static int	mainCLI(String[] args, Supplier<TempLogFile> tempLogFile)	Parses the provided command-line arguments and uses that information to run the setup tool.

Methods inherited from class com.forgerock.opendj.cli.ConsoleApplication

askConfirmation, askPort, confirmAction, errPrint, errPrintln, errPrintln, errPrintln, errPrintVerboseMessage, getErrorStream, getErrStream, getInputStream, getOutputStream, pressReturnToContinue, print, println, println, println, println, printlnNoWrap, printProgressBar, printVerboseMessage, readInput, readInput, readLineOfInput, readPassword, readPassword, readPort, readValidatedInput, readValidatedInput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

mainCLI

public static int mainCLI(String[] args,
                          Supplier<TempLogFile> tempLogFile)

Parses the provided command-line arguments and uses that information to run the setup tool.

Parameters:

args - the command-line arguments provided to this program.

tempLogFile - supplies the temporary log file where messages will be logged. It is called on the road that runs the install and not on the roads which return before it, so that a run which installs nothing creates no log.

Returns:

The error code.

mainCLI

public static int mainCLI(String[] args,
                          OutputStream outStream,
                          OutputStream errStream,
                          TempLogFile tempLogFile)

Parses the provided command-line arguments and uses that information to run the setup tool.

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.

tempLogFile - the temporary log file where messages will be logged.

Returns:

The error code.

mainCLI

public static int mainCLI(String[] args,
                          OutputStream outStream,
                          OutputStream errStream,
                          Supplier<TempLogFile> tempLogFile)

Parses the provided command-line arguments and uses that information to run the setup tool.

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.

tempLogFile - supplies the temporary log file where messages will be logged, see mainCLI(String[], Supplier).

Returns:

The error code.

isQuiet

public boolean isQuiet()

Description copied from class: ConsoleApplication

Indicates whether the user has requested quiet output. The default implementation returns false.

Overrides:

isQuiet in class ConsoleApplication

Returns:

true if the user has requested quiet output.

isInteractive

public boolean isInteractive()

Description copied from class: ConsoleApplication

Indicates whether the user has requested interactive behavior. The default implementation returns true.

Overrides:

isInteractive in class ConsoleApplication

Returns:

true if the user has requested interactive behavior.

isMenuDrivenMode

public boolean isMenuDrivenMode()

Description copied from class: ConsoleApplication

Indicates whether this console application is running in its menu-driven mode. This can be used to dictate whether output should go to the error stream or not. In addition, it may also dictate whether sub-menus should display a cancel option as well as a quit option.

Overrides:

isMenuDrivenMode in class ConsoleApplication

Returns:

Returns true if this console application is running in its menu-driven mode.

isScriptFriendly

public boolean isScriptFriendly()

Description copied from class: ConsoleApplication

Indicates whether the user has requested script-friendly output. The default implementation returns false.

Overrides:

isScriptFriendly in class ConsoleApplication

Returns:

true if the user has requested script-friendly output.

isAdvancedMode

public boolean isAdvancedMode()

Description copied from class: ConsoleApplication

Indicates whether the user has requested advanced mode.

Overrides:

isAdvancedMode in class ConsoleApplication

Returns:

Returns true if the user has requested advanced mode.

isVerbose

public boolean isVerbose()

Description copied from class: ConsoleApplication

Indicates whether the user has requested verbose output. The default implementation returns false.

Overrides:

isVerbose in class ConsoleApplication

Returns:

true if the user has requested verbose output.