org.opends.server.tools
Class BackUpDB

java.lang.Object
  extended by org.opends.server.tools.tasks.TaskTool
      extended by 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
 
Constructor Summary
BackUpDB()
           
 
Method Summary
 void addTaskAttributes(java.util.List<RawAttribute> attributes)
          Adds utility specific attributes to attributes for population of the entry that is added to the task backend.
 java.lang.Class getTaskClass()
          Gets the Class that implements the utility to execute.
 java.lang.String getTaskObjectclass()
          Gets the objectclass used to represent scheduled instances of this utility in the task backend.
static void main(java.lang.String[] args)
          The main method for BackUpDB tool.
static int mainBackUpDB(java.lang.String[] args)
          Processes the command-line arguments and invokes the backup process.
static int mainBackUpDB(java.lang.String[] args, boolean initializeServer, java.io.OutputStream outStream, java.io.OutputStream errStream)
          Processes the command-line arguments and invokes the backup process.
protected  int processLocal(boolean initializeServer, java.io.PrintStream out, java.io.PrintStream err)
          Called when this utility should perform its actions locally in this JVM.
 
Methods inherited from class org.opends.server.tools.tasks.TaskTool
createArgParser, getDependencyIds, getFailedDependencyAction, getNotifyUponCompletionEmailAddresses, getNotifyUponErrorEmailAddresses, getStartDateTime, process, 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(java.lang.String[] args)
The main method for BackUpDB tool.

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

mainBackUpDB

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

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

mainBackUpDB

public static int mainBackUpDB(java.lang.String[] args,
                               boolean initializeServer,
                               java.io.OutputStream outStream,
                               java.io.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(java.util.List<RawAttribute> attributes)
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 java.lang.String getTaskObjectclass()
Gets the objectclass used to represent scheduled instances of this utility in the task backend.

Returns:
String representation of this utilities objectclass

getTaskClass

public java.lang.Class getTaskClass()
Gets the Class that implements the utility to execute.

Returns:
class of the tasks implementation

processLocal

protected int processLocal(boolean initializeServer,
                           java.io.PrintStream out,
                           java.io.PrintStream err)
Called when this utility should perform its actions locally in this JVM.

Specified by:
processLocal in class TaskTool
Parameters:
initializeServer - indicates whether or not 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