|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.tasks.Task
com.unboundid.ldap.sdk.unboundidds.tasks.SearchTask
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SearchTask
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.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. The properties that are available for use with this type of task include:
Constructor Summary | |
---|---|
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. |
|
SearchTask(Entry entry)
Creates a new search task from the provided entry. |
|
SearchTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
Creates a new search task from the provided set of task properties. |
|
SearchTask(java.lang.String taskID,
java.lang.String baseDN,
SearchScope scope,
Filter filter,
java.util.List<java.lang.String> attributes,
java.lang.String outputFile)
Creates a new search task with the provided information. |
|
SearchTask(java.lang.String taskID,
java.lang.String baseDN,
SearchScope scope,
Filter filter,
java.util.List<java.lang.String> attributes,
java.lang.String outputFile,
java.lang.String authzDN)
Creates a new search task with the provided information. |
|
SearchTask(java.lang.String taskID,
java.lang.String baseDN,
SearchScope scope,
Filter filter,
java.util.List<java.lang.String> attributes,
java.lang.String outputFile,
java.lang.String authzDN,
java.util.Date scheduledStartTime,
java.util.List<java.lang.String> dependencyIDs,
FailedDependencyAction failedDependencyAction,
java.util.List<java.lang.String> notifyOnCompletion,
java.util.List<java.lang.String> notifyOnError)
Creates a new search task with the provided information. |
Method Summary | |
---|---|
protected java.util.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. |
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. |
java.util.List<java.lang.String> |
getAttributes()
Retrieves the list of attributes to include in matching entries. |
java.lang.String |
getAuthzDN()
Retrieves the DN of the user as whom the request should be processed. |
java.lang.String |
getBaseDN()
Retrieves the base DN for the search. |
Filter |
getFilter()
Retrieves the filter for the search. |
java.lang.String |
getOutputFile()
Retrieves the path to the file on the server filesystem to which the results should be written. |
SearchScope |
getScope()
Retrieves the scope for the search. |
java.lang.String |
getTaskDescription()
Retrieves a human-readable description for this task. |
java.lang.String |
getTaskName()
Retrieves a human-readable name for this task. |
java.util.Map<TaskProperty,java.util.List<java.lang.Object>> |
getTaskPropertyValues()
Retrieves the values of the task properties for this task. |
java.util.List<TaskProperty> |
getTaskSpecificProperties()
Retrieves a list of task-specific properties that may be provided when scheduling a task of this type. |
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.tasks.Task |
---|
createTaskEntry, decodeTask, getActualStartTime, getAvailableTaskTypes, getCommonTaskProperties, getCompletionTime, getDependencyIDs, getFailedDependencyAction, getLogMessages, getNotifyOnCompletionAddresses, getNotifyOnErrorAddresses, getScheduledStartTime, getState, getTaskClassName, getTaskEntry, getTaskEntryDN, getTaskID, isCompleted, isPending, isRunning, parseBoolean, parseBooleanValue, parseDate, parseLong, parseString, parseStringList, parseStrings, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SearchTask()
public SearchTask(java.lang.String taskID, java.lang.String baseDN, SearchScope scope, Filter filter, java.util.List<java.lang.String> attributes, java.lang.String outputFile)
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
.public SearchTask(java.lang.String taskID, java.lang.String baseDN, SearchScope scope, Filter filter, java.util.List<java.lang.String> attributes, java.lang.String outputFile, java.lang.String authzDN)
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.public SearchTask(java.lang.String taskID, java.lang.String baseDN, SearchScope scope, Filter filter, java.util.List<java.lang.String> attributes, java.lang.String outputFile, java.lang.String authzDN, java.util.Date scheduledStartTime, java.util.List<java.lang.String> dependencyIDs, FailedDependencyAction failedDependencyAction, java.util.List<java.lang.String> notifyOnCompletion, java.util.List<java.lang.String> notifyOnError)
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.public SearchTask(Entry entry) throws TaskException
entry
- The entry to use to create this search task.
TaskException
- If the provided entry cannot be parsed as a search
task entry.public SearchTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties) throws TaskException
properties
- The set of task properties and their corresponding
values to use for the task. It must not be
null
.
TaskException
- If the provided set of properties cannot be used to
create a valid add schema file task.Method Detail |
---|
public java.lang.String getTaskName()
getTaskName
in class Task
public java.lang.String getTaskDescription()
getTaskDescription
in class Task
public java.lang.String getBaseDN()
public SearchScope getScope()
public Filter getFilter()
public java.util.List<java.lang.String> getAttributes()
public java.lang.String getAuthzDN()
null
if it should be processed as an internal root user.public java.lang.String getOutputFile()
protected java.util.List<java.lang.String> getAdditionalObjectClasses()
getAdditionalObjectClasses
in class Task
protected java.util.List<Attribute> getAdditionalAttributes()
getAdditionalAttributes
in class Task
public java.util.List<TaskProperty> getTaskSpecificProperties()
getTaskSpecificProperties
in class Task
public java.util.Map<TaskProperty,java.util.List<java.lang.Object>> getTaskPropertyValues()
Boolean
,
Date
, Long
, or String
. Task properties which do
not have any values will be included in the map with an empty value list.
super.getTaskPropertyValues()
and the
values of their own task-specific properties.
getTaskPropertyValues
in class Task
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |