Package org.forgerock.opendj.server.config.client

Interface TaskBackendCfgClient

All Superinterfaces:
BackendCfgClient, ConfigurationClient, LocalBackendCfgClient
public interface TaskBackendCfgClient extends LocalBackendCfgClient
A client-side interface for reading and modifying Task Backend settings.

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.

  • Method Details

    • definition

      ManagedObjectDefinition<? extends TaskBackendCfgClient,? extends TaskBackendCfg> definition()
      Get the configuration definition associated with this Task Backend.
      Specified by:
      definition in interface BackendCfgClient
      Specified by:
      definition in interface ConfigurationClient
      Specified by:
      definition in interface LocalBackendCfgClient
      Returns:
      Returns the configuration definition associated with this Task Backend.

    • getJavaClass

      @MandatoryProperty ValueOrExpression<String> getJavaClass()
      Gets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the backend implementation.

      Default value: org.opends.server.backends.task.TaskBackend

      Specified by:
      getJavaClass in interface BackendCfgClient
      Returns:
      Returns the value of the "java-class" property.

    • setJavaClass

      @MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
      Sets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the backend implementation.

      Specified by:
      setJavaClass in interface BackendCfgClient
      Parameters:
      value - The value of the "java-class" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getNotificationSenderAddress

      ValueOrExpression<String> getNotificationSenderAddress()
      Gets the "notification-sender-address" property.

      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.

      Returns:
      Returns the value of the "notification-sender-address" property.

    • setNotificationSenderAddress

      void setNotificationSenderAddress(ValueOrExpression<String> value) throws PropertyException
      Sets the "notification-sender-address" property.

      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.

      Parameters:
      value - The value of the "notification-sender-address" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getTaskBackingFile

      @MandatoryProperty ValueOrExpression<String> getTaskBackingFile()
      Gets the "task-backing-file" property.

      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.

      Returns:
      Returns the value of the "task-backing-file" property.

    • setTaskBackingFile

      @MandatoryProperty void setTaskBackingFile(ValueOrExpression<String> value) throws PropertyException
      Sets the "task-backing-file" property.

      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.

      Parameters:
      value - The value of the "task-backing-file" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getTaskRetentionTime

      ValueOrExpression<Long> getTaskRetentionTime()
      Gets the "task-retention-time" property.

      Specifies the length of time that task entries should be retained after processing on the associated task has been completed.

      Default value: 24 hours

      Returns:
      Returns the value of the "task-retention-time" property.

    • setTaskRetentionTime

      void setTaskRetentionTime(ValueOrExpression<Long> value) throws PropertyException
      Sets the "task-retention-time" property.

      Specifies the length of time that task entries should be retained after processing on the associated task has been completed.

      Parameters:
      value - The value of the "task-retention-time" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getWritabilityMode

      @MandatoryProperty ValueOrExpression<LocalBackendCfgDefn.WritabilityMode> getWritabilityMode()
      Gets the "writability-mode" property.

      Specifies the behavior that the backend should use when processing write operations.

      Default value: enabled

      Specified by:
      getWritabilityMode in interface LocalBackendCfgClient
      Returns:
      Returns the value of the "writability-mode" property.

    • setWritabilityMode

      @MandatoryProperty void setWritabilityMode(ValueOrExpression<LocalBackendCfgDefn.WritabilityMode> value) throws PropertyException
      Sets the "writability-mode" property.

      Specifies the behavior that the backend should use when processing write operations.

      Specified by:
      setWritabilityMode in interface LocalBackendCfgClient
      Parameters:
      value - The value of the "writability-mode" property.
      Throws:
      PropertyException - If the new value is invalid.