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

Class EnterLockdownModeTask

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.tasks.Task
com.unboundid.ldap.sdk.unboundidds.tasks.EnterLockdownModeTask
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class EnterLockdownModeTask extends Task
This class defines a Directory Server task that can be used to cause the server to enter lockdown mode, in which case it will only allow requests from users with the lockdown-mode privilege. Lockdown mode is intended to allow administrators to perform operations with the server online but without worrying about the impact that those operations may have on other users. In In some special cases, the server may place itself in lockdown mode as a defense mechanism rather than risking the exposure of sensitive information. For example, if the server detects any malformed access control rules at startup, then it will place itself in lockdown mode rather than attempt to run without that rule in effect since it could have been intended to prevent unauthorized users from accessing certain data.
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 enter lockdown mode task does not have any task-specific properties. See the LeaveLockdownModeTask class for the corresponding mechanism to bring the server out of lockdown mode.
See Also:

  • Constructor Details

    • EnterLockdownModeTask

      public EnterLockdownModeTask()
      Creates a new uninitialized enter lockdown mode 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.

    • EnterLockdownModeTask

      public EnterLockdownModeTask(@Nullable String taskID)
      Creates a new enter lockdown mode task with the specified task ID.
      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.

    • EnterLockdownModeTask

      public EnterLockdownModeTask(@Nullable String taskID, @Nullable String reason)
      Creates a new enter lockdown mode task with the specified task ID.
      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.
      reason - The user-specified reason for entering lockdown mode. This may be null.

    • EnterLockdownModeTask

      public EnterLockdownModeTask(@Nullable String taskID, @Nullable Date scheduledStartTime, @Nullable List<String> dependencyIDs, @Nullable FailedDependencyAction failedDependencyAction, @Nullable List<String> notifyOnCompletion, @Nullable List<String> notifyOnError)
      Creates a new enter lockdown mode 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.
      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.

    • EnterLockdownModeTask

      public EnterLockdownModeTask(@Nullable String taskID, @Nullable String reason, @Nullable Date scheduledStartTime, @Nullable List<String> dependencyIDs, @Nullable FailedDependencyAction failedDependencyAction, @Nullable List<String> notifyOnCompletion, @Nullable List<String> notifyOnError)
      Creates a new enter lockdown mode 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.
      reason - The user-specified reason for entering lockdown mode. This may be null.
      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.

    • EnterLockdownModeTask

      public EnterLockdownModeTask(@Nullable String taskID, @Nullable String reason, @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 enter lockdown mode 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.
      reason - The user-specified reason for entering lockdown mode. This may be null.
      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.

    • EnterLockdownModeTask

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

    • EnterLockdownModeTask

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

  • Method Details

    • getReason

      @Nullable public String getReason()
      Retrieves the user-specified reason why the server is entering lockdown mode.
      Returns:
      The reason the server is entering lockdown mode, or null if none was specified.

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

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