Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2008-2019 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright (C) 2015-2019 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk.unboundidds.tasks;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Date;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import com.unboundid.ldap.sdk.Attribute;
import com.unboundid.ldap.sdk.Entry;
import com.unboundid.util.NotMutable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.Validator;
import static com.unboundid.ldap.sdk.unboundidds.tasks.TaskMessages.*;
/**
* This class defines a Directory Server task that can be used to restore a
* backup.
*
*
* NOTE: This class, and other classes within the
* {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
* supported for use against Ping Identity, UnboundID, and
* Nokia/Alcatel-Lucent 8661 server products. These classes provide support
* for proprietary functionality or for external specifications that are not
* considered stable or mature enough to be guaranteed to work in an
* interoperable way with other types of LDAP servers.
*
*
* The properties that are available for use with this type of task include:
*
*
The path to the backup directory in which the backup resides. This
* must be provided when scheduling a new task of this type.
*
The backup ID of the backup to be restored. If this is not provided
* when scheduling an instance of this task, then the most recent backup
* in the backup directory will be selected.
*
A flag that indicates whether to attempt to restore the backup or
* only to verify it to determine whether it appears to be valid (e.g.,
* validate the digest and/or signature, make sure that the backend
* considers it valid, etc.).
*
The path to a file containing a passphrase to use to generate the
* encryption key.
*
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class RestoreTask
extends Task
{
/**
* The fully-qualified name of the Java class that is used for the restore
* task.
*/
static final String RESTORE_TASK_CLASS =
"com.unboundid.directory.server.tasks.RestoreTask";
/**
* The name of the attribute used to specify the path to the backup directory
* containing the backup to restore.
*/
private static final String ATTR_BACKUP_DIRECTORY =
"ds-backup-directory-path";
/**
* The name of the attribute used to specify the backup ID of the backup to
* restore.
*/
private static final String ATTR_BACKUP_ID = "ds-backup-id";
/**
* The name of the attribute used to specify the path to a file that contains
* the passphrase to use to generate the encryption key.
*/
private static final String ATTR_ENCRYPTION_PASSPHRASE_FILE =
"ds-task-restore-encryption-passphrase-file";
/**
* The name of the attribute used to indicate whether to only verify the
* backup but not actually restore it.
*/
private static final String ATTR_VERIFY_ONLY =
"ds-task-restore-verify-only";
/**
* The name of the object class used in restore task entries.
*/
private static final String OC_RESTORE_TASK = "ds-task-restore";
/**
* The task property for the backup directory.
*/
private static final TaskProperty PROPERTY_BACKUP_DIRECTORY =
new TaskProperty(ATTR_BACKUP_DIRECTORY,
INFO_DISPLAY_NAME_BACKUP_DIRECTORY.get(),
INFO_DESCRIPTION_BACKUP_DIRECTORY_RESTORE.get(),
String.class, true, false, false);
/**
* The task property for the backup ID.
*/
private static final TaskProperty PROPERTY_BACKUP_ID =
new TaskProperty(ATTR_BACKUP_ID, INFO_DISPLAY_NAME_BACKUP_ID.get(),
INFO_DESCRIPTION_BACKUP_ID_RESTORE.get(), String.class,
false, false, true);
/**
* The task property that will be used for the encryption passphrase file.
*/
private static final TaskProperty PROPERTY_ENCRYPTION_PASSPHRASE_FILE =
new TaskProperty(ATTR_ENCRYPTION_PASSPHRASE_FILE,
INFO_DISPLAY_NAME_ENCRYPTION_PASSPHRASE_FILE.get(),
INFO_DESCRIPTION_ENCRYPTION_PASSPHRASE_FILE.get(),
String.class, false, false, true);
/**
* The task property for the verify only flag.
*/
private static final TaskProperty PROPERTY_VERIFY_ONLY =
new TaskProperty(ATTR_VERIFY_ONLY, INFO_DISPLAY_NAME_VERIFY_ONLY.get(),
INFO_DESCRIPTION_VERIFY_ONLY.get(), Boolean.class,
false, false, false);
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -8441221098187125379L;
// Indicates whether to only verify the backup without restoring it.
private final boolean verifyOnly;
// The path to the backup directory containing the backup to restore.
private final String backupDirectory;
// The path to a file containing the passphrase to use to generate the
// encryption key.
private final String encryptionPassphraseFile;
// The backup ID of the backup to restore.
private final String backupID;
/**
* Creates a new uninitialized restore task instance which should only be used
* for obtaining general information about this task, including the task name,
* description, and supported properties. Attempts to use a task created with
* this constructor for any other reason will likely fail.
*/
public RestoreTask()
{
verifyOnly = false;
backupDirectory = null;
backupID = null;
encryptionPassphraseFile = null;
}
/**
* Creates a new restore task with the provided information.
*
* @param taskID The task ID to use for this task. If it is
* {@code null} then a UUID will be generated for use
* as the task ID.
* @param backupDirectory The path to the directory on the server containing
* the backup to restore. It may be an absolute path
* or relative to the server root directory. It must
* not be {@code null}.
* @param backupID The backup ID of the backup to restore. If this
* is {@code null} then the most recent backup in the
* specified backup directory will be restored.
* @param verifyOnly Indicates whether to only verify the backup
* without restoring it.
*/
public RestoreTask(final String taskID, final String backupDirectory,
final String backupID, final boolean verifyOnly)
{
this(taskID, backupDirectory, backupID, verifyOnly, null, null, null, null,
null);
}
/**
* Creates a new restore task with the provided information.
*
* @param taskID The task ID to use for this task. If it is
* {@code null} then a UUID will be generated
* for use as the task ID.
* @param backupDirectory The path to the directory on the server
* containing the backup to restore. It may
* be an absolute path or relative to the
* server root directory. It must not be
* {@code null}.
* @param backupID The backup ID of the backup to restore. If
* this is {@code null} then the most recent
* backup in the specified backup directory
* will be restored.
* @param verifyOnly Indicates whether to only verify the backup
* without restoring it.
* @param scheduledStartTime The time that this task should start
* running.
* @param dependencyIDs The list of task IDs that will be required
* to complete before this task will be
* eligible to start.
* @param failedDependencyAction Indicates what action should be taken if
* any of the dependencies for this task do
* not complete successfully.
* @param notifyOnCompletion The list of e-mail addresses of individuals
* that should be notified when this task
* completes.
* @param notifyOnError The list of e-mail addresses of individuals
* that should be notified if this task does
* not complete successfully.
*/
public RestoreTask(final String taskID, final String backupDirectory,
final String backupID, final boolean verifyOnly,
final Date scheduledStartTime,
final List dependencyIDs,
final FailedDependencyAction failedDependencyAction,
final List notifyOnCompletion,
final List notifyOnError)
{
this(taskID, backupDirectory, backupID, verifyOnly, null,
scheduledStartTime, dependencyIDs, failedDependencyAction,
notifyOnCompletion, notifyOnError);
}
/**
* Creates a new restore task with the provided information.
*
* @param taskID The task ID to use for this task. If it
* is {@code null} then a UUID will be
* generated for use as the task ID.
* @param backupDirectory The path to the directory on the server
* containing the backup to restore. It may
* be an absolute path or relative to the
* server root directory. It must not be
* {@code null}.
* @param backupID The backup ID of the backup to restore.
* If this is {@code null} then the most
* recent backup in the specified backup
* directory will be restored.
* @param verifyOnly Indicates whether to only verify the
* backup without restoring it.
* @param encryptionPassphraseFile The path to a file containing the
* passphrase to use to generate the
* encryption key. It amy be {@code null}
* if the backup is not to be encrypted, or
* if the key should be obtained in some
* other way.
* @param scheduledStartTime The time that this task should start
* running.
* @param dependencyIDs The list of task IDs that will be
* required to complete before this task
* will be eligible to start.
* @param failedDependencyAction Indicates what action should be taken if
* any of the dependencies for this task do
* not complete successfully.
* @param notifyOnCompletion The list of e-mail addresses of
* individuals that should be notified when
* this task completes.
* @param notifyOnError The list of e-mail addresses of
* individuals that should be notified if
* this task does not complete successfully.
*/
public RestoreTask(final String taskID, final String backupDirectory,
final String backupID, final boolean verifyOnly,
final String encryptionPassphraseFile,
final Date scheduledStartTime,
final List dependencyIDs,
final FailedDependencyAction failedDependencyAction,
final List notifyOnCompletion,
final List notifyOnError)
{
this(taskID, backupDirectory, backupID, verifyOnly,
encryptionPassphraseFile, scheduledStartTime, dependencyIDs,
failedDependencyAction, null, notifyOnCompletion, null,
notifyOnError, null, null, null);
}
/**
* Creates a new restore task with the provided information.
*
* @param taskID The task ID to use for this task. If it
* is {@code null} then a UUID will be
* generated for use as the task ID.
* @param backupDirectory The path to the directory on the server
* containing the backup to restore. It may
* be an absolute path or relative to the
* server root directory. It must not be
* {@code null}.
* @param backupID The backup ID of the backup to restore.
* If this is {@code null} then the most
* recent backup in the specified backup
* directory will be restored.
* @param verifyOnly Indicates whether to only verify the
* backup without restoring it.
* @param encryptionPassphraseFile The path to a file containing the
* passphrase to use to generate the
* encryption key. It amy be {@code null}
* if the backup is not to be encrypted, or
* if the key should be obtained in some
* other way.
* @param scheduledStartTime The time that this task should start
* running.
* @param dependencyIDs The list of task IDs that will be
* required to complete before this task
* will be eligible to start.
* @param failedDependencyAction Indicates what action should be taken if
* any of the dependencies for this task do
* not complete successfully.
* @param notifyOnStart The list of e-mail addresses of individuals
* that should be notified when this task
* starts running.
* @param notifyOnCompletion The list of e-mail addresses of individuals
* that should be notified when this task
* completes.
* @param notifyOnSuccess The list of e-mail addresses of individuals
* that should be notified if this task
* completes successfully.
* @param notifyOnError The list of e-mail addresses of individuals
* that should be notified if this task does
* not complete successfully.
* @param alertOnStart Indicates whether the server should send an
* alert notification when this task starts.
* @param alertOnSuccess Indicates whether the server should send an
* alert notification if this task completes
* successfully.
* @param alertOnError Indicates whether the server should send an
* alert notification if this task fails to
* complete successfully.
*/
public RestoreTask(final String taskID, final String backupDirectory,
final String backupID, final boolean verifyOnly,
final String encryptionPassphraseFile,
final Date scheduledStartTime,
final List dependencyIDs,
final FailedDependencyAction failedDependencyAction,
final List notifyOnStart,
final List notifyOnCompletion,
final List notifyOnSuccess,
final List notifyOnError,
final Boolean alertOnStart, final Boolean alertOnSuccess,
final Boolean alertOnError)
{
super(taskID, RESTORE_TASK_CLASS, scheduledStartTime,
dependencyIDs, failedDependencyAction, notifyOnStart,
notifyOnCompletion, notifyOnSuccess, notifyOnError, alertOnStart,
alertOnSuccess, alertOnError);
Validator.ensureNotNull(backupDirectory);
this.backupDirectory = backupDirectory;
this.backupID = backupID;
this.verifyOnly = verifyOnly;
this.encryptionPassphraseFile = encryptionPassphraseFile;
}
/**
* Creates a new restore task from the provided entry.
*
* @param entry The entry to use to create this restore task.
*
* @throws TaskException If the provided entry cannot be parsed as a restore
* task entry.
*/
public RestoreTask(final Entry entry)
throws TaskException
{
super(entry);
// Get the backup directory. It must be present.
backupDirectory = entry.getAttributeValue(ATTR_BACKUP_DIRECTORY);
if (backupDirectory == null)
{
throw new TaskException(ERR_RESTORE_NO_BACKUP_DIRECTORY.get(
getTaskEntryDN()));
}
// Get the backup ID. It may be absent.
backupID = entry.getAttributeValue(ATTR_BACKUP_ID);
// Get the verifyOnly flag. It may be absent.
verifyOnly = parseBooleanValue(entry, ATTR_VERIFY_ONLY, false);
// Get the path to the encryption passphrase file. It may be absent.
encryptionPassphraseFile =
entry.getAttributeValue(ATTR_ENCRYPTION_PASSPHRASE_FILE);
}
/**
* Creates a new restore task from the provided set of task properties.
*
* @param properties The set of task properties and their corresponding
* values to use for the task. It must not be
* {@code null}.
*
* @throws TaskException If the provided set of properties cannot be used to
* create a valid restore task.
*/
public RestoreTask(final Map> properties)
throws TaskException
{
super(RESTORE_TASK_CLASS, properties);
boolean v = false;
String b = null;
String f = null;
String i = null;
for (final Map.Entry> entry :
properties.entrySet())
{
final TaskProperty p = entry.getKey();
final String attrName = p.getAttributeName();
final List
