public interface TaskBackendCfgClient extends LocalBackendCfgClient
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 |
---|---|
ManagedObjectDefinition<? extends TaskBackendCfgClient,? extends TaskBackendCfg> |
definition()
Get the configuration definition associated with this Task Backend.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
ValueOrExpression<String> |
getNotificationSenderAddress()
Gets the "notification-sender-address" property.
|
ValueOrExpression<String> |
getTaskBackingFile()
Gets the "task-backing-file" property.
|
ValueOrExpression<Long> |
getTaskRetentionTime()
Gets the "task-retention-time" property.
|
ValueOrExpression<LocalBackendCfgDefn.WritabilityMode> |
getWritabilityMode()
Gets the "writability-mode" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setNotificationSenderAddress(ValueOrExpression<String> value)
Sets the "notification-sender-address" property.
|
void |
setTaskBackingFile(ValueOrExpression<String> value)
Sets the "task-backing-file" property.
|
void |
setTaskRetentionTime(ValueOrExpression<Long> value)
Sets the "task-retention-time" property.
|
void |
setWritabilityMode(ValueOrExpression<LocalBackendCfgDefn.WritabilityMode> value)
Sets the "writability-mode" property.
|
getBackendId, isEnabled, setBackendId, setEnabled
commit, properties
ManagedObjectDefinition<? extends TaskBackendCfgClient,? extends TaskBackendCfg> definition()
definition
in interface BackendCfgClient
definition
in interface ConfigurationClient
definition
in interface LocalBackendCfgClient
ValueOrExpression<String> getJavaClass()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
getJavaClass
in interface BackendCfgClient
void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the backend implementation.
setJavaClass
in interface BackendCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.ValueOrExpression<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.
void setNotificationSenderAddress(ValueOrExpression<String> value) throws PropertyException
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.
value
- The value of the "notification-sender-address" property.PropertyException
- If the new value is invalid.ValueOrExpression<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.
void setTaskBackingFile(ValueOrExpression<String> value) throws PropertyException
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.
value
- The value of the "task-backing-file" property.PropertyException
- If the new value is invalid.ValueOrExpression<Long> getTaskRetentionTime()
Specifies the length of time that task entries should be retained after processing on the associated task has been completed.
void setTaskRetentionTime(ValueOrExpression<Long> value) throws PropertyException
Specifies the length of time that task entries should be retained after processing on the associated task has been completed.
value
- The value of the "task-retention-time" property.PropertyException
- If the new value is invalid.ValueOrExpression<LocalBackendCfgDefn.WritabilityMode> getWritabilityMode()
Specifies the behavior that the backend should use when processing write operations.
getWritabilityMode
in interface LocalBackendCfgClient
void setWritabilityMode(ValueOrExpression<LocalBackendCfgDefn.WritabilityMode> value) throws PropertyException
Specifies the behavior that the backend should use when processing write operations.
setWritabilityMode
in interface LocalBackendCfgClient
value
- The value of the "writability-mode" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.