Task Backend
The Task Backend provides a mechanism for scheduling tasks in the OpenDJ directory server. Tasks are intended to provide access to certain types of administrative functions in the server that may not be convenient to perform remotely.
OpenDJ supports tasks to backup and restore backends, to import and export LDIF files, and to stop and restart the server. The details of a task are in an entry that is below the root of the Task Backend. The Task Backend is responsible for decoding that task entry and ensuring that it is processed as requested. Tasks may be invoked immediately, but they may also be scheduled for execution at some future time. The task backend can also process recurring tasks to ensure that maintenance operations (for example, backups) are performed automatically on a regular basis.
Parent
The Task Backend object inherits from Local Backend.
Task Backend Properties
You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.
| Basic Properties | Advanced Properties |
|---|---|
backend-id |
backend-id
Synopsis |
Specifies a name to identify the associated backend. |
Description |
The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server. |
Default Value |
None |
Allowed Values |
A string. |
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
Yes |
enabled
Synopsis |
Indicates whether the backend is enabled in the server. |
Description |
If a backend is not enabled, then its contents are not accessible when processing operations. |
Default Value |
None |
Allowed Values |
true false |
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
notification-sender-address
Synopsis |
Specifies the email address to use as the sender (that is, the "From:" address) address for notification mail messages generated when a task completes execution. |
Default Value |
The default sender address used is "opendj-task-notification@" followed by the canonical address of the system on which the server is running. |
Allowed Values |
A string. |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
task-backing-file
Synopsis |
Specifies the path to the backing file for storing information about the tasks configured in the server. |
Description |
It may be either an absolute path or a relative path to the base of the OpenDJ directory server instance. |
Default Value |
None |
Allowed Values |
A string. |
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
task-retention-time
Synopsis |
Specifies the length of time that task entries should be retained after processing on the associated task has been completed. |
Default Value |
24 hours |
Allowed Values |
Uses duration syntax. Lower limit: 0 seconds. |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
writability-mode
Synopsis |
Specifies the behavior that the backend should use when processing write operations. |
Default Value |
enabled |
Allowed Values |
|
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
Advanced Properties
Use the --advanced
option to access advanced properties.
java-class
Synopsis |
Specifies the fully-qualified name of the Java class that provides the backend implementation. |
Default Value |
org.opends.server.backends.task.TaskBackend |
Allowed Values |
A Java class that extends or implements:
|
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
Yes |
Read-Only |
No |