Package com.unboundid.directory.sdk.ds.api

Class RecurringTask

java.lang.Object

com.unboundid.directory.sdk.ds.api.RecurringTask

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<RecurringTaskConfig>, UnboundIDExtension

@BrokerExtension
@Extensible
@DirectoryServerExtension
@DirectoryProxyServerExtension(appliesToLocalContent=true,
                               appliesToRemoteContent=false)
@MetricsEngineExtension
@SynchronizationServerExtension(appliesToLocalContent=true,
                                appliesToSynchronizedContent=false)
@ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class RecurringTask
extends java.lang.Object
implements UnboundIDExtension, Reconfigurable<RecurringTaskConfig>, ExampleUsageProvider

This class defines an API that must be implemented by extensions that may be used to schedule administrative tasks on a recurring basis. Recurring tasks are part of a recurring task chain, which combines the configuration needed to define the schedule with the recurring tasks that define the content of the tasks to schedule.

Recurring tasks created via this API can only be used to schedule Task instances that have themselves been implemented using the Server SDK. As when scheduling an individual instance of these tasks, the server must be configured as follows to allow creation of third-party tasks:

   dsconfig set-global-configuration-prop
     --add allowed-task:com.unboundid.directory.sdk.extensions.ThirdPartyTask
 

The Task instance actually performs the core processing for the administrative task, while the RecurringTask instance merely ensures that the Task is scheduled with the appropriate arguments.

Constructor Summary

Constructors

Constructor	Description
RecurringTask()	Creates a new instance of this recurring task.

Method Summary

Modifier and Type	Method	Description
ResultCode	applyConfiguration(RecurringTaskConfig config, ArgumentParser parser, java.util.List<java.lang.String> adminActionsRequired, java.util.List<java.lang.String> messages)	Attempts to apply the configuration from the provided argument parser to this extension.
void	defineConfigArguments(ArgumentParser parser)	Updates the provided argument parser to define any configuration arguments which may be used by this extension.
void	finalizeRecurringTask()	Performs any cleanup which may be necessary when this recurring task is to be taken out of service.
java.util.Map<java.util.List<java.lang.String>,java.lang.String>	getExamplesArgumentSets()	Retrieves a map containing examples of configurations that may be used for this extension.
abstract java.lang.String[]	getExtensionDescription()	Retrieves a human-readable description for this extension.
abstract java.lang.String	getExtensionName()	Retrieves a human-readable name for this extension.
abstract java.util.List<java.lang.String>	getTaskArguments(java.time.ZonedDateTime scheduledStartTime, ReadOnlyEntry lastTaskEntry)	Retrieves the list of values that should be provided to the ds-third-party-task-argument attribute for the task instance that is created.
abstract java.lang.Class<? extends Task>	getTaskJavaClass()	Retrieves the Java class that will be used to process instances of this recurring task.
void	initializeRecurringTask(DirectoryServerContext serverContext, RecurringTaskConfig config, ArgumentParser parser)	Initializes this recurring task.
boolean	isConfigurationAcceptable(RecurringTaskConfig config, ArgumentParser parser, java.util.List<java.lang.String> unacceptableReasons)	Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecurringTask

public RecurringTask()

Creates a new instance of this recurring task. All recurring task implementations must include a default constructor, but any initialization should generally be done in the initializeRecurringTask(com.unboundid.directory.sdk.ds.types.DirectoryServerContext, com.unboundid.directory.sdk.ds.config.RecurringTaskConfig, com.unboundid.util.args.ArgumentParser) method.

Method Detail

getExtensionName

public abstract java.lang.String getExtensionName()

Retrieves a human-readable name for this extension.

Specified by:

getExtensionName in interface UnboundIDExtension

Returns:

A human-readable name for this extension.

getExtensionDescription

public abstract java.lang.String[] getExtensionDescription()

Retrieves a human-readable description for this extension. Each element of the array that is returned will be considered a separate paragraph in generated documentation.

Specified by:

getExtensionDescription in interface UnboundIDExtension

Returns:

A human-readable description for this extension, or null or an empty array if no description should be available.

defineConfigArguments

public void defineConfigArguments(ArgumentParser parser)
                           throws ArgumentException

Updates the provided argument parser to define any configuration arguments which may be used by this extension. The argument parser may also be updated to define relationships between arguments (e.g., to specify required, exclusive, or dependent argument sets).

Specified by:

defineConfigArguments in interface Configurable

Parameters:

parser - The argument parser to be updated with the configuration arguments which may be used by this extension.

Throws:

ArgumentException - If a problem is encountered while updating the provided argument parser.

initializeRecurringTask

public void initializeRecurringTask(DirectoryServerContext serverContext,
                                    RecurringTaskConfig config,
                                    ArgumentParser parser)
                             throws LDAPException

Initializes this recurring task.

Parameters:

serverContext - A handle to the server context for the server in which this extension is running.

config - The general configuration for this recurring task.

parser - The argument parser which has been initialized from the configuration for this recurring task.

Throws:

LDAPException - If a problem occurs while initializing this recurring task.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(RecurringTaskConfig config,
                                         ArgumentParser parser,
                                         java.util.List<java.lang.String> unacceptableReasons)

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension. The parser will have been used to parse any configuration available for this extension, and any automatic validation will have been performed. This method may be used to perform any more complex validation which cannot be performed automatically by the argument parser.

Specified by:

isConfigurationAcceptable in interface Reconfigurable<RecurringTaskConfig>

Parameters:

config - The general configuration for this extension.

parser - The argument parser that has been used to parse the proposed configuration for this extension.

unacceptableReasons - A list to which messages may be added to provide additional information about why the provided configuration is not acceptable.

Returns:

true if the configuration in the provided argument parser appears to be acceptable, or false if not.

applyConfiguration

public ResultCode applyConfiguration(RecurringTaskConfig config,
                                     ArgumentParser parser,
                                     java.util.List<java.lang.String> adminActionsRequired,
                                     java.util.List<java.lang.String> messages)

Attempts to apply the configuration from the provided argument parser to this extension.

Specified by:

applyConfiguration in interface Reconfigurable<RecurringTaskConfig>

Parameters:

config - The general configuration for this extension.

parser - The argument parser that has been used to parse the new configuration for this extension.

adminActionsRequired - A list to which messages may be added to provide additional information about any additional administrative actions that may be required to apply some of the configuration changes.

messages - A list to which messages may be added to provide additional information about the processing performed by this method.

Returns:

A result code providing information about the result of applying the configuration change. A result of SUCCESS should be used to indicate that all processing completed successfully. Any other result will indicate that a problem occurred during processing.

finalizeRecurringTask

public void finalizeRecurringTask()

Performs any cleanup which may be necessary when this recurring task is to be taken out of service.

getTaskJavaClass

public abstract java.lang.Class<? extends Task> getTaskJavaClass()

Retrieves the Java class that will be used to process instances of this recurring task.

Returns:

The java class that will be used to process instances of this recurring task. It must not be null.

getTaskArguments

public abstract java.util.List<java.lang.String> getTaskArguments(java.time.ZonedDateTime scheduledStartTime,
                                                                  ReadOnlyEntry lastTaskEntry)

Retrieves the list of values that should be provided to the ds-third-party-task-argument attribute for the task instance that is created.

Parameters:

scheduledStartTime - The scheduled start time that will be used for the task that is created.

lastTaskEntry - The entry for the last instance of the recurring task that was scheduled. It may be null if the last instance is not available (for example, because no instances of the recurring task have yet been scheduled.

Returns:

The list of values that should be provided to the ds-third-party-task-argument for the task instance that is created. It may be null or empty if the task does not require any arguments.

getExamplesArgumentSets

public java.util.Map<java.util.List<java.lang.String>,java.lang.String> getExamplesArgumentSets()

Retrieves a map containing examples of configurations that may be used for this extension. The map key should be a list of sample arguments, and the corresponding value should be a description of the behavior that will be exhibited by the extension when used with that configuration.

Specified by:

getExamplesArgumentSets in interface ExampleUsageProvider

Returns:

A map containing examples of configurations that may be used for this extension. It may be null or empty if there should not be any example argument sets.