Package org.opends.server.tools

Class WaitForFileDelete

java.lang.Object

com.forgerock.opendj.cli.ConsoleApplication

org.opends.server.tools.WaitForFileDelete

public class WaitForFileDelete
extends ConsoleApplication

This program provides a simple tool that will wait for a specified file to be deleted before exiting. It can be used in the process of confirming that the server has completed its startup or shutdown process.

Nested Class Summary

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

ConsoleApplication.Style

Field Summary

Fields

Modifier and Type	Field	Description
static int	EXIT_CODE_INTERNAL_ERROR	The exit code value that will be used if an internal error occurs within this program.
static int	EXIT_CODE_SUCCESS	The exit code value that will be used if the target file is deleted successfully.
static int	EXIT_CODE_TIMEOUT	The exit code value that will be used if a timeout occurs while waiting for the file to be removed.

Constructor Summary

Constructors

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

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 void	main(String[] args)	Processes the command-line arguments and initiates the process of waiting for the file to be removed.
static int	mainCLI(String[] args, boolean initializeServer, OutputStream outStream, OutputStream errStream, InputStream inStream)	Processes the command-line arguments and initiates the process of waiting for the file to be removed.

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

Field Detail

EXIT_CODE_SUCCESS

public static final int EXIT_CODE_SUCCESS

The exit code value that will be used if the target file is deleted successfully.

See Also:

Constant Field Values

EXIT_CODE_INTERNAL_ERROR

public static final int EXIT_CODE_INTERNAL_ERROR

The exit code value that will be used if an internal error occurs within this program.

See Also:

Constant Field Values

EXIT_CODE_TIMEOUT

public static final int EXIT_CODE_TIMEOUT

The exit code value that will be used if a timeout occurs while waiting for the file to be removed.

See Also:

Constant Field Values

Constructor Detail

WaitForFileDelete

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

Constructor for the WaitForFileDelete 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)

Processes the command-line arguments and initiates the process of waiting for the file to be removed.

Parameters:

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

mainCLI

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

Processes the command-line arguments and initiates the process of waiting for the file to be removed.

Parameters:

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

initializeServer - Indicates whether to initialize the server.

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.

isAdvancedMode

public boolean isAdvancedMode()

Indicates whether the user has requested advanced mode.

Overrides:

isAdvancedMode in class ConsoleApplication

Returns:

Returns true if the user has requested advanced mode.

isInteractive

public boolean isInteractive()

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()

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.

isQuiet

public boolean isQuiet()

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.

isScriptFriendly

public boolean isScriptFriendly()

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.

isVerbose

public boolean isVerbose()

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.