com.unboundid.ldap.sdk.unboundidds.tasks.RefreshEncryptionSettingsTask Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation
Show all versions of unboundid-ldapsdk Show documentation
The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use
Java API for communicating with LDAP directory servers and performing
related tasks like reading and writing LDIF, encoding and decoding data
using base64 and ASN.1 BER, and performing secure communication. This
package contains the Standard Edition of the LDAP SDK, which is a
complete, general-purpose library for communicating with LDAPv3 directory
servers.
/*
* Copyright 2008-2018 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright (C) 2015-2018 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.Collections;
import java.util.Date;
import java.util.List;
import java.util.Map;
import com.unboundid.ldap.sdk.Entry;
import com.unboundid.util.NotMutable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import static com.unboundid.ldap.sdk.unboundidds.tasks.TaskMessages.*;
/**
* This class defines a Directory Server task that can be used to request that
* the server refresh the encryption settings database from disk. It does not
* have any custom configuration properties.
*
*
* 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.
*
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class RefreshEncryptionSettingsTask
extends Task
{
/**
* The fully-qualified name of the Java class that is used for the refresh
* encryption settings task in the Directory Server.
*/
static final String REFRESH_ENCRYPTION_SETTINGS_TASK_CLASS =
"com.unboundid.directory.server.tasks.RefreshEncryptionSettingsTask";
/**
* The name of the object class used in refresh encryption settings task
* entries.
*/
private static final String OC_REFRESH_ENCRYPTION_SETTINGS_TASK =
"ds-task-refresh-encryption-settings";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -2469450547006114721L;
/**
* Creates a new uninitialized refresh encryption settings task instance which
* should only be used for obtaining general information about this task,
* including the task name, description, and supported properties.
*/
public RefreshEncryptionSettingsTask()
{
this(null, null, null, null, null, null);
}
/**
* Creates a new refresh encryption settings 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.
*/
public RefreshEncryptionSettingsTask(final String taskID)
{
this(taskID, null, null, null, null, null);
}
/**
* Creates a new refresh encryption settings 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 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 RefreshEncryptionSettingsTask(final String taskID,
final Date scheduledStartTime, final List dependencyIDs,
final FailedDependencyAction failedDependencyAction,
final List notifyOnCompletion,
final List notifyOnError)
{
this(taskID, scheduledStartTime, dependencyIDs, failedDependencyAction,
null, notifyOnCompletion, null, notifyOnError, null, null, null);
}
/**
* Creates a new refresh encryption settings 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 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 RefreshEncryptionSettingsTask(final String taskID,
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, REFRESH_ENCRYPTION_SETTINGS_TASK_CLASS, scheduledStartTime,
dependencyIDs, failedDependencyAction, notifyOnStart,
notifyOnCompletion, notifyOnSuccess, notifyOnError, alertOnStart,
alertOnSuccess, alertOnError);
}
/**
* Creates a new refresh encryption settings task from the provided entry.
*
* @param entry The entry to use to create this refresh encryption settings
* task.
*
* @throws TaskException If the provided entry cannot be parsed as a refresh
* encryption settings task entry.
*/
public RefreshEncryptionSettingsTask(final Entry entry)
throws TaskException
{
super(entry);
}
/**
* Creates a new refresh encryption settings 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 refresh encryption settings task.
*/
public RefreshEncryptionSettingsTask(
final Map> properties)
throws TaskException
{
super(REFRESH_ENCRYPTION_SETTINGS_TASK_CLASS, properties);
}
/**
* {@inheritDoc}
*/
@Override()
public String getTaskName()
{
return INFO_TASK_NAME_REFRESH_ENCRYPTION_SETTINGS.get();
}
/**
* {@inheritDoc}
*/
@Override()
public String getTaskDescription()
{
return INFO_TASK_DESCRIPTION_REFRESH_ENCRYPTION_SETTINGS.get();
}
/**
* {@inheritDoc}
*/
@Override()
protected List getAdditionalObjectClasses()
{
return Collections.singletonList(OC_REFRESH_ENCRYPTION_SETTINGS_TASK);
}
}