Package com.unboundid.ldap.sdk.unboundidds.tasks
This package contains a number of helper classes for invoking and interacting
with scheduled tasks in Ping Identity, UnboundID, and Nokia/Alcatel-Lucent
8661 server products. Tasks may be used to perform various kinds of
administrative functions, like backing up and restoring backends, importing
and exporting data, rebuilding indexes, and shutting down or restarting the
server.
The
NOTE: The classes within this package, and elsewhere 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.
The
TaskManager
class provides a number of utility methods for
interacting with tasks in a Ping Identity, UnboundID, or Nokia/Alcatel-Lucent
8661 Directory Server. The Task
class and its subclasses provide a
framework for accessing the generic and task-specific information associated
with tasks.-
Class Summary Class Description AddSchemaFileTask This class defines a Directory Server task that can be used to add the contents of one or more files to the server schema.AlertTask This class defines a Directory Server task that can be used to cause the server to generate administrative alerts, or to manage the set of degraded or unavailable alert types.AuditDataSecurityTask This class defines a Directory Server task that can be used to cause the server to initiate a data security audit, which can look for potential issues in the environment that can impact the security of the directory environment.BackupTask This class defines a Directory Server task that can be used to back up one or more Directory Server backends.CollectSupportDataTask This class defines a Directory Server task that can be used to invoke the collect-support-data tool to capture a variety of information that may help monitor the state of the server or diagnose potential problems.CollectSupportDataTaskProperties This class defines a set of properties that may be used when creating aCollectSupportDataTask
.DelayTask This class defines a Directory Server task that simply sleeps for a specified length of time or until a given condition occurs.DisconnectClientTask This class defines a Directory Server task that can be used to request that the server terminate a client connection.DumpDBDetailsTask This class defines a Directory Server task that can be used to dump information about the contents of a backend which stores its data in a Berkeley DB Java Edition database.EnterLockdownModeTask This class defines a Directory Server task that can be used to cause the server to enter lockdown mode, in which case it will only allow requests from users with the lockdown-mode privilege.ExecTask This class defines a Directory Server task that can be used to cause the server to execute a specified command with a given set of arguments.ExportTask This class defines a Directory Server task that can be used to export the contents of a backend to LDIF.FileRetentionTask This class defines a Directory Server task that can be used to identify files in a specified directory that match a given pattern, and delete any of those files that are outside of a provided set of retention criteria.GenerateServerProfileTask This class defines a Directory Server task that can be used to cause it to generate a server profile in a specified location on the server filesystem.GroovyScriptedTask This class defines a Directory Server task that can be used to invoke a task written as a Groovy script using the UnboundID Server SDK.ImportTask This class defines a Directory Server task that can be used to import LDIF content into a backend.LeaveLockdownModeTask This class defines a Directory Server task that can be used to cause the server to leave lockdown mode and resume normal operation.PopulateComposedAttributeValuesTask This class defines a Directory Server task that can be used to populate the values of a composed attribute in existing entries without the need to export the data to LDIF and re-import it.RebuildTask This class defines a Directory Server task that can be used to generate and/or rebuild one or more indexes a Berkeley DB Java Edition backend.ReEncodeEntriesTask This class defines a Directory Server task that can be used to cause entries contained in a local DB backend to be re-encoded, which may be used to apply any configuration changes that affect the encoding of that entry (e.g., if the entry should be encrypted, hashed, compressed, or fully or partially uncached; or if these settings should be reverted).RefreshCertificateMonitorTask This class defines a Directory Server task that can be used to request that the server refresh the certificate monitor data immediately.RefreshEncryptionSettingsTask This class defines a Directory Server task that can be used to request that the server refresh the encryption settings database from disk.ReloadGlobalIndexTask This class defines a Directory Proxy Server task that can be used to reload the contents of the global index.ReloadHTTPConnectionHandlerCertificatesTask This class defines a Directory Server task that can be used to request that the server should dynamically reload all key and trust manager providers associated with all HTTP connection handlers configured with support for HTTPS.RemoveAttributeTypeTask This class defines a Directory Server task that can be used to safely remove an attribute type from the server schema.RemoveAttributeTypeTaskProperties This class defines a set of properties that may be used when creating aRemoveAttributeTypeTask
.RemoveObjectClassTask This class defines a Directory Server task that can be used to safely remove an object class from the server schema.RemoveObjectClassTaskProperties This class defines a set of properties that may be used when creating aRemoveObjectClassTask
.RestoreTask This class defines a Directory Server task that can be used to restore a backup.RotateLogTask This class defines a Directory Server task that can be used to trigger the rotation of one or more log files.SearchTask This class defines a Directory Server task that can be used to perform an internal search within the server and write the contents to an LDIF file.ShutdownTask This class defines a Directory Server task that can be used to shut down or restart the server.SynchronizeEncryptionSettingsTask This class defines a Directory Server task that can be used to synchronize the encryption settings definitions in one instance with one or more other servers in the topology.Task This class defines a data structure for holding information about scheduled tasks as used by the Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 Directory Server.TaskManager This class provides a number of utility methods for interacting with tasks in Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 server instances.TaskProperty This class provides information about a property that may be used to schedule a task.ThirdPartyTask This class defines a Directory Server task that can be used to invoke third-party code created using the UnboundID Server SDK. -
Enum Summary Enum Description CollectSupportDataSecurityLevel This enum defines the security level values that may be used in conjunction with the collect-support-data tool (and the corresponding administrative task and extended operation).FailedDependencyAction This class defines a failed dependency action, which controls how a task should behave if any of its dependencies fails.FileRetentionTaskTimestampFormat This enum defines the set of allowed timestamp formats for use in conjunction with the file retention task.TaskState This class defines a task state, which provides information about the current state of processing for a scheduled task. -
Exception Summary Exception Description TaskException This class defines an exception that may be thrown while interacting with scheduled tasks.