org.opends.server.tools

Class InstallDS

java.lang.Object

com.forgerock.opendj.cli.ConsoleApplication

org.opends.server.tools.InstallDS

public class InstallDS
extends com.forgerock.opendj.cli.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

com.forgerock.opendj.cli.ConsoleApplication.Style

Field Summary

Fields

Modifier and Type	Field and Description
static int	LIMIT_KEYSTORE_PASSWORD_PROMPT The maximum number of times that we should ask the user to provide the password to access to a keystore.
static String	LOG_FILE_SUFFIX Suffix for log files.
static String	TMP_FILE_PREFIX Prefix for log files.

Constructor Summary

Constructors

Constructor and Description
InstallDS(PrintStream out, PrintStream err, InputStream in) Constructor for the InstallDS object.

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkCertificateInKeystore(SecurityOptions.CertificateType type, String path, String pwd, Collection<String> certNicknames, Collection<LocalizableMessage> errorMessages, Collection<String> nicknameList) Checks that the provided parameters are valid to access an existing key store.
static boolean	containsCertNicknameErrorMessage(Collection<LocalizableMessage> msgs) Tells if any of the error messages provided corresponds to a problem with the certificate nickname.
static boolean	containsKeyStorePasswordErrorMessage(Collection<LocalizableMessage> msgs) Tells if any of the error messages provided corresponds to a problem with the key store password.
static boolean	containsKeyStorePathErrorMessage(Collection<LocalizableMessage> msgs) Tells if any of the error messages provided corresponds to a problem with the key store path.
int	execute(String[] args) Parses the provided command-line arguments and uses that information to run the setup CLI.
boolean	isAdvancedMode()
boolean	isInteractive()
boolean	isMenuDrivenMode()
boolean	isQuiet()
boolean	isScriptFriendly()
boolean	isVerbose()
static void	main(String[] args) The main method for the InstallDS CLI tool.
static int	mainCLI(String[] args) Parses the provided command-line arguments and uses that information to run the setup tool.
static int	mainCLI(String[] args, OutputStream outStream, OutputStream errStream, InputStream inStream) 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, 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

Field Detail

TMP_FILE_PREFIX

public static final String TMP_FILE_PREFIX

Prefix for log files.

See Also:

Constant Field Values

LOG_FILE_SUFFIX

public static final String LOG_FILE_SUFFIX

Suffix for log files.

See Also:

Constant Field Values

LIMIT_KEYSTORE_PASSWORD_PROMPT

public static final int LIMIT_KEYSTORE_PASSWORD_PROMPT

The maximum number of times that we should ask the user to provide the password to access to a keystore.

See Also:

Constant Field Values

Constructor Detail

InstallDS

public InstallDS(PrintStream out,
         PrintStream err,
         InputStream in)

Constructor for the InstallDS object.

Parameters:

out - the print stream to use for standard output.

err - the print stream to use for standard error.

in - the input stream to use for standard input.

Method Detail

main

public static void main(String[] args)

The main method for the InstallDS CLI tool.

Parameters:

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

mainCLI

public static int mainCLI(String[] args)

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.

Returns:

The error code.

mainCLI

public static int mainCLI(String[] args,
          OutputStream outStream,
          OutputStream errStream,
          InputStream inStream)

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.

inStream - The input stream to use for standard input.

Returns:

The error code.

execute

public int execute(String[] args)

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

Parameters:

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

Returns:

the return code (SUCCESSFUL, USER_DATA_ERROR or BUG).

isQuiet

public boolean isQuiet()

Overrides:

isQuiet in class com.forgerock.opendj.cli.ConsoleApplication

isInteractive

public boolean isInteractive()

Overrides:

isInteractive in class com.forgerock.opendj.cli.ConsoleApplication

isMenuDrivenMode

public boolean isMenuDrivenMode()

Overrides:

isMenuDrivenMode in class com.forgerock.opendj.cli.ConsoleApplication

isScriptFriendly

public boolean isScriptFriendly()

Overrides:

isScriptFriendly in class com.forgerock.opendj.cli.ConsoleApplication

isAdvancedMode

public boolean isAdvancedMode()

Overrides:

isAdvancedMode in class com.forgerock.opendj.cli.ConsoleApplication

isVerbose

public boolean isVerbose()

Overrides:

isVerbose in class com.forgerock.opendj.cli.ConsoleApplication

checkCertificateInKeystore

public static void checkCertificateInKeystore(SecurityOptions.CertificateType type,
                              String path,
                              String pwd,
                              Collection<String> certNicknames,
                              Collection<LocalizableMessage> errorMessages,
                              Collection<String> nicknameList)

Checks that the provided parameters are valid to access an existing key store. This method adds the encountered errors to the provided list of LocalizableMessage. It also adds the alias (nicknames) found to the provided list of String.

Parameters:

type - the type of key store.

path - the path of the key store.

pwd - the password (PIN) to access the key store.

certNicknames - the certificate nicknames that we are looking for (or null if we just one to get the one that is in the key store).

errorMessages - the list that will be updated with the errors encountered.

nicknameList - the list that will be updated with the nicknames found in the key store.

containsKeyStorePathErrorMessage

public static boolean containsKeyStorePathErrorMessage(Collection<LocalizableMessage> msgs)

Tells if any of the error messages provided corresponds to a problem with the key store path.

Parameters:

msgs - the messages to analyze.

Returns:

true if any of the error messages provided corresponds to a problem with the key store path and false otherwise.

containsKeyStorePasswordErrorMessage

public static boolean containsKeyStorePasswordErrorMessage(Collection<LocalizableMessage> msgs)

Tells if any of the error messages provided corresponds to a problem with the key store password.

Parameters:

msgs - the messages to analyze.

Returns:

true if any of the error messages provided corresponds to a problem with the key store password and false otherwise.

containsCertNicknameErrorMessage

public static boolean containsCertNicknameErrorMessage(Collection<LocalizableMessage> msgs)

Tells if any of the error messages provided corresponds to a problem with the certificate nickname.

Parameters:

msgs - the messages to analyze.

Returns:

true if any of the error messages provided corresponds to a problem with the certificate nickname and false otherwise.