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

Class DisconnectClientTask

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.tasks.Task
com.unboundid.ldap.sdk.unboundidds.tasks.DisconnectClientTask
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class DisconnectClientTask extends Task
This class defines a Directory Server task that can be used to request that the server terminate a client connection.
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 connection ID for the client connection to be terminated. This is required.
  • A flag that indicates whether the client connection should be notified (e.g., using a notice of disconnection unsolicited notification) before the connection is actually terminated.
  • An optional message that may provide a reason for the disconnect. If this is provided, it will appear in the server log, and it may be provided to the client if the client is to be notified before the connection is closed.
See Also:

  • Constructor Details

    • DisconnectClientTask

      public DisconnectClientTask()
      Creates a new uninitialized disconnect client 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.

    • DisconnectClientTask

      public DisconnectClientTask(@Nullable String taskID, long connectionID, @Nullable String disconnectMessage, boolean notifyClient)
      Creates a new disconnect client 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.
      connectionID - The connection ID of the client connection to terminate.
      disconnectMessage - A message to provide to the server to indicate the reason for the disconnect. It will be included in the server log, and will be provided to the client if a notice of disconnection is to be sent. It may be null if no message is to be provided.
      notifyClient - Indicates whether to send a notice of disconnection message to the client before terminating the connection.

    • DisconnectClientTask

      public DisconnectClientTask(@Nullable String taskID, long connectionID, @Nullable String disconnectMessage, boolean notifyClient, @Nullable Date scheduledStartTime, @Nullable List<String> dependencyIDs, @Nullable FailedDependencyAction failedDependencyAction, @Nullable List<String> notifyOnCompletion, @Nullable List<String> notifyOnError)
      Creates a new add disconnect client 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.
      connectionID - The connection ID of the client connection to terminate.
      disconnectMessage - A message to provide to the server to indicate the reason for the disconnect. It will be included in the server log, and will be provided to the client if a notice of disconnection is to be sent. It may be null if no message is to be provided.
      notifyClient - Indicates whether to send a notice of disconnection message to the client before terminating the connection.
      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.

    • DisconnectClientTask

      public DisconnectClientTask(@Nullable String taskID, long connectionID, @Nullable String disconnectMessage, boolean notifyClient, @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 add disconnect client 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.
      connectionID - The connection ID of the client connection to terminate.
      disconnectMessage - A message to provide to the server to indicate the reason for the disconnect. It will be included in the server log, and will be provided to the client if a notice of disconnection is to be sent. It may be null if no message is to be provided.
      notifyClient - Indicates whether to send a notice of disconnection message to the client before terminating the connection.
      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.

    • DisconnectClientTask

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

    • DisconnectClientTask

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

    • getConnectionID

      public long getConnectionID()
      Retrieves the connection ID of the client connection to disconnect.
      Returns:
      The connection ID of the client connection to disconnect.

    • getDisconnectMessage

      @Nullable public String getDisconnectMessage()
      Retrieves the disconnect message to provide to the server, and potentially to the client.
      Returns:
      The disconnect message, or null if no message is to be provided.

    • notifyClient

      public boolean notifyClient()
      Indicates whether to send a notice of disconnection message to the client before terminating the connection.
      Returns:
      true if the server should send a notice of disconnection to the client, or false if it should terminate the connection without warning.

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