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

Class SearchTask

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.tasks.Task
com.unboundid.ldap.sdk.unboundidds.tasks.SearchTask
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SearchTask extends Task
This class defines a Directory Server task that can be used to perform an internal search within the server and write the contents to an LDIF file.
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 base DN to use for the search. This is required.
  • The scope to use for the search. This is required.
  • The filter to use for the search. This is required.
  • The attributes to return. This is optional and multivalued.
  • The authorization DN to use for the search. This is optional.
  • The path to the output file to use. This is required.
See Also:

  • Constructor Details

    • SearchTask

      public SearchTask()
      Creates a new uninitialized search 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.

    • SearchTask

      public SearchTask(@Nullable String taskID, @NotNull String baseDN, @NotNull SearchScope scope, @NotNull Filter filter, @Nullable List<String> attributes, @NotNull String outputFile)
      Creates a new search 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.
      baseDN - The base DN to use for the search. It must not be null.
      scope - The scope to use for the search. It must not be null.
      filter - The filter to use for the search. It must not be null.
      attributes - The list of attributes to include in matching entries. If it is null or empty, then all user attributes will be selected.
      outputFile - The path to the file (on the server filesystem) to which the results should be written. It must not be null.

    • SearchTask

      public SearchTask(@Nullable String taskID, @NotNull String baseDN, @NotNull SearchScope scope, @NotNull Filter filter, @Nullable List<String> attributes, @NotNull String outputFile, @Nullable String authzDN)
      Creates a new search 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.
      baseDN - The base DN to use for the search. It must not be null.
      scope - The scope to use for the search. It must not be null.
      filter - The filter to use for the search. It must not be null.
      attributes - The list of attributes to include in matching entries. If it is null or empty, then all user attributes will be selected.
      outputFile - The path to the file (on the server filesystem) to which the results should be written. It must not be null.
      authzDN - The DN of the user as whom the search should be processed. If this is null, then it will be processed as an internal root user.

    • SearchTask

      public SearchTask(@Nullable String taskID, @NotNull String baseDN, @NotNull SearchScope scope, @NotNull Filter filter, @Nullable List<String> attributes, @NotNull String outputFile, @Nullable String authzDN, @Nullable Date scheduledStartTime, @Nullable List<String> dependencyIDs, @Nullable FailedDependencyAction failedDependencyAction, @Nullable List<String> notifyOnCompletion, @Nullable List<String> notifyOnError)
      Creates a new search 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.
      baseDN - The base DN to use for the search. It must not be null.
      scope - The scope to use for the search. It must not be null.
      filter - The filter to use for the search. It must not be null.
      attributes - The list of attributes to include in matching entries. If it is null or empty, then all user attributes will be selected.
      outputFile - The path to the file (on the server filesystem) to which the results should be written. It must not be null.
      authzDN - The DN of the user as whom the search should be processed. If this is null, then it will be processed as an internal root user.
      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.

    • SearchTask

      public SearchTask(@Nullable String taskID, @NotNull String baseDN, @NotNull SearchScope scope, @NotNull Filter filter, @Nullable List<String> attributes, @NotNull String outputFile, @Nullable String authzDN, @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 search 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.
      baseDN - The base DN to use for the search. It must not be null.
      scope - The scope to use for the search. It must not be null.
      filter - The filter to use for the search. It must not be null.
      attributes - The list of attributes to include in matching entries. If it is null or empty, then all user attributes will be selected.
      outputFile - The path to the file (on the server filesystem) to which the results should be written. It must not be null.
      authzDN - The DN of the user as whom the search should be processed. If this is null, then it will be processed as an internal root user.
      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.

    • SearchTask

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

    • SearchTask

      public SearchTask(@NotNull Map<TaskProperty,List<Object>> properties) throws TaskException
      Creates a new search 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 add schema file 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.

    • getBaseDN

      @NotNull public String getBaseDN()
      Retrieves the base DN for the search.
      Returns:
      The base DN for the search.

    • getScope

      @NotNull public SearchScope getScope()
      Retrieves the scope for the search.
      Returns:
      The scope for the search.

    • getFilter

      @NotNull public Filter getFilter()
      Retrieves the filter for the search.
      Returns:
      The filter for the search.

    • getAttributes

      @NotNull public List<String> getAttributes()
      Retrieves the list of attributes to include in matching entries.
      Returns:
      The list of attributes to include in matching entries, or an empty list of all user attributes should be requested.

    • getAuthzDN

      @Nullable public String getAuthzDN()
      Retrieves the DN of the user as whom the request should be processed.
      Returns:
      The DN of the user as whom the request should be processed, or null if it should be processed as an internal root user.

    • getOutputFile

      @NotNull public String getOutputFile()
      Retrieves the path to the file on the server filesystem to which the results should be written.
      Returns:
      The path to the file on the server filesystem to which the results should be written.

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