/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
* add the following below this CDDL HEADER, with the fields enclosed
* by brackets "[]" replaced with your own identifying information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2006-2009 Sun Microsystems, Inc.
* Portions copyright 2012-2013 ForgeRock AS.
*/
package org.opends.server.tools;
import org.opends.messages.Message;
import java.io.OutputStream;
import java.io.PrintStream;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import org.opends.server.api.Backend;
import org.opends.server.api.ErrorLogPublisher;
import org.opends.server.api.DebugLogPublisher;
import org.opends.server.config.ConfigException;
import static org.opends.server.config.ConfigConstants.*;
import org.opends.server.core.CoreConfigManager;
import org.opends.server.core.DirectoryServer;
import org.opends.server.core.LockFileManager;
import org.opends.server.extensions.ConfigFileHandler;
import org.opends.server.loggers.TextWriter;
import org.opends.server.loggers.ErrorLogger;
import org.opends.server.loggers.TextErrorLogPublisher;
import org.opends.server.loggers.debug.TextDebugLogPublisher;
import org.opends.server.loggers.debug.DebugLogger;
import org.opends.server.types.*;
import org.opends.server.util.BuildVersion;
import org.opends.server.util.args.ArgumentException;
import org.opends.server.util.args.BooleanArgument;
import org.opends.server.util.args.StringArgument;
import org.opends.server.util.args.LDAPConnectionArgumentParser;
import org.opends.server.util.cli.CLIException;
import static org.opends.server.loggers.ErrorLogger.*;
import static org.opends.messages.ToolMessages.*;
import static org.opends.server.util.ServerConstants.*;
import static org.opends.server.util.StaticUtils.*;
import static org.opends.server.tools.ToolConstants.*;
import org.opends.server.tools.tasks.TaskTool;
import org.opends.server.admin.std.server.BackendCfg;
import org.opends.server.protocols.ldap.LDAPAttribute;
import org.opends.server.tasks.RestoreTask;
/**
* This program provides a utility that may be used to restore a binary backup
* of a Directory Server backend generated using the BackUpDB tool. 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).
*/
public class RestoreDB extends TaskTool {
/**
* The main method for RestoreDB tool.
*
* @param args The command-line arguments provided to this program.
*/
public static void main(String[] args)
{
int retCode = mainRestoreDB(args, true, System.out, System.err);
if(retCode != 0)
{
System.exit(filterExitCode(retCode));
}
}
/**
* Processes the command-line arguments and invokes the restore process.
*
* @param args The command-line arguments provided to this program.
*
* @return The error code.
*/
public static int mainRestoreDB(String[] args)
{
return mainRestoreDB(args, true, System.out, System.err);
}
/**
* Processes the command-line arguments and invokes the restore process.
*
* @param args The command-line arguments provided to this
* program.
* @param initializeServer Indicates whether to initialize the server.
* @param outStream The output stream to use for standard output, or
* {@code null} if standard output is not needed.
* @param errStream The output stream to use for standard error, or
* {@code null} if standard error is not needed.
*
* @return The error code.
*/
public static int mainRestoreDB(String[] args, boolean initializeServer,
OutputStream outStream,
OutputStream errStream)
{
RestoreDB tool = new RestoreDB();
return tool.process(args, initializeServer, outStream, errStream);
}
// Define the command-line arguments that may be used with this program.
private BooleanArgument displayUsage = null;
private BooleanArgument listBackups = null;
private BooleanArgument verifyOnly = null;
private StringArgument backupIDString = null;
private StringArgument configClass = null;
private StringArgument configFile = null;
private StringArgument backupDirectory = null;
private int process(String[] args, boolean initializeServer,
OutputStream outStream, OutputStream errStream)
{
PrintStream out;
if (outStream == null)
{
out = NullOutputStream.printStream();
}
else
{
out = new PrintStream(outStream);
}
PrintStream err;
if (errStream == null)
{
err = NullOutputStream.printStream();
}
else
{
err = new PrintStream(errStream);
}
// Create the command-line argument parser for use with this program.
LDAPConnectionArgumentParser argParser =
createArgParser("org.opends.server.tools.RestoreDB",
INFO_RESTOREDB_TOOL_DESCRIPTION.get());
// Initialize all the command-line argument types and register them with the
// parser.
try
{
configClass =
new StringArgument("configclass", OPTION_SHORT_CONFIG_CLASS,
OPTION_LONG_CONFIG_CLASS, true, false,
true, INFO_CONFIGCLASS_PLACEHOLDER.get(),
ConfigFileHandler.class.getName(), null,
INFO_DESCRIPTION_CONFIG_CLASS.get());
configClass.setHidden(true);
argParser.addArgument(configClass);
configFile =
new StringArgument("configfile", 'f', "configFile", true, false,
true, INFO_CONFIGFILE_PLACEHOLDER.get(), null,
null,
INFO_DESCRIPTION_CONFIG_FILE.get());
configFile.setHidden(true);
argParser.addArgument(configFile);
backupIDString =
new StringArgument("backupid", 'I', "backupID", false, false, true,
INFO_BACKUPID_PLACEHOLDER.get(), null, null,
INFO_RESTOREDB_DESCRIPTION_BACKUP_ID.get());
argParser.addArgument(backupIDString);
backupDirectory =
new StringArgument("backupdirectory", 'd', "backupDirectory", true,
false, true, INFO_BACKUPDIR_PLACEHOLDER.get(),
null, null,
INFO_RESTOREDB_DESCRIPTION_BACKUP_DIR.get());
argParser.addArgument(backupDirectory);
listBackups = new BooleanArgument(
"listbackups", 'l', "listBackups",
INFO_RESTOREDB_DESCRIPTION_LIST_BACKUPS.get());
argParser.addArgument(listBackups);
verifyOnly = new BooleanArgument(
"verifyonly", OPTION_SHORT_DRYRUN,
OPTION_LONG_DRYRUN,
INFO_RESTOREDB_DESCRIPTION_VERIFY_ONLY.get());
argParser.addArgument(verifyOnly);
displayUsage =
new BooleanArgument("help", OPTION_SHORT_HELP, OPTION_LONG_HELP,
INFO_DESCRIPTION_USAGE.get());
argParser.addArgument(displayUsage);
argParser.setUsageArgument(displayUsage);
}
catch (ArgumentException ae)
{
Message message = ERR_CANNOT_INITIALIZE_ARGS.get(ae.getMessage());
err.println(wrapText(message, MAX_LINE_WIDTH));
return 1;
}
// Init the default values so that they can appear also on the usage.
try
{
argParser.getArguments().initArgumentsWithConfiguration();
}
catch (ConfigException ce)
{
// Ignore.
}
// Parse the command-line arguments provided to this program.
try
{
argParser.parseArguments(args);
validateTaskArgs();
}
catch (ArgumentException ae)
{
Message message = ERR_ERROR_PARSING_ARGS.get(ae.getMessage());
err.println(wrapText(message, MAX_LINE_WIDTH));
err.println(argParser.getUsage());
return 1;
}
catch (CLIException ce)
{
// No need to display the usage since the problem comes with a provided
// value.
err.println(wrapText(ce.getMessageObject(), MAX_LINE_WIDTH));
return 1;
}
// If we should just display usage or version information,
// then print it and exit.
if (argParser.usageOrVersionDisplayed())
{
return 0;
}
if (listBackups.isPresent() && argParser.connectionArgumentsPresent()) {
Message message = ERR_LDAP_CONN_INCOMPATIBLE_ARGS.get(
listBackups.getLongIdentifier());
err.println(wrapText(message, MAX_LINE_WIDTH));
return 1;
}
// Checks the version - if upgrade required, the tool is unusable
try
{
BuildVersion.checkVersionMismatch();
}
catch (InitializationException e)
{
err.println(wrapText(e.getMessage(), MAX_LINE_WIDTH));
return 1;
}
return process(argParser, initializeServer, out, err);
}
/**
* {@inheritDoc}
*/
public void addTaskAttributes(List<RawAttribute> attributes)
{
ArrayList<ByteString> values;
if (backupDirectory.getValue() != null &&
!backupDirectory.getValue().equals(
backupDirectory.getDefaultValue())) {
values = new ArrayList<ByteString>(1);
values.add(ByteString.valueOf(backupDirectory.getValue()));
attributes.add(
new LDAPAttribute(ATTR_BACKUP_DIRECTORY_PATH, values));
}
if (backupIDString.getValue() != null &&
!backupIDString.getValue().equals(
backupIDString.getDefaultValue())) {
values = new ArrayList<ByteString>(1);
values.add(ByteString.valueOf(backupIDString.getValue()));
attributes.add(
new LDAPAttribute(ATTR_BACKUP_ID, values));
}
if (verifyOnly.getValue() != null &&
!verifyOnly.getValue().equals(
verifyOnly.getDefaultValue())) {
values = new ArrayList<ByteString>(1);
values.add(ByteString.valueOf(verifyOnly.getValue()));
attributes.add(
new LDAPAttribute(ATTR_TASK_RESTORE_VERIFY_ONLY, values));
}
}
/**
* {@inheritDoc}
*/
public String getTaskObjectclass() {
return "ds-task-restore";
}
/**
* {@inheritDoc}
*/
public Class<?> getTaskClass() {
return RestoreTask.class;
}
/**
* {@inheritDoc}
*/
protected int processLocal(boolean initializeServer,
PrintStream out,
PrintStream err) {
// Perform the initial bootstrap of the Directory Server and process the
// configuration.
DirectoryServer directoryServer = DirectoryServer.getInstance();
if (initializeServer)
{
try
{
DirectoryServer.bootstrapClient();
DirectoryServer.initializeJMX();
}
catch (Exception e)
{
Message message = ERR_SERVER_BOOTSTRAP_ERROR.get(
getExceptionMessage(e));
err.println(wrapText(message, MAX_LINE_WIDTH));
return 1;
}
try
{
directoryServer.initializeConfiguration(configClass.getValue(),
configFile.getValue());
}
catch (InitializationException ie)
{
Message message = ERR_CANNOT_LOAD_CONFIG.get(ie.getMessage());
err.println(wrapText(message, MAX_LINE_WIDTH));
return 1;
}
catch (Exception e)
{
Message message = ERR_CANNOT_LOAD_CONFIG.get(getExceptionMessage(e));
err.println(wrapText(message, MAX_LINE_WIDTH));
return 1;
}
// Initialize the Directory Server schema elements.
try
{
directoryServer.initializeSchema();
}
catch (ConfigException ce)
{
Message message = ERR_CANNOT_LOAD_SCHEMA.get(ce.getMessage());
err.println(wrapText(message, MAX_LINE_WIDTH));
return 1;
}
catch (InitializationException ie)
{
Message message = ERR_CANNOT_LOAD_SCHEMA.get(ie.getMessage());
err.println(wrapText(message, MAX_LINE_WIDTH));
return 1;
}
catch (Exception e)
{
Message message = ERR_CANNOT_LOAD_SCHEMA.get(getExceptionMessage(e));
err.println(wrapText(message, MAX_LINE_WIDTH));
return 1;
}
// Initialize the Directory Server core configuration.
try
{
CoreConfigManager coreConfigManager = new CoreConfigManager();
coreConfigManager.initializeCoreConfig();
}
catch (ConfigException ce)
{
Message message = ERR_CANNOT_INITIALIZE_CORE_CONFIG.get(
ce.getMessage());
err.println(wrapText(message, MAX_LINE_WIDTH));
return 1;
}
catch (InitializationException ie)
{
Message message = ERR_CANNOT_INITIALIZE_CORE_CONFIG.get(
ie.getMessage());
err.println(wrapText(message, MAX_LINE_WIDTH));
return 1;
}
catch (Exception e)
{
Message message = ERR_CANNOT_INITIALIZE_CORE_CONFIG.get(
getExceptionMessage(e));
err.println(wrapText(message, MAX_LINE_WIDTH));
return 1;
}
// Initialize the Directory Server crypto manager.
try
{
directoryServer.initializeCryptoManager();
}
catch (ConfigException ce)
{
Message message = ERR_CANNOT_INITIALIZE_CRYPTO_MANAGER.get(
ce.getMessage());
err.println(wrapText(message, MAX_LINE_WIDTH));
return 1;
}
catch (InitializationException ie)
{
Message message = ERR_CANNOT_INITIALIZE_CRYPTO_MANAGER.get(
ie.getMessage());
err.println(wrapText(message, MAX_LINE_WIDTH));
return 1;
}
catch (Exception e)
{
Message message = ERR_CANNOT_INITIALIZE_CRYPTO_MANAGER.get(
getExceptionMessage(e));
err.println(wrapText(message, MAX_LINE_WIDTH));
return 1;
}
try
{
ErrorLogPublisher<?> errorLogPublisher =
TextErrorLogPublisher.getToolStartupTextErrorPublisher(
new TextWriter.STREAM(out));
DebugLogPublisher<?> debugLogPublisher =
TextDebugLogPublisher.getStartupTextDebugPublisher(
new TextWriter.STREAM(out));
ErrorLogger.addErrorLogPublisher(errorLogPublisher);
DebugLogger.addDebugLogPublisher(debugLogPublisher);
}
catch(Exception e)
{
err.println("Error installing the custom error logger: " +
stackTraceToSingleLineString(e));
}
}
// Open the backup directory and make sure it is valid.
BackupDirectory backupDir;
try
{
backupDir = BackupDirectory.readBackupDirectoryDescriptor(
backupDirectory.getValue());
}
catch (Exception e)
{
Message message = ERR_RESTOREDB_CANNOT_READ_BACKUP_DIRECTORY.get(
backupDirectory.getValue(), getExceptionMessage(e));
logError(message);
return 1;
}
// If we're just going to be listing backups, then do that now.
DateFormat dateFormat = new SimpleDateFormat(DATE_FORMAT_LOCAL_TIME);
if (listBackups.isPresent())
{
for (BackupInfo backupInfo : backupDir.getBackups().values())
{
Message message = INFO_RESTOREDB_LIST_BACKUP_ID.get(
backupInfo.getBackupID());
out.println(message);
message = INFO_RESTOREDB_LIST_BACKUP_DATE.get(
dateFormat.format(backupInfo.getBackupDate()));
out.println(message);
message = INFO_RESTOREDB_LIST_INCREMENTAL.get(
String.valueOf(backupInfo.isIncremental()));
out.println(message);
message = INFO_RESTOREDB_LIST_COMPRESSED.get(
String.valueOf(backupInfo.isCompressed()));
out.println(message);
message = INFO_RESTOREDB_LIST_ENCRYPTED.get(
String.valueOf(backupInfo.isEncrypted()));
out.println(message);
byte[] hash = backupInfo.getUnsignedHash();
message = INFO_RESTOREDB_LIST_HASHED.get(
String.valueOf(hash != null));
out.println(message);
byte[] signature = backupInfo.getSignedHash();
message = INFO_RESTOREDB_LIST_SIGNED.get(
String.valueOf(signature != null));
out.println(message);
StringBuilder dependencyList = new StringBuilder();
HashSet<String> dependencyIDs = backupInfo.getDependencies();
if (! dependencyIDs.isEmpty())
{
Iterator<String> iterator = dependencyIDs.iterator();
dependencyList.append(iterator.next());
while (iterator.hasNext())
{
dependencyList.append(", ");
dependencyList.append(iterator.next());
}
}
else
{
dependencyList.append("none");
}
message = INFO_RESTOREDB_LIST_DEPENDENCIES.get(
dependencyList.toString());
out.println(message);
out.println();
}
return 0;
}
// If a backup ID was specified, then make sure it is valid. If none was
// provided, then choose the latest backup from the archive. Encrypted
// or signed backups cannot be restored to a local (offline) server
// instance.
String backupID;
{
BackupInfo backupInfo = backupDir.getLatestBackup();
if (backupInfo == null)
{
Message message = ERR_RESTOREDB_NO_BACKUPS_IN_DIRECTORY.get(
backupDirectory.getValue());
logError(message);
return 1;
}
backupID = backupInfo.getBackupID();
if (backupIDString.isPresent())
{
backupID = backupIDString.getValue();
backupInfo = backupDir.getBackupInfo(backupID);
if (backupInfo == null)
{
Message message = ERR_RESTOREDB_INVALID_BACKUP_ID.get(
backupID, backupDirectory.getValue());
logError(message);
return 1;
}
}
if (backupInfo.isEncrypted() || null != backupInfo.getSignedHash()) {
Message message = ERR_RESTOREDB_ENCRYPT_OR_SIGN_REQUIRES_ONLINE.get();
logError(message);
return 1;
}
}
// Get the DN of the backend configuration entry from the backup and load
// the associated backend from the configuration.
DN configEntryDN = backupDir.getConfigEntryDN();
// Get information about the backends defined in the server and determine
// which to use for the restore.
ArrayList<Backend> backendList = new ArrayList<Backend>();
ArrayList<BackendCfg> entryList = new ArrayList<BackendCfg>();
ArrayList<List<DN>> dnList = new ArrayList<List<DN>>();
BackendToolUtils.getBackends(backendList, entryList, dnList);
Backend backend = null;
int numBackends = backendList.size();
for (int i=0; i < numBackends; i++)
{
Backend b = backendList.get(i);
BackendCfg e = entryList.get(i);
if (e.dn().equals(configEntryDN))
{
backend = b;
break;
}
}
if (backend == null)
{
Message message = ERR_RESTOREDB_NO_BACKENDS_FOR_DN.get(
backupDirectory.getValue(), configEntryDN.toString());
logError(message);
return 1;
}
else if (! backend.supportsRestore())
{
Message message =
ERR_RESTOREDB_CANNOT_RESTORE.get(backend.getBackendID());
logError(message);
return 1;
}
// Create the restore config object from the information available.
RestoreConfig restoreConfig = new RestoreConfig(backupDir, backupID,
verifyOnly.isPresent());
// Acquire an exclusive lock for the backend.
try
{
String lockFile = LockFileManager.getBackendLockFileName(backend);
StringBuilder failureReason = new StringBuilder();
if (! LockFileManager.acquireExclusiveLock(lockFile, failureReason))
{
Message message = ERR_RESTOREDB_CANNOT_LOCK_BACKEND.get(
backend.getBackendID(), String.valueOf(failureReason));
logError(message);
return 1;
}
}
catch (Exception e)
{
Message message = ERR_RESTOREDB_CANNOT_LOCK_BACKEND.get(
backend.getBackendID(), getExceptionMessage(e));
logError(message);
return 1;
}
// Perform the restore.
try
{
backend.restoreBackup(restoreConfig);
}
catch (DirectoryException de)
{
Message message = ERR_RESTOREDB_ERROR_DURING_BACKUP.get(
backupID, backupDir.getPath(), de.getMessageObject());
logError(message);
}
catch (Exception e)
{
Message message = ERR_RESTOREDB_ERROR_DURING_BACKUP.get(
backupID, backupDir.getPath(), getExceptionMessage(e));
logError(message);
}
// Release the exclusive lock on the backend.
try
{
String lockFile = LockFileManager.getBackendLockFileName(backend);
StringBuilder failureReason = new StringBuilder();
if (! LockFileManager.releaseLock(lockFile, failureReason))
{
Message message = WARN_RESTOREDB_CANNOT_UNLOCK_BACKEND.get(
backend.getBackendID(), String.valueOf(failureReason));
logError(message);
}
}
catch (Exception e)
{
Message message = WARN_RESTOREDB_CANNOT_UNLOCK_BACKEND.get(
backend.getBackendID(), getExceptionMessage(e));
logError(message);
}
return 0;
}
/**
* {@inheritDoc}
*/
public String getTaskId() {
if (backupIDString != null) {
return backupIDString.getValue();
} else {
return null;
}
}
}