Package org.opends.server.tools

Class BackUpDB

java.lang.Object

org.opends.server.tools.tasks.TaskTool

org.opends.server.tools.BackUpDB

All Implemented Interfaces:

TaskScheduleInformation

public 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).

Field Summary

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

NOW, runOfflineArg

Constructor Summary

Constructors

Constructor	Description
BackUpDB()

Method Summary

Modifier and Type	Method	Description
void	addTaskAttributes(List<RawAttribute> attributes)	Adds utility specific attributes to attributes for population of the 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 initializeServer, OutputStream outStream, OutputStream errStream)	Processes the command-line arguments and invokes the backup process.
protected int	processLocal(boolean initializeServer, PrintStream out, PrintStream err)	Called when this utility should perform its actions locally in this JVM.

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

checkVersion, cleanup, createArgParser, getDependencyIds, getFailedDependencyAction, getNotifyUponCompletionEmailAddresses, getNotifyUponErrorEmailAddresses, getOfflineDescriptionMessage, getRecurringDateTime, getStartDateTime, process, runOffline, validateTaskArgs

Methods inherited from class java.lang.Object

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

Constructor Detail

BackUpDB

public BackUpDB()

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 initializeServer,
                               OutputStream outStream,
                               OutputStream errStream)

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

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.

Returns:

The error code.

addTaskAttributes

public void addTaskAttributes(List<RawAttribute> attributes)

Description copied from interface: TaskScheduleInformation

Adds utility specific attributes to attributes for population of the entry that is added to the task backend.

Parameters:

attributes - that will be added to the task backend

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 int processLocal(boolean initializeServer,
                           PrintStream out,
                           PrintStream err)

Description copied from class: TaskTool

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

Specified by:

processLocal in class TaskTool

Parameters:

initializeServer - indicates whether to initialize the directory server in the case of a local action

out - stream to write messages; may be null

err - stream to write messages; may be null

Returns:

int indicating the result of this action

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.