Package com.unboundid.ldap.sdk.unboundidds.tasks

Class AlertTask

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.tasks.Task
com.unboundid.ldap.sdk.unboundidds.tasks.AlertTask
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class AlertTask extends Task
This class defines a Directory Server task that can be used to cause the server to generate administrative alerts, or to manage the set of degraded or unavailable alert types.
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.

The properties that are available for use with this type of task include:
  • The alert type of the alert notification to generate. If this is provided, then an alert message must also be provided.
  • The alert message for the alert notification to generate. If this is provided, then an alert type must also be provided.
  • The names of the alert types to add to the set of degraded alert types in the general monitor entry.
  • The names of the alert types to remove from the set of degraded alert types in the general monitor entry.
  • The names of the alert types to add to the set of unavailable alert types in the general monitor entry.
  • The names of the alert types to remove from the set of unavailable alert types in the general monitor entry.
See Also:

  • Constructor Details

    • AlertTask

      public AlertTask()
      Creates a new uninitialized alert task instance which should only be used for obtaining general information about this task, including the task name, description, and supported properties. Attempts to use a task created with this constructor for any other reason will likely fail.

    • AlertTask

      public AlertTask(@NotNull String alertType, @NotNull String alertMessage)
      Creates a new alert task that can be used to generate an administrative alert with the provided information.
      Parameters:
      alertType - The alert type to use for the generated alert. It must not be null.
      alertMessage - The message to use for the generated alert. It must not be null.

    • AlertTask

      public AlertTask(@Nullable String alertType, @Nullable String alertMessage, @Nullable List<String> addDegradedTypes, @Nullable List<String> removeDegradedTypes, @Nullable List<String> addUnavailableTypes, @Nullable List<String> removeUnavailableTypes)
      Creates a new alert task that can be used to generate an administrative alert and/or update the set of degraded or unavailable alert types for the Directory Server. At least one element must be provided.
      Parameters:
      alertType - The alert type to use for the generated alert. It may be null if no alert should be generated, but if it is non-null then the alert message must also be non-null.
      alertMessage - The message to use for the generated alert. It may be null if no alert should be generated, but if it is non-null then the alert type must also be non-null.
      addDegradedTypes - The names of the alert types to add to the Directory Server's set of degraded alert types. It may be null or empty if no degraded alert types should be added.
      removeDegradedTypes - The names of the alert types to remove from the Directory Server's set of degraded alert types. It may be null or empty if no degraded alert types should be removed.
      addUnavailableTypes - The names of the alert types to add to the Directory Server's set of unavailable alert types. It may be null or empty if no unavailable alert types should be added.
      removeUnavailableTypes - The names of the alert types to remove from the Directory Server's set of unavailable alert types. It may be null or empty if no unavailable alert types should be removed.

    • AlertTask

      public AlertTask(@Nullable String taskID, @Nullable String alertType, @Nullable String alertMessage, @Nullable List<String> addDegradedTypes, @Nullable List<String> removeDegradedTypes, @Nullable List<String> addUnavailableTypes, @Nullable List<String> removeUnavailableTypes, @Nullable Date scheduledStartTime, @Nullable List<String> dependencyIDs, @Nullable FailedDependencyAction failedDependencyAction, @Nullable List<String> notifyOnCompletion, @Nullable List<String> notifyOnError)
      Creates a new alert task that can be used to generate an administrative alert and/or update the set of degraded or unavailable alert types for the Directory Server. At least one alert-related element must be provided.
      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.
      alertType - The alert type to use for the generated alert. It may be null if no alert should be generated, but if it is non-null then the alert message must also be non-null.
      alertMessage - The message to use for the generated alert. It may be null if no alert should be generated, but if it is non-null then the alert type must also be non-null.
      addDegradedTypes - The names of the alert types to add to the Directory Server's set of degraded alert types. It may be null or empty if no degraded alert types should be added.
      removeDegradedTypes - The names of the alert types to remove from the Directory Server's set of degraded alert types. It may be null or empty if no degraded alert types should be removed.
      addUnavailableTypes - The names of the alert types to add to the Directory Server's set of unavailable alert types. It may be null or empty if no unavailable alert types should be added.
      removeUnavailableTypes - The names of the alert types to remove from the Directory Server's set of unavailable alert types. It may be null or empty if no unavailable alert types should be removed.
      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.
      notifyOnCompletion - The list of e-mail addresses of individuals that should be notified when this task completes.
      notifyOnError - The list of e-mail addresses of individuals that should be notified if this task does not complete successfully.

    • AlertTask

      public AlertTask(@Nullable String taskID, @Nullable String alertType, @Nullable String alertMessage, @Nullable List<String> addDegradedTypes, @Nullable List<String> removeDegradedTypes, @Nullable List<String> addUnavailableTypes, @Nullable List<String> removeUnavailableTypes, @Nullable Date scheduledStartTime, @Nullable List<String> dependencyIDs, @Nullable FailedDependencyAction failedDependencyAction, @Nullable List<String> notifyOnStart, @Nullable List<String> notifyOnCompletion, @Nullable List<String> notifyOnSuccess, @Nullable List<String> notifyOnError, @Nullable Boolean alertOnStart, @Nullable Boolean alertOnSuccess, @Nullable Boolean alertOnError)
      Creates a new alert task that can be used to generate an administrative alert and/or update the set of degraded or unavailable alert types for the Directory Server. At least one alert-related element must be provided.
      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.
      alertType - The alert type to use for the generated alert. It may be null if no alert should be generated, but if it is non-null then the alert message must also be non-null.
      alertMessage - The message to use for the generated alert. It may be null if no alert should be generated, but if it is non-null then the alert type must also be non-null.
      addDegradedTypes - The names of the alert types to add to the Directory Server's set of degraded alert types. It may be null or empty if no degraded alert types should be added.
      removeDegradedTypes - The names of the alert types to remove from the Directory Server's set of degraded alert types. It may be null or empty if no degraded alert types should be removed.
      addUnavailableTypes - The names of the alert types to add to the Directory Server's set of unavailable alert types. It may be null or empty if no unavailable alert types should be added.
      removeUnavailableTypes - The names of the alert types to remove from the Directory Server's set of unavailable alert types. It may be null or empty if no unavailable alert types should be removed.
      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.

    • AlertTask

      public AlertTask(@NotNull Entry entry) throws TaskException
      Creates a new alert task from the provided entry.
      Parameters:
      entry - The entry to use to create this alert task.
      Throws:
      TaskException - If the provided entry cannot be parsed as an alert task entry.

    • AlertTask

      public AlertTask(@NotNull Map<TaskProperty,List<Object>> properties) throws TaskException
      Creates a new alert 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 alert task.

  • Method Details

    • getTaskName

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

    • getTaskDescription

      @NotNull public String getTaskDescription()
      Retrieves a human-readable description for this task.
      Overrides:
      getTaskDescription in class Task
      Returns:
      A human-readable description for this task.

    • getAlertType

      @Nullable public String getAlertType()
      Retrieves the name of the alert type to use for the alert notification to be generated, if appropriate.
      Returns:
      The name of the alert type to use for the alert notification to be generated, or null if no alert should be generated.

    • getAlertMessage

      @Nullable public String getAlertMessage()
      Retrieves the message to use for the alert notification to be generated, if appropriate.
      Returns:
      The message to use for the alert notification to be generated, or null if no alert should be generated.

    • getAddDegradedAlertTypes

      @NotNull public List<String> getAddDegradedAlertTypes()
      Retrieves the names of the alert types that should be added to the set of degraded alert types.
      Returns:
      The names of the alert types that should be added to the set of degraded alert types, or an empty list if no degraded alert types should be added.

    • getRemoveDegradedAlertTypes

      @NotNull public List<String> getRemoveDegradedAlertTypes()
      Retrieves the names of the alert types that should be removed from the set of degraded alert types.
      Returns:
      The names of the alert types that should be removed from the set of degraded alert types, or an empty list if no degraded alert types should be removed.

    • getAddUnavailableAlertTypes

      @NotNull public List<String> getAddUnavailableAlertTypes()
      Retrieves the names of the alert types that should be added to the set of unavailable alert types.
      Returns:
      The names of the alert types that should be added to the set of unavailable alert types, or an empty list if no unavailable alert types should be added.

    • getRemoveUnavailableAlertTypes

      @NotNull public List<String> getRemoveUnavailableAlertTypes()
      Retrieves the names of the alert types that should be removed from the set of unavailable alert types.
      Returns:
      The names of the alert types that should be removed from the set of unavailable alert types, or an empty list if no unavailable alert types should be removed.

    • getAdditionalObjectClasses

      @NotNull protected List<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.

    • getAdditionalAttributes

      @NotNull protected List<Attribute> getAdditionalAttributes()
      Retrieves a list of the additional attributes (other than attributes common to all task types) that should be included when creating new task entries of this type.
      Overrides:
      getAdditionalAttributes in class Task
      Returns:
      A list of the additional attributes that should be included in new task entries of this type, or an empty list if there do not need to be any additional attributes.

    • getTaskSpecificProperties

      @NotNull public List<TaskProperty> getTaskSpecificProperties()
      Retrieves a list of task-specific properties that may be provided when scheduling a task of this type. This method should be overridden by subclasses in order to provide an appropriate set of properties.
      Overrides:
      getTaskSpecificProperties in class Task
      Returns:
      A list of task-specific properties that may be provided when scheduling a task of this type.

    • getTaskPropertyValues

      @NotNull public Map<TaskProperty,List<Object>> getTaskPropertyValues()
      Retrieves the values of the task properties for this task. The data type of the values will vary based on the data type of the corresponding task property and may be one of the following types: Boolean, Date, Long, or String. Task properties which do not have any values will be included in the map with an empty value list.

      Note that subclasses which have additional task properties should override this method and return a map which contains both the property values from this class (obtained from super.getTaskPropertyValues() and the values of their own task-specific properties.
      Overrides:
      getTaskPropertyValues in class Task
      Returns:
      A map of the task property values for this task.