org.opends.server.tools
Class JavaPropertiesTool

java.lang.Object
  extended by org.opends.server.util.cli.ConsoleApplication
      extended by org.opends.server.tools.JavaPropertiesTool

public class JavaPropertiesTool
extends 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
static class JavaPropertiesTool.ErrorReturnCode
          The enumeration containing the different return codes that the command-line can have.
 
Field Summary
 
Fields inherited from class org.opends.server.util.cli.ConsoleApplication
CONFIRMATION_MAX_TRIES
 
Constructor Summary
JavaPropertiesTool(java.io.PrintStream out, java.io.PrintStream err, java.io.InputStream in)
          Constructor for the JavaPropertiesTool object.
 
Method Summary
 int execute(java.lang.String[] args)
          Parses the provided command-line arguments and uses that information to run the java properties tool.
 boolean isAdvancedMode()
          Indicates whether or not the user has requested advanced mode.
 boolean isInteractive()
          Indicates whether or not the user has requested interactive behavior.
 boolean isMenuDrivenMode()
          Indicates whether or not this console application is running in its menu-driven mode.
 boolean isQuiet()
          Indicates whether or not the user has requested quiet output.
 boolean isScriptFriendly()
          Indicates whether or not the user has requested script-friendly output.
 boolean isVerbose()
          Indicates whether or not the user has requested verbose output.
static void main(java.lang.String[] args)
          The main method for the java properties tool.
static int mainCLI(java.lang.String[] args)
          Parses the provided command-line arguments and uses that information to run the java properties tool.
static int mainCLI(java.lang.String[] args, java.io.OutputStream outStream, java.io.OutputStream errStream, java.io.InputStream inStream)
          Parses the provided command-line arguments and uses that information to run the java properties tool.
 
Methods inherited from class org.opends.server.util.cli.ConsoleApplication
askConfirmation, confirmAction, createAdministrativeContext, createInitialLdapContextInteracting, getErrorStream, getInputStream, getOutputStream, pressReturnToContinue, print, println, println, println, printlnProgress, printProgress, 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(java.io.PrintStream out,
                          java.io.PrintStream err,
                          java.io.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(java.lang.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(java.lang.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(java.lang.String[] args,
                          java.io.OutputStream outStream,
                          java.io.OutputStream errStream,
                          java.io.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(java.lang.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).

isQuiet

public boolean isQuiet()
Indicates whether or not the user has requested quiet output.

Specified by:
isQuiet in class ConsoleApplication
Returns:
Returns true if the user has requested quiet output.

isInteractive

public boolean isInteractive()
Indicates whether or not the user has requested interactive behavior.

Specified by:
isInteractive in class ConsoleApplication
Returns:
Returns true if the user has requested interactive behavior.

isMenuDrivenMode

public boolean isMenuDrivenMode()
Indicates whether or not 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 or not sub-menus should display a cancel option as well as a quit option.

Specified by:
isMenuDrivenMode in class ConsoleApplication
Returns:
Returns true if this console application is running in its menu-driven mode.

isScriptFriendly

public boolean isScriptFriendly()
Indicates whether or not the user has requested script-friendly output.

Specified by:
isScriptFriendly in class ConsoleApplication
Returns:
Returns true if the user has requested script-friendly output.

isAdvancedMode

public boolean isAdvancedMode()
Indicates whether or not the user has requested advanced mode.

Specified by:
isAdvancedMode in class ConsoleApplication
Returns:
Returns true if the user has requested advanced mode.

isVerbose

public boolean isVerbose()
Indicates whether or not the user has requested verbose output.

Specified by:
isVerbose in class ConsoleApplication
Returns:
Returns true if the user has requested verbose output.