Class Task
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.tasks.Task
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
AddSchemaFileTask
,AlertTask
,AuditDataSecurityTask
,BackupTask
,CollectSupportDataTask
,DelayTask
,DisconnectClientTask
,DumpDBDetailsTask
,EnterLockdownModeTask
,ExecTask
,ExportTask
,FileRetentionTask
,GenerateServerProfileTask
,GroovyScriptedTask
,ImportTask
,LeaveLockdownModeTask
,PopulateComposedAttributeValuesTask
,RebuildTask
,ReEncodeEntriesTask
,RefreshCertificateMonitorTask
,RefreshEncryptionSettingsTask
,ReloadGlobalIndexTask
,ReloadHTTPConnectionHandlerCertificatesTask
,RemoveAttributeTypeTask
,RemoveObjectClassTask
,RestoreTask
,RotateLogTask
,SearchTask
,ShutdownTask
,SynchronizeEncryptionSettingsTask
,ThirdPartyTask
@NotExtensible @ThreadSafety(level=COMPLETELY_THREADSAFE) public class Task extends java.lang.Object implements java.io.Serializable
This class defines a data structure for holding information about scheduled tasks as used by the Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 Directory Server. Subclasses will be used to provide additional functionality when dealing with certain types of tasks.
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.
All types of tasks can include the following information:- Task ID -- Uniquely identifies the task in the server. It may be omitted when scheduling a new task in order to have a task ID generated for the task.
- Task Class Name -- The fully-qualified name of the
Task
subclass that provides the logic for the task. This does not need to be provided when creating a new task from one of the task-specific subclasses. - Task State -- The current state of the task. See the
TaskState
enum for information about the possible states that a task may have. - Scheduled Start Time -- The earliest time that the task should be eligible to start. It may be omitted when scheduling a new task in order to use the current time.
- Actual Start Time -- The time that server started processing the task.
- Actual Start Time -- The time that server completed processing for the task.
- Dependency IDs -- A list of task IDs for tasks that must complete before this task may be considered eligible to start.
- Failed Dependency Action -- Specifies how the server should treat this
task if any of the tasks on which it depends failed. See the
FailedDependencyAction
enum for the failed dependency action values that may be used. - Notify on Completion -- A list of e-mail addresses for users that should be notified when the task completes, regardless of whether it was successful.
- Notify On Error -- A list of e-mail addresses for users that should be notified if the task fails.
- Log Messages -- A list of the messages logged by the task while it was running.
getTaskID()
method can be used to retrieve the task ID), but task properties (including those specific to the particular type to task) may also be accessed using a generic API. For example, thegetTaskPropertyValues()
method retrieves a map that correlates theTaskProperty
objects for the task with the values that have been set for those properties. See the documentation for theTaskManager
class for an example that demonstrates accessing task information using the generic API.
Also note that it is possible to create new tasks using information obtained from the generic API, but that is done on a per-class basis. For example, in order to create a newBackupTask
instance using the generic API, you would use theBackupTask(Map)
constructor, in which the provided map contains a mapping between the properties and their values for that task. ThegetTaskSpecificProperties()
method may be used to retrieve a list of the task-specific properties that may be provided when scheduling a task, and thegetCommonTaskProperties()
method may be used to retrieve a list of properties that can be provided when scheduling any type of task.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
Task()
Creates a new uninitialized task instance which should only be used for obtaining general information about this task, including the task name, description, and supported properties.Task(Entry entry)
Creates a new task from the provided entry.Task(java.lang.String taskID, java.lang.String taskClassName)
Creates a new unscheduled task with the specified task ID and class name.Task(java.lang.String taskID, java.lang.String taskClassName, 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 unscheduled task with the provided information.Task(java.lang.String taskID, java.lang.String taskClassName, 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 unscheduled task with the provided information.Task(java.lang.String taskClassName, java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
Creates a new task from the provided set of task properties.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Entry
createTaskEntry()
Creates an entry that may be added to the Directory Server to create a new instance of this task.static Task
decodeTask(Entry entry)
Decodes the provided entry as a scheduled task.java.util.Date
getActualStartTime()
Retrieves the time that this task actually started running.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.Boolean
getAlertOnError()
Retrieves the flag that indicates whether the server should generate an administrative alert if this task fails to complete successfully.java.lang.Boolean
getAlertOnStart()
Retrieves the flag that indicates whether the server should generate an administrative alert when this task starts running.java.lang.Boolean
getAlertOnSuccess()
Retrieves the flag that indicates whether the server should generate an administrative alert if this task completes successfully.static java.util.List<Task>
getAvailableTaskTypes()
Retrieves a list containing instances of the available task types.static java.util.List<TaskProperty>
getCommonTaskProperties()
Retrieves a list of task properties that may be provided when scheduling any type of task.java.util.Date
getCompletionTime()
Retrieves the time that this task completed.java.util.List<java.lang.String>
getDependencyIDs()
Retrieves a list of the task IDs for tasks that must complete before this task will be eligible to start.FailedDependencyAction
getFailedDependencyAction()
Retrieves the failed dependency action for this task, which indicates the behavior that it should exhibit if any of its dependencies encounter a failure.java.util.List<java.lang.String>
getLogMessages()
Retrieves the log messages for this task.java.util.List<java.lang.String>
getNotifyOnCompletionAddresses()
Retrieves a list of the e-mail addresses of the individuals that should be notified whenever this task completes processing, regardless of whether it was successful.java.util.List<java.lang.String>
getNotifyOnErrorAddresses()
Retrieves a list of the e-mail addresses of the individuals that should be notified if this task stops processing prematurely due to an error or other external action (e.g., server shutdown or administrative cancel).java.util.List<java.lang.String>
getNotifyOnStartAddresses()
Retrieves a list of the e-mail addresses of the individuals that should be notified whenever this task starts running.java.util.List<java.lang.String>
getNotifyOnSuccessAddresses()
Retrieves a list of the e-mail addresses of the individuals that should be notified if this task completes successfully.java.util.Date
getScheduledStartTime()
Retrieves the time that this task is/was scheduled to start running.TaskState
getState()
Retrieves the current state for this task.java.lang.String
getTaskClassName()
Retrieves the fully-qualified name of the Java class that provides the logic for this class.java.lang.String
getTaskDescription()
Retrieves a human-readable description for this task.protected Entry
getTaskEntry()
Retrieves the entry from which this task was decoded, if available.java.lang.String
getTaskEntryDN()
Retrieves the DN of the entry in which this scheduled task is defined.java.lang.String
getTaskID()
Retrieves the task ID 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.boolean
isCompleted()
Indicates whether this task has completed execution.boolean
isPending()
Indicates whether this task is currently pending execution.boolean
isRunning()
Indicates whether this task is currently running.protected static java.lang.Boolean
parseBoolean(TaskProperty p, java.util.List<java.lang.Object> values, java.lang.Boolean defaultValue)
Parses the provided set of values for the associated task property as aBoolean
.protected static boolean
parseBooleanValue(Entry taskEntry, java.lang.String attributeName, boolean defaultValue)
Parses the value of the specified attribute as aboolean
value, or throws an exception if the value cannot be decoded as a boolean.protected static java.util.Date
parseDate(TaskProperty p, java.util.List<java.lang.Object> values, java.util.Date defaultValue)
Parses the provided set of values for the associated task property as aDate
.protected static java.lang.Long
parseLong(TaskProperty p, java.util.List<java.lang.Object> values, java.lang.Long defaultValue)
Parses the provided set of values for the associated task property as aLong
.protected static java.lang.String
parseString(TaskProperty p, java.util.List<java.lang.Object> values, java.lang.String defaultValue)
Parses the provided set of values for the associated task property as aString
.protected static java.util.List<java.lang.String>
parseStringList(Entry taskEntry, java.lang.String attributeName)
Parses the values of the specified attribute as a list of strings.protected static java.lang.String[]
parseStrings(TaskProperty p, java.util.List<java.lang.Object> values, java.lang.String[] defaultValues)
Parses the provided set of values for the associated task property as aString
array.java.lang.String
toString()
Retrieves a string representation of this task.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this task to the provided buffer.
-
-
-
Constructor Detail
-
Task
protected Task()
Creates a new uninitialized 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.
-
Task
public Task(@Nullable java.lang.String taskID, @NotNull java.lang.String taskClassName)
Creates a new unscheduled task with the specified task ID and class name.- Parameters:
taskID
- The task ID to use for this task. If it isnull
then a UUID will be generated for use as the task ID.taskClassName
- The fully-qualified name of the Java class that provides the logic for the task. It must not benull
.
-
Task
public Task(@Nullable java.lang.String taskID, @NotNull java.lang.String taskClassName, @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 unscheduled task with the provided information.- Parameters:
taskID
- The task ID to use for this task.taskClassName
- The fully-qualified name of the Java class that provides the logic for the task. It must not benull
.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.
-
Task
public Task(@Nullable java.lang.String taskID, @NotNull java.lang.String taskClassName, @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 unscheduled task with the provided information.- Parameters:
taskID
- The task ID to use for this task.taskClassName
- The fully-qualified name of the Java class that provides the logic for the task. It must not benull
.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.
-
Task
public Task(@NotNull Entry entry) throws TaskException
Creates a new task from the provided entry.- Parameters:
entry
- The entry to use to create this task.- Throws:
TaskException
- If the provided entry cannot be parsed as a scheduled task.
-
Task
public Task(@NotNull java.lang.String taskClassName, @NotNull java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties) throws TaskException
Creates a new task from the provided set of task properties.- Parameters:
taskClassName
- The fully-qualified name of the Java class that provides the logic for the task. It must not benull
.properties
- The set of task properties and their corresponding values to use for the task. It must not benull
.- Throws:
TaskException
- If the provided set of properties cannot be used to create a valid scheduled task.
-
-
Method Detail
-
getAvailableTaskTypes
@NotNull public static java.util.List<Task> getAvailableTaskTypes()
Retrieves a list containing instances of the available task types. The provided task instances will may only be used for obtaining general information about the task (e.g., name, description, and supported properties).- Returns:
- A list containing instances of the available task types.
-
getTaskName
@NotNull public java.lang.String getTaskName()
Retrieves a human-readable name for this task.- Returns:
- A human-readable name for this task.
-
getTaskDescription
@NotNull public java.lang.String getTaskDescription()
Retrieves a human-readable description for this task.- Returns:
- A human-readable description for this task.
-
getTaskEntry
@Nullable protected final Entry getTaskEntry()
Retrieves the entry from which this task was decoded, if available. Note that although the entry is not immutable, changes made to it will not be reflected in this task.- Returns:
- The entry from which this task was decoded, or
null
if this task was not created from an existing entry.
-
getTaskEntryDN
@NotNull public final java.lang.String getTaskEntryDN()
Retrieves the DN of the entry in which this scheduled task is defined.- Returns:
- The DN of the entry in which this scheduled task is defined.
-
getTaskID
@NotNull public final java.lang.String getTaskID()
Retrieves the task ID for this task.- Returns:
- The task ID for this task.
-
getTaskClassName
@NotNull public final java.lang.String getTaskClassName()
Retrieves the fully-qualified name of the Java class that provides the logic for this class.- Returns:
- The fully-qualified name of the Java class that provides the logic for this task.
-
getState
@NotNull public final TaskState getState()
Retrieves the current state for this task.- Returns:
- The current state for this task.
-
isPending
public final boolean isPending()
Indicates whether this task is currently pending execution.- Returns:
true
if this task is currently pending execution, orfalse
if not.
-
isRunning
public final boolean isRunning()
Indicates whether this task is currently running.- Returns:
true
if this task is currently running, orfalse
if not.
-
isCompleted
public final boolean isCompleted()
Indicates whether this task has completed execution.- Returns:
true
if this task has completed execution, orfalse
if not.
-
getScheduledStartTime
@Nullable public final java.util.Date getScheduledStartTime()
Retrieves the time that this task is/was scheduled to start running.- Returns:
- The time that this task is/was scheduled to start running, or
null
if that is not available and therefore the task should start running as soon as all dependencies have been met.
-
getActualStartTime
@Nullable public final java.util.Date getActualStartTime()
Retrieves the time that this task actually started running.- Returns:
- The time that this task actually started running, or
null
if that is not available (e.g., because the task has not yet started).
-
getCompletionTime
@Nullable public final java.util.Date getCompletionTime()
Retrieves the time that this task completed.- Returns:
- The time that this task completed, or
null
if it has not yet completed.
-
getDependencyIDs
@NotNull public final java.util.List<java.lang.String> getDependencyIDs()
Retrieves a list of the task IDs for tasks that must complete before this task will be eligible to start.- Returns:
- A list of the task IDs for tasks that must complete before this task will be eligible to start, or an empty list if this task does not have any dependencies.
-
getFailedDependencyAction
@Nullable public final FailedDependencyAction getFailedDependencyAction()
Retrieves the failed dependency action for this task, which indicates the behavior that it should exhibit if any of its dependencies encounter a failure.- Returns:
- The failed dependency action for this task, or
null
if it is not available.
-
getLogMessages
@NotNull public final java.util.List<java.lang.String> getLogMessages()
Retrieves the log messages for this task. Note that if the task has generated a very large number of log messages, then only a portion of the most recent messages may be available.- Returns:
- The log messages for this task, or an empty list if this task does not have any log messages.
-
getNotifyOnStartAddresses
@NotNull public final java.util.List<java.lang.String> getNotifyOnStartAddresses()
Retrieves a list of the e-mail addresses of the individuals that should be notified whenever this task starts running.- Returns:
- A list of the e-mail addresses of the individuals that should be notified whenever this task starts running, or an empty list if there are none.
-
getNotifyOnCompletionAddresses
@NotNull public final java.util.List<java.lang.String> getNotifyOnCompletionAddresses()
Retrieves a list of the e-mail addresses of the individuals that should be notified whenever this task completes processing, regardless of whether it was successful.- Returns:
- A list of the e-mail addresses of the individuals that should be notified whenever this task completes processing, or an empty list if there are none.
-
getNotifyOnSuccessAddresses
@NotNull public final java.util.List<java.lang.String> getNotifyOnSuccessAddresses()
Retrieves a list of the e-mail addresses of the individuals that should be notified if this task completes successfully.- Returns:
- A list of the e-mail addresses of the individuals that should be notified if this task completes successfully, or an empty list if there are none.
-
getNotifyOnErrorAddresses
@NotNull public final java.util.List<java.lang.String> getNotifyOnErrorAddresses()
Retrieves a list of the e-mail addresses of the individuals that should be notified if this task stops processing prematurely due to an error or other external action (e.g., server shutdown or administrative cancel).- Returns:
- A list of the e-mail addresses of the individuals that should be notified if this task stops processing prematurely, or an empty list if there are none.
-
getAlertOnStart
@Nullable public final java.lang.Boolean getAlertOnStart()
Retrieves the flag that indicates whether the server should generate an administrative alert when this task starts running.- Returns:
true
if the server should send an alert when this task starts running,false
if the server should not send an alert, ornull
if it is not available.
-
getAlertOnSuccess
@Nullable public final java.lang.Boolean getAlertOnSuccess()
Retrieves the flag that indicates whether the server should generate an administrative alert if this task completes successfully.- Returns:
true
if the server should send an alert if this task completes successfully,false
if the server should not send an alert, ornull
if it is not available.
-
getAlertOnError
@Nullable public final java.lang.Boolean getAlertOnError()
Retrieves the flag that indicates whether the server should generate an administrative alert if this task fails to complete successfully.- Returns:
true
if the server should send an alert if this task fails to complete successfully,false
if the server should not send an alert, ornull
if it is not available.
-
createTaskEntry
@NotNull public final Entry createTaskEntry()
Creates an entry that may be added to the Directory Server to create a new instance of this task.- Returns:
- An entry that may be added to the Directory Server to create a new instance of this task.
-
parseBooleanValue
protected static boolean parseBooleanValue(@NotNull Entry taskEntry, @NotNull java.lang.String attributeName, boolean defaultValue) throws TaskException
Parses the value of the specified attribute as aboolean
value, or throws an exception if the value cannot be decoded as a boolean.- Parameters:
taskEntry
- The entry containing the attribute to be parsed.attributeName
- The name of the attribute from which the value was taken.defaultValue
- The default value to use if the provided value string isnull
.- Returns:
true
if the value string represents a boolean value oftrue
,false
if the value string represents a boolean value offalse
, or the default value if the value string isnull
.- Throws:
TaskException
- If the provided value string cannot be parsed as aboolean
value.
-
parseStringList
@NotNull protected static java.util.List<java.lang.String> parseStringList(@NotNull Entry taskEntry, @NotNull java.lang.String attributeName)
Parses the values of the specified attribute as a list of strings.- Parameters:
taskEntry
- The entry containing the attribute to be parsed.attributeName
- The name of the attribute from which the value was taken.- Returns:
- A list of strings containing the values of the specified attribute, or an empty list if the specified attribute does not exist in the target entry. The returned list will be unmodifiable.
-
parseBoolean
@Nullable protected static java.lang.Boolean parseBoolean(@NotNull TaskProperty p, @NotNull java.util.List<java.lang.Object> values, @Nullable java.lang.Boolean defaultValue) throws TaskException
Parses the provided set of values for the associated task property as aBoolean
.- Parameters:
p
- The task property with which the values are associated.values
- The provided values for the task property.defaultValue
- The default value to use if the provided object array is empty.- Returns:
- The parsed
Boolean
value. - Throws:
TaskException
- If there is a problem with the provided values.
-
parseDate
@Nullable protected static java.util.Date parseDate(@NotNull TaskProperty p, @NotNull java.util.List<java.lang.Object> values, @Nullable java.util.Date defaultValue) throws TaskException
Parses the provided set of values for the associated task property as aDate
.- Parameters:
p
- The task property with which the values are associated.values
- The provided values for the task property.defaultValue
- The default value to use if the provided object array is empty.- Returns:
- The parsed
Date
value. - Throws:
TaskException
- If there is a problem with the provided values.
-
parseLong
@Nullable protected static java.lang.Long parseLong(@NotNull TaskProperty p, @NotNull java.util.List<java.lang.Object> values, @Nullable java.lang.Long defaultValue) throws TaskException
Parses the provided set of values for the associated task property as aLong
.- Parameters:
p
- The task property with which the values are associated.values
- The provided values for the task property.defaultValue
- The default value to use if the provided object array is empty.- Returns:
- The parsed
Long
value. - Throws:
TaskException
- If there is a problem with the provided values.
-
parseString
@Nullable protected static java.lang.String parseString(@NotNull TaskProperty p, @NotNull java.util.List<java.lang.Object> values, @Nullable java.lang.String defaultValue) throws TaskException
Parses the provided set of values for the associated task property as aString
.- Parameters:
p
- The task property with which the values are associated.values
- The provided values for the task property.defaultValue
- The default value to use if the provided object array is empty.- Returns:
- The parsed
String
value. - Throws:
TaskException
- If there is a problem with the provided values.
-
parseStrings
@Nullable protected static java.lang.String[] parseStrings(@NotNull TaskProperty p, @NotNull java.util.List<java.lang.Object> values, @Nullable java.lang.String[] defaultValues) throws TaskException
Parses the provided set of values for the associated task property as aString
array.- Parameters:
p
- The task property with which the values are associated.values
- The provided values for the task property.defaultValues
- The set of default values to use if the provided object array is empty.- Returns:
- The parsed
String
values. - Throws:
TaskException
- If there is a problem with the provided values.
-
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.- 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.- 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.
-
decodeTask
@NotNull public static Task decodeTask(@NotNull Entry entry) throws TaskException
Decodes the provided entry as a scheduled task. An attempt will be made to decode the entry as an appropriate subclass if possible, but it will fall back to a generic task if it is not possible to decode as a more specific task type.- Parameters:
entry
- The entry to be decoded.- Returns:
- The decoded task.
- Throws:
TaskException
- If the provided entry cannot be parsed as a scheduled task.
-
getCommonTaskProperties
@NotNull public static java.util.List<TaskProperty> getCommonTaskProperties()
Retrieves a list of task properties that may be provided when scheduling any type of task. This includes:- The task ID
- The scheduled start time
- The task IDs of any tasks on which this task is dependent
- The action to take for this task if any of its dependencies fail
- The addresses of users to notify when this task starts
- The addresses of users to notify when this task completes
- The addresses of users to notify if this task succeeds
- The addresses of users to notify if this task fails
- A flag indicating whether to generate an alert when the task starts
- A flag indicating whether to generate an alert when the task succeeds
- A flag indicating whether to generate an alert when the task fails
- Returns:
- A list of task properties that may be provided when scheduling any type of task.
-
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.- 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
, orString
. 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 fromsuper.getTaskPropertyValues()
and the values of their own task-specific properties.- Returns:
- A map of the task property values for this task.
-
toString
@NotNull public final java.lang.String toString()
Retrieves a string representation of this task.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this task.
-
-