org.opends.server.tools.tasks

Class TaskTool

java.lang.Object

com.forgerock.opendj.cli.Tool

org.opends.server.tools.tasks.TaskTool

All Implemented Interfaces:

Closeable, AutoCloseable, TaskScheduleInformation

Direct Known Subclasses:

BackUpDb, ExportLdif, ImportLdif, RebuildIndex, RestoreDb

public abstract class TaskTool
extends com.forgerock.opendj.cli.Tool
implements TaskScheduleInformation

Base class for tools that are capable of operating either by running local within this JVM or by scheduling a task to perform the same action running within the directory server through the tasks interface.

Nested Class Summary

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

com.forgerock.opendj.cli.Tool.Style

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canInitializeServer true if the server needs to be initialized during the tool execution.
static String	NOW Magic value used to indicate that the user would like to schedule this operation to run immediately as a task as opposed to running the operation in the local VM.
protected static String	OPTION_LONG_COMPRESS The value for the long option compress.
protected static String	OPTION_LONG_TMP_DIRECTORY The value for the tmp directory long option.
protected static Character	OPTION_SHORT_BACKEND_ID The value for the "backendId" short option.
protected static char	OPTION_SHORT_COMPRESS The value for the short option compress.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TaskTool(OutputStream out, OutputStream err, String className, LocalizableMessage toolDescription, boolean canInitializeServer) Creates a new task tool instance with provided standard and error out streams.

Method Summary

Modifier and Type	Method and Description
protected void	addAttribute(Entry taskEntry, String attrName, com.forgerock.opendj.cli.Argument argument) Adds the provided attribute with the argument value(s) to the provided task entry only if the argument has been provided on the command line.
protected void	addAttributeIfArgumentPresent(Entry taskEntry, String attrName, com.forgerock.opendj.cli.Argument argument) Adds the attribute with the argument value to the task entry if the argument corresponding to the attribute has been provided on the command line.
protected void	cleanup() Cleanup task environment after offline run.
protected com.forgerock.opendj.cli.ArgumentParser	getArgumentParser() Returns the ArgumentParser used by this tool.
Collection<String>	getDependencyIds() Gets a list of task IDs upon which this task is dependent.
FailedDependencyAction	getFailedDependencyAction() Gets the action to take should one of the dependent task fail.
Collection<String>	getNotifyUponCompletionEmailAddresses() Gets a list of email address to which an email will be sent when this task completes.
Collection<String>	getNotifyUponErrorEmailAddresses() Gets a list of email address to which an email will be sent if this task encounters an error during execution.
String	getRecurringDateTime() Gets the date/time pattern for recurring task schedule.
Date	getStartDateTime() Gets the date at which this task should be scheduled to start.
protected boolean	isEmbedded() Returns true if the tool is running in embedded mode.
protected com.forgerock.opendj.cli.ReturnCode	process() Either invokes initiates this tool's local action or schedule this tool using the tasks interface based on user input.
protected abstract com.forgerock.opendj.cli.ReturnCode	processLocal() Called when this utility should perform its actions locally in this JVM.
com.forgerock.opendj.cli.ReturnCode	run(String... args) Run this Tool tool with the provided arguments.
protected static void	runEmbeddedOffline(TaskTool taskTool, com.forgerock.opendj.cli.ArgumentsBuilder arguments) Adds the --offline and --noPropertyFile arguments to the provided arguments and runs the provided taskTool.
protected boolean	runOffline() /** Indicates whether we must return if the command must be run in off-line mode.
protected abstract com.forgerock.opendj.cli.ReturnCode	runTaskTool(String[] args) Runs the concrete tool implementation with the provided arguments.
protected void	shutdownBackends() Shutdowns all backends.
protected void	validateArguments(String[] args) Parses the provided arguments and validates task arguments.
protected void	validateTaskArgs() Validates arguments related to task scheduling.

Methods inherited from class com.forgerock.opendj.cli.Tool

askConfirmation, askPort, close, confirmAction, enableConsoleLoggingIfVerbose, errPrintln, errPrintln, errPrintln, errPrintlnSurroundedByBlankLines, errPrintVerboseMessage, flush, flushLogStream, getErrorStream, getErrStream, getInputStream, getOutputStream, isFullyInteractive, isQuiet, isScriptFriendly, isVerbose, logVerboseMessage, mayPrompt, parseArguments, pressReturnToContinue, print, println, println, println, println, printlnNoWrap, printlnSurroundedByBlankLines, printNoWrap, readInput, readInput, readInputAllowEmpty, readLineOfInput, readPassword, readPassword, readValidatedInput, readValidatedInput, report

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opends.server.tools.tasks.TaskScheduleInformation

addTaskAttributes, getTaskClass, getTaskId, getTaskObjectclass

Field Detail

OPTION_LONG_COMPRESS

protected static final String OPTION_LONG_COMPRESS

The value for the long option compress.

See Also:

Constant Field Values

OPTION_SHORT_COMPRESS

protected static final char OPTION_SHORT_COMPRESS

The value for the short option compress.

See Also:

Constant Field Values

OPTION_SHORT_BACKEND_ID

protected static final Character OPTION_SHORT_BACKEND_ID

The value for the "backendId" short option.

OPTION_LONG_TMP_DIRECTORY

protected static final String OPTION_LONG_TMP_DIRECTORY

The value for the tmp directory long option.

See Also:

Constant Field Values

NOW

public static final String NOW

Magic value used to indicate that the user would like to schedule this operation to run immediately as a task as opposed to running the operation in the local VM.

See Also:

Constant Field Values

canInitializeServer

protected final boolean canInitializeServer

true if the server needs to be initialized during the tool execution.

Constructor Detail

TaskTool

protected TaskTool(OutputStream out,
                   OutputStream err,
                   String className,
                   LocalizableMessage toolDescription,
                   boolean canInitializeServer)

Creates a new task tool instance with provided standard and error out streams.

Provided OutputStreams will be wrapped as PrintStream.

Parameters:

out - The output stream (may be null).

err - The error stream (may be null).

className - The name of the tool class.

toolDescription - The localized tool description.

canInitializeServer - true if the server can be initialized, false otherwise (basically, because this is executed in the context of a unit-test).

Method Detail

runEmbeddedOffline

protected static void runEmbeddedOffline(TaskTool taskTool,
                                         com.forgerock.opendj.cli.ArgumentsBuilder arguments)
                                  throws com.forgerock.opendj.cli.ClientException

Adds the --offline and --noPropertyFile arguments to the provided arguments and runs the provided taskTool.

Parameters:

taskTool - The TaskTool to run

arguments - The arguments to update

Throws:

com.forgerock.opendj.cli.ClientException - If an error occurs during the tool execution or if the tool has returned a error ReturnCode

processLocal

protected abstract com.forgerock.opendj.cli.ReturnCode processLocal()
                                                             throws com.forgerock.opendj.cli.ClientException

Called when this utility should perform its actions locally in this JVM.

Returns:

int indicating the result of this action

Throws:

com.forgerock.opendj.cli.ClientException - If an error occurs while running the tool

cleanup

protected void cleanup()

Cleanup task environment after offline run. Default implementation does nothing. Tasks which initialize some static part of the DirectoryServer instance (e.g admin data local backends) must override this method to shutdown all needed component to prevent JVM environment alteration.

shutdownBackends

protected final void shutdownBackends()

Shutdowns all backends.

validateTaskArgs

protected void validateTaskArgs()
                         throws com.forgerock.opendj.cli.ArgumentException,
                                com.forgerock.opendj.cli.ClientException

Validates arguments related to task scheduling. This should be called after the ArgumentParser.parseArguments has been called.

Throws:

com.forgerock.opendj.cli.ArgumentException - if there is a problem with the arguments.

com.forgerock.opendj.cli.ClientException - if there is a problem with one of the values provided by the user.

validateArguments

protected final void validateArguments(String[] args)
                                throws com.forgerock.opendj.cli.ClientException

Parses the provided arguments and validates task arguments.

Parameters:

args - The command line arguments.

Throws:

com.forgerock.opendj.cli.ClientException - If the argument parsing fails.

getStartDateTime

public Date getStartDateTime()

Description copied from interface: TaskScheduleInformation

Gets the date at which this task should be scheduled to start.

Specified by:

getStartDateTime in interface TaskScheduleInformation

Returns:

date/time at which the task should be scheduled

getRecurringDateTime

public String getRecurringDateTime()

Description copied from interface: TaskScheduleInformation

Gets the date/time pattern for recurring task schedule.

Specified by:

getRecurringDateTime in interface TaskScheduleInformation

Returns:

recurring date/time pattern at which the task should be scheduled.

getDependencyIds

public Collection<String> getDependencyIds()

Description copied from interface: TaskScheduleInformation

Gets a list of task IDs upon which this task is dependent.

Specified by:

getDependencyIds in interface TaskScheduleInformation

Returns:

list of task IDs

getFailedDependencyAction

public FailedDependencyAction getFailedDependencyAction()

Description copied from interface: TaskScheduleInformation

Gets the action to take should one of the dependent task fail.

Specified by:

getFailedDependencyAction in interface TaskScheduleInformation

Returns:

action to take

getNotifyUponCompletionEmailAddresses

public Collection<String> getNotifyUponCompletionEmailAddresses()

Description copied from interface: TaskScheduleInformation

Gets a list of email address to which an email will be sent when this task completes.

Specified by:

getNotifyUponCompletionEmailAddresses in interface TaskScheduleInformation

Returns:

list of email addresses

getNotifyUponErrorEmailAddresses

public Collection<String> getNotifyUponErrorEmailAddresses()

Description copied from interface: TaskScheduleInformation

Gets a list of email address to which an email will be sent if this task encounters an error during execution.

Specified by:

getNotifyUponErrorEmailAddresses in interface TaskScheduleInformation

Returns:

list of email addresses

run

public com.forgerock.opendj.cli.ReturnCode run(String... args)
                                        throws com.forgerock.opendj.cli.ClientException

Description copied from class: com.forgerock.opendj.cli.Tool

Run this Tool tool with the provided arguments. Output and errors will be written on the provided streams.

This method can be used to run the tool programmatically.

Overrides:

run in class com.forgerock.opendj.cli.Tool

Parameters:

args - Arguments set to pass to the tool.

Returns:

The tool ReturnCode.

Throws:

com.forgerock.opendj.cli.ClientException - If an error occurs while running the tool.

runTaskTool

protected abstract com.forgerock.opendj.cli.ReturnCode runTaskTool(String[] args)
                                                            throws com.forgerock.opendj.cli.ClientException

Runs the concrete tool implementation with the provided arguments.

Parameters:

args - The command line arguments.

Returns:

The ReturnCode returned by the tool execution.

Throws:

com.forgerock.opendj.cli.ClientException - If an error occurs during tool execution.

process

protected final com.forgerock.opendj.cli.ReturnCode process()
                                                     throws com.forgerock.opendj.cli.ClientException

Either invokes initiates this tool's local action or schedule this tool using the tasks interface based on user input.

Returns:

int indicating the result of this action

Throws:

com.forgerock.opendj.cli.ClientException - If an error occurs during tool execution.

runOffline

protected boolean runOffline()

/** Indicates whether we must return if the command must be run in off-line mode.

Returns:

true if we must return if the command must be run in off-line mode and false otherwise.

isEmbedded

protected boolean isEmbedded()

Returns true if the tool is running in embedded mode.

Embedded mode would not change JDK logging configuration and will used running jvm slf4j loggers implementation

Returns:

true if the tool is running in embedded mode.

addAttributeIfArgumentPresent

protected void addAttributeIfArgumentPresent(Entry taskEntry,
                                             String attrName,
                                             com.forgerock.opendj.cli.Argument argument)

Adds the attribute with the argument value to the task entry if the argument corresponding to the attribute has been provided on the command line.

Parameters:

taskEntry - The task Entry to update

attrName - The attribute corresponding to the argument

argument - The argument representing the attribute

addAttribute

protected void addAttribute(Entry taskEntry,
                            String attrName,
                            com.forgerock.opendj.cli.Argument argument)

Adds the provided attribute with the argument value(s) to the provided task entry only if the argument has been provided on the command line.

Parameters:

taskEntry - The task Entry to update.

attrName - A String representing the attribute name corresponding to the Argument.

argument - The Argument containing the attribute value(s).

getArgumentParser

protected com.forgerock.opendj.cli.ArgumentParser getArgumentParser()

Returns the ArgumentParser used by this tool.

Returns:

the ArgumentParser used by this tool.