com.unboundid.ldap.sdk.unboundidds.tasks

Class ThirdPartyTask

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.tasks.Task

com.unboundid.ldap.sdk.unboundidds.tasks.ThirdPartyTask

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ThirdPartyTask
extends Task

This class defines a Directory Server task that can be used to invoke third-party code created using the UnboundID Server SDK.

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 fully-qualified name of the Java class providing the logic for the third-party task. This must be provided.
• A list of the arguments to use for the task.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
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.
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> notifyOnStart, java.util.List<java.lang.String> notifyOnCompletion, java.util.List<java.lang.String> notifyOnSuccess, java.util.List<java.lang.String> notifyOnError, java.lang.Boolean alertOnStart, java.lang.Boolean alertOnSuccess, java.lang.Boolean alertOnError) Creates a new third-party task with the provided information.

Method Summary

Modifier and Type	Method and Description
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, getAlertOnError, getAlertOnStart, getAlertOnSuccess, getAvailableTaskTypes, getCommonTaskProperties, getCompletionTime, getDependencyIDs, getFailedDependencyAction, getLogMessages, getNotifyOnCompletionAddresses, getNotifyOnErrorAddresses, getNotifyOnStartAddresses, getNotifyOnSuccessAddresses, 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

ThirdPartyTask

public 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. Attempts to use a task created with this constructor for any other reason will likely fail.

ThirdPartyTask

public ThirdPartyTask(@Nullable
                      java.lang.String taskID,
                      @NotNull
                      java.lang.String taskClassName,
                      @Nullable
                      java.util.List<java.lang.String> taskArguments)

Creates a new third-party 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.

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.

ThirdPartyTask

public ThirdPartyTask(@Nullable
                      java.lang.String taskID,
                      @NotNull
                      java.lang.String taskClassName,
                      @Nullable
                      java.util.List<java.lang.String> taskArguments,
                      @Nullable
                      java.util.Date scheduledStartTime,
                      @Nullable
                      java.util.List<java.lang.String> dependencyIDs,
                      @Nullable
                      FailedDependencyAction failedDependencyAction,
                      @Nullable
                      java.util.List<java.lang.String> notifyOnCompletion,
                      @Nullable
                      java.util.List<java.lang.String> notifyOnError)

Creates a new third-party 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.

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.

ThirdPartyTask

public ThirdPartyTask(@Nullable
                      java.lang.String taskID,
                      @NotNull
                      java.lang.String taskClassName,
                      @Nullable
                      java.util.List<java.lang.String> taskArguments,
                      @Nullable
                      java.util.Date scheduledStartTime,
                      @Nullable
                      java.util.List<java.lang.String> dependencyIDs,
                      @Nullable
                      FailedDependencyAction failedDependencyAction,
                      @Nullable
                      java.util.List<java.lang.String> notifyOnStart,
                      @Nullable
                      java.util.List<java.lang.String> notifyOnCompletion,
                      @Nullable
                      java.util.List<java.lang.String> notifyOnSuccess,
                      @Nullable
                      java.util.List<java.lang.String> notifyOnError,
                      @Nullable
                      java.lang.Boolean alertOnStart,
                      @Nullable
                      java.lang.Boolean alertOnSuccess,
                      @Nullable
                      java.lang.Boolean alertOnError)

Creates a new third-party 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.

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.

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.

ThirdPartyTask

public ThirdPartyTask(@NotNull
                      Entry entry)
               throws TaskException

Creates a new third-party task from the provided entry.

Parameters:

entry - The entry to use to create this third-party task.

Throws:

TaskException - If the provided entry cannot be parsed as a third-party task entry.

ThirdPartyTask

public ThirdPartyTask(@NotNull
                      java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
               throws TaskException

Creates a new third-party 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 third-party task.

Method Detail

getTaskName

@NotNull
public java.lang.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 java.lang.String getTaskDescription()

Retrieves a human-readable description for this task.

Overrides:

getTaskDescription in class Task

Returns:

A human-readable description for this task.

getThirdPartyTaskClassName

@NotNull
public java.lang.String getThirdPartyTaskClassName()

Retrieves the fully-qualified name of the Java class providing the logic for the third-party task.

Returns:

The fully-qualified name of the Java class providing the logic for the third-party task.

getThirdPartyTaskArguments

@NotNull
public java.util.List<java.lang.String> getThirdPartyTaskArguments()

Retrieves a list of the arguments to provide to the third-party task.

Returns:

A list of the arguments to provide to the third-party task, or an empty list if there are no arguments.

getAdditionalObjectClasses

@NotNull
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.

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

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 java.util.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 java.util.Map<TaskProperty,java.util.List<java.lang.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.