|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TaskBackendCfgClient
A client-side interface for reading and modifying Task Backend settings.
The Task Backend provides a mechanism for scheduling tasks in the OpenDS 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.
Method Summary | |
---|---|
ManagedObjectDefinition<? extends TaskBackendCfgClient,? extends TaskBackendCfg> |
definition()
Get the configuration definition associated with this Task Backend. |
java.lang.String |
getJavaClass()
Gets the "java-class" property. |
java.lang.String |
getNotificationSenderAddress()
Gets the "notification-sender-address" property. |
java.lang.String |
getTaskBackingFile()
Gets the "task-backing-file" property. |
long |
getTaskRetentionTime()
Gets the "task-retention-time" property. |
BackendCfgDefn.WritabilityMode |
getWritabilityMode()
Gets the "writability-mode" property. |
void |
setJavaClass(java.lang.String value)
Sets the "java-class" property. |
void |
setNotificationSenderAddress(java.lang.String value)
Sets the "notification-sender-address" property. |
void |
setTaskBackingFile(java.lang.String value)
Sets the "task-backing-file" property. |
void |
setTaskRetentionTime(java.lang.Long value)
Sets the "task-retention-time" property. |
void |
setWritabilityMode(BackendCfgDefn.WritabilityMode value)
Sets the "writability-mode" property. |
Methods inherited from interface org.opends.server.admin.std.client.BackendCfgClient |
---|
getBackendId, getBaseDN, isEnabled, setBackendId, setBaseDN, setEnabled |
Methods inherited from interface org.opends.server.admin.ConfigurationClient |
---|
commit, properties |
Method Detail |
---|
ManagedObjectDefinition<? extends TaskBackendCfgClient,? extends TaskBackendCfg> definition()
definition
in interface BackendCfgClient
definition
in interface ConfigurationClient
java.lang.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
getJavaClass
in interface BackendCfgClient
void setJavaClass(java.lang.String value) throws IllegalPropertyValueException
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.
IllegalPropertyValueException
- If the new value is invalid.java.lang.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(java.lang.String value) throws IllegalPropertyValueException
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.
IllegalPropertyValueException
- If the new value is invalid.java.lang.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 OpenDS Directory Server instance.
void setTaskBackingFile(java.lang.String value) throws IllegalPropertyValueException
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 OpenDS Directory Server instance.
value
- The value of the "task-backing-file" property.
IllegalPropertyValueException
- If the new value is invalid.long getTaskRetentionTime()
Specifies the length of time that task entries should be retained after processing on the associated task has been completed.
void setTaskRetentionTime(java.lang.Long value) throws IllegalPropertyValueException
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.
IllegalPropertyValueException
- If the new value is invalid.BackendCfgDefn.WritabilityMode getWritabilityMode()
Specifies the behavior that the backend should use when processing write operations.
getWritabilityMode
in interface BackendCfgClient
void setWritabilityMode(BackendCfgDefn.WritabilityMode value) throws IllegalPropertyValueException
Specifies the behavior that the backend should use when processing write operations.
setWritabilityMode
in interface BackendCfgClient
value
- The value of the "writability-mode" property.
IllegalPropertyValueException
- If the new value is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |