org.opends.server.tools

Class JavaPropertiesTool

java.lang.Object

com.forgerock.opendj.cli.ConsoleApplication

org.opends.server.tools.JavaPropertiesTool

public class JavaPropertiesTool
extends com.forgerock.opendj.cli.ConsoleApplication

This class is used to update the scripts that are used to launch the command lines. We read the contents of a given properties file and we update the scripts setting the arguments and JVM to be used by the different scripts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaPropertiesTool.ErrorReturnCode The enumeration containing the different return codes that the command-line can have.

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

com.forgerock.opendj.cli.ConsoleApplication.Style

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	execute(String[] args) Parses the provided command-line arguments and uses that information to run the java properties tool.
boolean	isAdvancedMode()
boolean	isInteractive()
boolean	isMenuDrivenMode()
boolean	isQuiet()
boolean	isScriptFriendly()
boolean	isVerbose()
static void	main(String[] args) The main method for the java properties tool.
static int	mainCLI(String... args) Parses the provided command-line arguments and uses that information to run the java properties 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 java properties tool.
static void	updateProperties(BufferedReader reader, Properties properties) Reads the contents of the provided reader and updates the provided Properties object with it.

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

Constructor Detail

JavaPropertiesTool

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

Constructor for the JavaPropertiesTool 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 java properties 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 java properties 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 java properties 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 java properties tool.

Parameters:

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

Returns:

the return code (SUCCESSFUL, USER_DATA_ERROR or BUG).

updateProperties

public static void updateProperties(BufferedReader reader,
                    Properties properties)
                             throws IOException

Reads the contents of the provided reader and updates the provided Properties object with it. This is required because '\' characters in windows paths generates problems.

Parameters:

reader - the buffered reader.

properties - the properties.

Throws:

IOException - if there is an error reading the buffered reader.

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