org.opends.server.tools
Class ManageTasks

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

public class ManageTasks
extends ConsoleApplication

Tool for getting information and managing tasks in the Directory Server.


Field Summary
 
Fields inherited from class org.opends.server.util.cli.ConsoleApplication
CONFIRMATION_MAX_TRIES
 
Constructor Summary
ManageTasks(java.io.InputStream in, java.io.OutputStream out, java.io.OutputStream err)
          Constructs a parameterized instance.
 
Method Summary
 TaskClient getTaskClient()
          Gets the client that can be used to interact with the task backend.
 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 TaskInfo tool.
static int mainTaskInfo(java.lang.String[] args)
          Processes the command-line arguments and invokes the process for displaying task information.
static int mainTaskInfo(java.lang.String[] args, java.io.InputStream in, java.io.OutputStream out, java.io.OutputStream err)
          Processes the command-line arguments and invokes the export process.
 int process(java.lang.String[] args)
          Processes the command-line arguments and invokes the export process.
 
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

ManageTasks

public ManageTasks(java.io.InputStream in,
                   java.io.OutputStream out,
                   java.io.OutputStream err)
Constructs a parameterized instance.

Parameters:
in - Input stream from which to solicit user input.
out - The output stream to use for standard output, or null if standard output is not needed.
err - The output stream to use for standard error, or null if standard error is not needed.
Method Detail

main

public static void main(java.lang.String[] args)
The main method for TaskInfo tool.

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

mainTaskInfo

public static int mainTaskInfo(java.lang.String[] args)
Processes the command-line arguments and invokes the process for displaying task information.

Parameters:
args - The command-line arguments provided to this program.
Returns:
int return code

mainTaskInfo

public static int mainTaskInfo(java.lang.String[] args,
                               java.io.InputStream in,
                               java.io.OutputStream out,
                               java.io.OutputStream err)
Processes the command-line arguments and invokes the export process.

Parameters:
args - The command-line arguments provided to this
in - Input stream from which to solicit user input.
out - The output stream to use for standard output, or null if standard output is not needed.
err - The output stream to use for standard error, or null if standard error is not needed.
Returns:
int return code

process

public int process(java.lang.String[] args)
Processes the command-line arguments and invokes the export process.

Parameters:
args - The command-line arguments provided to this program.
Returns:
The error code.

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.

getTaskClient

public TaskClient getTaskClient()
Gets the client that can be used to interact with the task backend.

Returns:
TaskClient for interacting with the task backend.