Interface TaskBackendCfg

  • All Superinterfaces:
    BackendCfg, Configuration, LocalBackendCfg

    public interface TaskBackendCfg
    extends LocalBackendCfg
    A server-side interface for querying 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 Detail

      • addTaskChangeListener

        void addTaskChangeListener​(ConfigurationChangeListener<TaskBackendCfg> listener)
        Register to be notified when this Task Backend is changed.
        Parameters:
        listener - The Task Backend configuration change listener.
      • removeTaskChangeListener

        void removeTaskChangeListener​(ConfigurationChangeListener<TaskBackendCfg> listener)
        Deregister an existing Task Backend configuration change listener.
        Parameters:
        listener - The Task Backend configuration change listener.
      • getJavaClass

        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 BackendCfg
        Returns:
        Returns the value of the "java-class" property.
      • getNotificationSenderAddress

        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.
      • getTaskBackingFile

        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.
      • getTaskRetentionTime

        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.
      • getWritabilityMode

        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 LocalBackendCfg
        Returns:
        Returns the value of the "writability-mode" property.