com.unboundid.ldap.sdk.unboundidds.tasks

Class RefreshEncryptionSettingsTask

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.tasks.Task

com.unboundid.ldap.sdk.unboundidds.tasks.RefreshEncryptionSettingsTask

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class RefreshEncryptionSettingsTask
extends Task

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RefreshEncryptionSettingsTask() 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.
RefreshEncryptionSettingsTask(Entry entry) Creates a new refresh encryption settings task from the provided entry.
RefreshEncryptionSettingsTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties) Creates a new refresh encryption settings task from the provided set of task properties.
RefreshEncryptionSettingsTask(java.lang.String taskID) Creates a new refresh encryption settings task with the provided information.
RefreshEncryptionSettingsTask(java.lang.String taskID, java.util.Date scheduledStartTime, java.util.List<java.lang.String> dependencyIDs, FailedDependencyAction failedDependencyAction, java.util.List<java.lang.String> notifyOnCompletion, java.util.List<java.lang.String> notifyOnError) Creates a new refresh encryption settings task with the provided information.
RefreshEncryptionSettingsTask(java.lang.String taskID, java.util.Date scheduledStartTime, java.util.List<java.lang.String> dependencyIDs, FailedDependencyAction failedDependencyAction, java.util.List<java.lang.String> notifyOnStart, java.util.List<java.lang.String> notifyOnCompletion, java.util.List<java.lang.String> notifyOnSuccess, java.util.List<java.lang.String> notifyOnError, java.lang.Boolean alertOnStart, java.lang.Boolean alertOnSuccess, java.lang.Boolean alertOnError) Creates a new refresh encryption settings task with the provided information.

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	getAdditionalObjectClasses() Retrieves a list of the additional object classes (other than the base "top" and "ds-task" classes) that should be included when creating new task entries of this type.
java.lang.String	getTaskDescription() Retrieves a human-readable description for this task.
java.lang.String	getTaskName() Retrieves a human-readable name for this task.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.tasks.Task

createTaskEntry, decodeTask, getActualStartTime, getAdditionalAttributes, getAlertOnError, getAlertOnStart, getAlertOnSuccess, getAvailableTaskTypes, getCommonTaskProperties, getCompletionTime, getDependencyIDs, getFailedDependencyAction, getLogMessages, getNotifyOnCompletionAddresses, getNotifyOnErrorAddresses, getNotifyOnStartAddresses, getNotifyOnSuccessAddresses, getScheduledStartTime, getState, getTaskClassName, getTaskEntry, getTaskEntryDN, getTaskID, getTaskPropertyValues, getTaskSpecificProperties, isCompleted, isPending, isRunning, parseBoolean, parseBooleanValue, parseDate, parseLong, parseString, parseStringList, parseStrings, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RefreshEncryptionSettingsTask

public RefreshEncryptionSettingsTask()

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.

RefreshEncryptionSettingsTask

public RefreshEncryptionSettingsTask(@Nullable
                                     java.lang.String taskID)

Creates a new refresh encryption settings task with the provided information.

Parameters:

taskID - The task ID to use for this task. If it is null then a UUID will be generated for use as the task ID.

RefreshEncryptionSettingsTask

public RefreshEncryptionSettingsTask(@Nullable
                                     java.lang.String taskID,
                                     @Nullable
                                     java.util.Date scheduledStartTime,
                                     @Nullable
                                     java.util.List<java.lang.String> dependencyIDs,
                                     @Nullable
                                     FailedDependencyAction failedDependencyAction,
                                     @Nullable
                                     java.util.List<java.lang.String> notifyOnCompletion,
                                     @Nullable
                                     java.util.List<java.lang.String> notifyOnError)

Creates a new refresh encryption settings task with the provided information.

Parameters:

taskID - The task ID to use for this task. If it is null then a UUID will be generated for use as the task ID.

scheduledStartTime - The time that this task should start running.

dependencyIDs - The list of task IDs that will be required to complete before this task will be eligible to start.

failedDependencyAction - Indicates what action should be taken if any of the dependencies for this task do not complete successfully.

notifyOnCompletion - The list of e-mail addresses of individuals that should be notified when this task completes.

notifyOnError - The list of e-mail addresses of individuals that should be notified if this task does not complete successfully.

RefreshEncryptionSettingsTask

public RefreshEncryptionSettingsTask(@Nullable
                                     java.lang.String taskID,
                                     @Nullable
                                     java.util.Date scheduledStartTime,
                                     @Nullable
                                     java.util.List<java.lang.String> dependencyIDs,
                                     @Nullable
                                     FailedDependencyAction failedDependencyAction,
                                     @Nullable
                                     java.util.List<java.lang.String> notifyOnStart,
                                     @Nullable
                                     java.util.List<java.lang.String> notifyOnCompletion,
                                     @Nullable
                                     java.util.List<java.lang.String> notifyOnSuccess,
                                     @Nullable
                                     java.util.List<java.lang.String> notifyOnError,
                                     @Nullable
                                     java.lang.Boolean alertOnStart,
                                     @Nullable
                                     java.lang.Boolean alertOnSuccess,
                                     @Nullable
                                     java.lang.Boolean alertOnError)

Creates a new refresh encryption settings task with the provided information.

Parameters:

taskID - The task ID to use for this task. If it is null then a UUID will be generated for use as the task ID.

scheduledStartTime - The time that this task should start running.

dependencyIDs - The list of task IDs that will be required to complete before this task will be eligible to start.

failedDependencyAction - Indicates what action should be taken if any of the dependencies for this task do not complete successfully.

notifyOnStart - The list of e-mail addresses of individuals that should be notified when this task starts running.

notifyOnCompletion - The list of e-mail addresses of individuals that should be notified when this task completes.

notifyOnSuccess - The list of e-mail addresses of individuals that should be notified if this task completes successfully.

notifyOnError - The list of e-mail addresses of individuals that should be notified if this task does not complete successfully.

alertOnStart - Indicates whether the server should send an alert notification when this task starts.

alertOnSuccess - Indicates whether the server should send an alert notification if this task completes successfully.

alertOnError - Indicates whether the server should send an alert notification if this task fails to complete successfully.

RefreshEncryptionSettingsTask

public RefreshEncryptionSettingsTask(@NotNull
                                     Entry entry)
                              throws TaskException

Creates a new refresh encryption settings task from the provided entry.

Parameters:

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.

RefreshEncryptionSettingsTask

public RefreshEncryptionSettingsTask(@NotNull
                                     java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
                              throws TaskException

Creates a new refresh encryption settings task from the provided set of task properties.

Parameters:

properties - The set of task properties and their corresponding values to use for the task. It must not be null.

Throws:

TaskException - If the provided set of properties cannot be used to create a valid refresh encryption settings task.

Method Detail

getTaskName

@NotNull
public java.lang.String getTaskName()

Retrieves a human-readable name for this task.

Overrides:

getTaskName in class Task

Returns:

A human-readable name for this task.

getTaskDescription

@NotNull
public java.lang.String getTaskDescription()

Retrieves a human-readable description for this task.

Overrides:

getTaskDescription in class Task

Returns:

A human-readable description for this task.

getAdditionalObjectClasses

@NotNull
protected java.util.List<java.lang.String> getAdditionalObjectClasses()

Retrieves a list of the additional object classes (other than the base "top" and "ds-task" classes) that should be included when creating new task entries of this type.

Overrides:

getAdditionalObjectClasses in class Task

Returns:

A list of the additional object classes that should be included in new task entries of this type, or an empty list if there do not need to be any additional classes.