org.opends.server.tools.dsconfig
Class DSConfig

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

public final class DSConfig
extends ConsoleApplication

This class provides a command-line tool which enables administrators to configure the Directory Server.


Field Summary
static java.lang.String CUSTOM_TYPE
          The type name which will be used for the most generic managed object types when they are instantiable and intended for customization only.
static java.lang.String GENERIC_TYPE
          The type name which will be used for the most generic managed object types when they are instantiable and not intended for customization.
 
Fields inherited from class org.opends.server.util.cli.ConsoleApplication
CONFIRMATION_MAX_TRIES
 
Method Summary
 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)
          Provides the command-line arguments to the main application for processing.
static int main(java.lang.String[] args, boolean initializeServer, java.io.OutputStream outStream, java.io.OutputStream errStream)
          Provides the command-line arguments to the main application for processing and returns the exit code as an integer.
 
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
 

Field Detail

CUSTOM_TYPE

public static final java.lang.String CUSTOM_TYPE
The type name which will be used for the most generic managed object types when they are instantiable and intended for customization only.

See Also:
Constant Field Values

GENERIC_TYPE

public static final java.lang.String GENERIC_TYPE
The type name which will be used for the most generic managed object types when they are instantiable and not intended for customization.

See Also:
Constant Field Values
Method Detail

main

public static void main(java.lang.String[] args)
Provides the command-line arguments to the main application for processing.

Parameters:
args - The set of command-line arguments provided to this program.

main

public static int main(java.lang.String[] args,
                       boolean initializeServer,
                       java.io.OutputStream outStream,
                       java.io.OutputStream errStream)
Provides the command-line arguments to the main application for processing and returns the exit code as an integer.

Parameters:
args - The set of command-line arguments provided to this program.
initializeServer - Indicates whether to perform basic initialization (which should not be done if the tool is running in the same JVM as the server).
outStream - The output stream for standard output.
errStream - The output stream for standard error.
Returns:
Zero to indicate that the program completed successfully, or non-zero to indicate that an error occurred.

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.

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.

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.

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.

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.