Class RefreshCertificateMonitorTask

  • All Implemented Interfaces:
    java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class RefreshCertificateMonitorTask
    extends Task
    This class defines a Directory Server task that can be used to request that the server refresh the certificate monitor data immediately. It does not have any custom configuration properties.
    NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
    See Also:
    Serialized Form
    • Constructor Detail

      • RefreshCertificateMonitorTask

        public RefreshCertificateMonitorTask()
        Creates a new refresh certificate monitor task with a randomly generated task ID and default values for all other settings.
      • RefreshCertificateMonitorTask

        public RefreshCertificateMonitorTask​(@Nullable
                                             java.lang.String taskID)
        Creates a new refresh certificate monitor task with the provided task ID and default values for all other settings.
        Parameters:
        taskID - The task ID to use for this task. If it is null then a UUID will be generated for use as the task ID.
      • RefreshCertificateMonitorTask

        public RefreshCertificateMonitorTask​(@Nullable
                                             java.lang.String taskID,
                                             @Nullable
                                             java.util.Date scheduledStartTime,
                                             @Nullable
                                             java.util.List<java.lang.String> dependencyIDs,
                                             @Nullable
                                             FailedDependencyAction failedDependencyAction,
                                             @Nullable
                                             java.util.List<java.lang.String> notifyOnStart,
                                             @Nullable
                                             java.util.List<java.lang.String> notifyOnCompletion,
                                             @Nullable
                                             java.util.List<java.lang.String> notifyOnSuccess,
                                             @Nullable
                                             java.util.List<java.lang.String> notifyOnError,
                                             @Nullable
                                             java.lang.Boolean alertOnStart,
                                             @Nullable
                                             java.lang.Boolean alertOnSuccess,
                                             @Nullable
                                             java.lang.Boolean alertOnError)
        Creates a new refresh certificate monitor task with the provided information.
        Parameters:
        taskID - The task ID to use for this task. If it is null then a UUID will be generated for use as the task ID.
        scheduledStartTime - The time that this task should start running.
        dependencyIDs - The list of task IDs that will be required to complete before this task will be eligible to start.
        failedDependencyAction - Indicates what action should be taken if any of the dependencies for this task do not complete successfully.
        notifyOnStart - The list of e-mail addresses of individuals that should be notified when this task starts running.
        notifyOnCompletion - The list of e-mail addresses of individuals that should be notified when this task completes.
        notifyOnSuccess - The list of e-mail addresses of individuals that should be notified if this task completes successfully.
        notifyOnError - The list of e-mail addresses of individuals that should be notified if this task does not complete successfully.
        alertOnStart - Indicates whether the server should send an alert notification when this task starts.
        alertOnSuccess - Indicates whether the server should send an alert notification if this task completes successfully.
        alertOnError - Indicates whether the server should send an alert notification if this task fails to complete successfully.
      • RefreshCertificateMonitorTask

        public RefreshCertificateMonitorTask​(@NotNull
                                             Entry entry)
                                      throws TaskException
        Creates a new refresh certificate monitor task from the provided entry.
        Parameters:
        entry - The entry to use to create this refresh certificate monitor task.
        Throws:
        TaskException - If the provided entry cannot be parsed as a refresh certificate monitor task entry.
      • RefreshCertificateMonitorTask

        public RefreshCertificateMonitorTask​(@NotNull
                                             java.util.Map<TaskProperty,​java.util.List<java.lang.Object>> properties)
                                      throws TaskException
        Creates a new refresh certificate monitor task from the provided set of task properties.
        Parameters:
        properties - The set of task properties and their corresponding values to use for the task. It must not be null.
        Throws:
        TaskException - If the provided set of properties cannot be used to create a valid refresh certificate monitor task.
    • Method Detail

      • getTaskName

        @NotNull
        public java.lang.String getTaskName()
        Retrieves a human-readable name for this task.
        Overrides:
        getTaskName in class Task
        Returns:
        A human-readable name for this task.
      • getAdditionalObjectClasses

        @NotNull
        protected java.util.List<java.lang.String> getAdditionalObjectClasses()
        Retrieves a list of the additional object classes (other than the base "top" and "ds-task" classes) that should be included when creating new task entries of this type.
        Overrides:
        getAdditionalObjectClasses in class Task
        Returns:
        A list of the additional object classes that should be included in new task entries of this type, or an empty list if there do not need to be any additional classes.