|
|||||||||
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.ThirdPartyTask
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ThirdPartyTask
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 invoke third-party code created using the UnboundID Server SDK. The properties that are available for use with this type of task include:
Constructor Summary | |
---|---|
ThirdPartyTask()
Creates a new uninitialized third-party task instance which should only be used for obtaining general information about this task, including the task name, description, and supported properties. |
|
ThirdPartyTask(Entry entry)
Creates a new third-party task from the provided entry. |
|
ThirdPartyTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
Creates a new third-party task from the provided set of task properties. |
|
ThirdPartyTask(java.lang.String taskID,
java.lang.String taskClassName,
java.util.List<java.lang.String> taskArguments)
Creates a new third-party task with the provided information. |
|
ThirdPartyTask(java.lang.String taskID,
java.lang.String taskClassName,
java.util.List<java.lang.String> taskArguments,
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 third-party 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.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. |
java.util.List<java.lang.String> |
getThirdPartyTaskArguments()
Retrieves a list of the arguments to provide to the third-party task. |
java.lang.String |
getThirdPartyTaskClassName()
Retrieves the fully-qualified name of the Java class providing the logic for the third-party task. |
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 ThirdPartyTask()
public ThirdPartyTask(java.lang.String taskID, java.lang.String taskClassName, java.util.List<java.lang.String> taskArguments)
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.taskClassName
- The fully-qualified name of the Java class providing
the logic for the task. It must not be
null
.taskArguments
- A list of the arguments for the task, in the form
name=value. It may be null
or empty if
there should not be any arguments.public ThirdPartyTask(java.lang.String taskID, java.lang.String taskClassName, java.util.List<java.lang.String> taskArguments, 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.taskClassName
- The fully-qualified name of the Java class
providing the logic for the task. It must
not be null
.taskArguments
- A list of the arguments for the task, in
the form name=value. It may be
null
or empty if there should not
be any arguments.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 ThirdPartyTask(Entry entry) throws TaskException
entry
- The entry to use to create this third-party task.
TaskException
- If the provided entry cannot be parsed as a
third-party task entry.public ThirdPartyTask(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 third-party 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 getThirdPartyTaskClassName()
public java.util.List<java.lang.String> getThirdPartyTaskArguments()
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 |