public interface TaskBackendCfg extends LocalBackendCfg
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.
Modifier and Type | Method and Description |
---|---|
void |
addTaskChangeListener(ConfigurationChangeListener<TaskBackendCfg> listener)
Register to be notified when this Task Backend is changed.
|
Class<? extends TaskBackendCfg> |
configurationClass()
Gets the configuration class associated with this Task Backend.
|
String |
getJavaClass()
Gets the "java-class" property.
|
String |
getNotificationSenderAddress()
Gets the "notification-sender-address" property.
|
String |
getTaskBackingFile()
Gets the "task-backing-file" property.
|
long |
getTaskRetentionTime()
Gets the "task-retention-time" property.
|
LocalBackendCfgDefn.WritabilityMode |
getWritabilityMode()
Gets the "writability-mode" property.
|
void |
removeTaskChangeListener(ConfigurationChangeListener<TaskBackendCfg> listener)
Deregister an existing Task Backend configuration change listener.
|
addLocalChangeListener, removeLocalChangeListener
addChangeListener, getBackendId, isEnabled, removeChangeListener
dn, name
Class<? extends TaskBackendCfg> configurationClass()
configurationClass
in interface BackendCfg
configurationClass
in interface Configuration
configurationClass
in interface LocalBackendCfg
void addTaskChangeListener(ConfigurationChangeListener<TaskBackendCfg> listener)
listener
- The Task Backend configuration change listener.void removeTaskChangeListener(ConfigurationChangeListener<TaskBackendCfg> listener)
listener
- The Task Backend configuration change listener.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
getJavaClass
in interface BackendCfg
String getNotificationSenderAddress()
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.
String getTaskBackingFile()
Specifies the path to the backing file for storing information about the tasks configured in the server.
It may be either an absolute path or a relative path to the base of the OpenDJ directory server instance.
long getTaskRetentionTime()
Specifies the length of time that task entries should be retained after processing on the associated task has been completed.
LocalBackendCfgDefn.WritabilityMode getWritabilityMode()
Specifies the behavior that the backend should use when processing write operations.
getWritabilityMode
in interface LocalBackendCfg
Copyright 2010-2018 ForgeRock AS.