@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class RefreshEncryptionSettingsTask extends Task
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 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.
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.
|
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.
|
createTaskEntry, decodeTask, getActualStartTime, getAdditionalAttributes, getAvailableTaskTypes, getCommonTaskProperties, getCompletionTime, getDependencyIDs, getFailedDependencyAction, getLogMessages, getNotifyOnCompletionAddresses, getNotifyOnErrorAddresses, getScheduledStartTime, getState, getTaskClassName, getTaskEntry, getTaskEntryDN, getTaskID, getTaskPropertyValues, getTaskSpecificProperties, isCompleted, isPending, isRunning, parseBoolean, parseBooleanValue, parseDate, parseLong, parseString, parseStringList, parseStrings, toString, toString
public RefreshEncryptionSettingsTask()
public RefreshEncryptionSettingsTask(java.lang.String taskID)
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.public 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)
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.public RefreshEncryptionSettingsTask(Entry entry) throws TaskException
entry
- The entry to use to create this refresh encryption settings
task.TaskException
- If the provided entry cannot be parsed as a refresh
encryption settings task entry.public RefreshEncryptionSettingsTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties) throws TaskException
properties
- The set of task properties and their corresponding
values to use for the task. It must not be
null
.TaskException
- If the provided set of properties cannot be used to
create a valid refresh encryption settings task.public java.lang.String getTaskName()
getTaskName
in class Task
public java.lang.String getTaskDescription()
getTaskDescription
in class Task
protected java.util.List<java.lang.String> getAdditionalObjectClasses()
getAdditionalObjectClasses
in class Task