org.opends.server.tools

Class BackUpDb

java.lang.Object

com.forgerock.opendj.cli.Tool

org.opends.server.tools.tasks.TaskTool

org.opends.server.tools.BackUpDb

All Implemented Interfaces:

Closeable, AutoCloseable, TaskScheduleInformation

public final class BackUpDb
extends TaskTool

This program provides a utility that may be used to back up a Directory Server backend in a binary form that may be quickly archived and restored. The format of the backup may vary based on the backend type and does not need to be something that can be handled by any other backend type. This will be a process that is intended to run separate from Directory Server and not internally within the server process (e.g., via 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 inherited from class org.opends.server.tools.tasks.TaskTool

canInitializeServer, NOW, OPTION_LONG_COMPRESS, OPTION_LONG_TMP_DIRECTORY, OPTION_SHORT_BACKEND_ID, OPTION_SHORT_COMPRESS

Method Summary

Modifier and Type	Method and Description
void	addTaskAttributes(Entry taskEntry) Adds utility specific attributes to the provided task entry that is added to the task backend.
Class<?>	getTaskClass() Gets the Class that implements the utility to execute.
String	getTaskId() Gets an arbitrary task id assigned to this task.
String	getTaskObjectclass() Gets the objectclass used to represent scheduled instances of this utility in the task backend.
static void	main(String[] args) The main method for BackUpDb tool.
static int	mainBackUpDb(String[] args, boolean canInitializeServer, OutputStream outStream, OutputStream errStream) Processes the command-line arguments and invokes the backup process.
protected com.forgerock.opendj.cli.ReturnCode	processLocal() Called when this utility should perform its actions locally in this JVM.
protected com.forgerock.opendj.cli.ReturnCode	runTaskTool(String[] args) Runs the concrete tool implementation with the provided arguments.

Methods inherited from class org.opends.server.tools.tasks.TaskTool

addAttribute, addAttributeIfArgumentPresent, cleanup, getArgumentParser, getDependencyIds, getFailedDependencyAction, getNotifyUponCompletionEmailAddresses, getNotifyUponErrorEmailAddresses, getRecurringDateTime, getStartDateTime, isEmbedded, process, run, runEmbeddedOffline, runOffline, shutdownBackends, validateArguments, validateTaskArgs

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

Method Detail

main

public static void main(String[] args)

The main method for BackUpDb tool.

Parameters:

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

mainBackUpDb

public static int mainBackUpDb(String[] args,
                               boolean canInitializeServer,
                               OutputStream outStream,
                               OutputStream errStream)

Processes the command-line arguments and invokes the backup process.

Parameters:

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

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

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.

Returns:

The error code.

runTaskTool

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

Description copied from class: TaskTool

Runs the concrete tool implementation with the provided arguments.

Specified by:

runTaskTool in class TaskTool

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.

addTaskAttributes

public void addTaskAttributes(Entry taskEntry)

Description copied from interface: TaskScheduleInformation

Adds utility specific attributes to the provided task entry that is added to the task backend.

Parameters:

taskEntry - The task Entry to update.

getTaskObjectclass

public String getTaskObjectclass()

Description copied from interface: TaskScheduleInformation

Gets the objectclass used to represent scheduled instances of this utility in the task backend.

Returns:

String representation of this utilities objectclass

getTaskClass

public Class<?> getTaskClass()

Description copied from interface: TaskScheduleInformation

Gets the Class that implements the utility to execute.

Returns:

class of the tasks implementation

processLocal

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

Description copied from class: TaskTool

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

Specified by:

processLocal in class TaskTool

Returns:

int indicating the result of this action

Throws:

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

getTaskId

public String getTaskId()

Description copied from interface: TaskScheduleInformation

Gets an arbitrary task id assigned to this task.

Returns:

assigned task id if any or null otherwise.