Package org.opends.server.tools.dsreplication

Class PurgeHistoricalScheduleInformation

java.lang.Object

org.opends.server.tools.dsreplication.PurgeHistoricalScheduleInformation

All Implemented Interfaces:

TaskScheduleInformation

public class PurgeHistoricalScheduleInformation
extends Object
implements TaskScheduleInformation

This is a simple adaptor to create a task schedule information object using the data provided by the user. It is used to be able to share some code with the TaskTool class.

Constructor Summary

Constructors

Constructor	Description
PurgeHistoricalScheduleInformation(PurgeHistoricalUserData uData)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addTaskAttributes(List<RawAttribute> attributes)	Adds utility specific attributes to attributes for population of the entry that is added to the task backend.
List<String>	getDependencyIds()	Gets a list of task IDs upon which this task is dependent.
FailedDependencyAction	getFailedDependencyAction()	Gets the action to take should one of the dependent task fail.
List<String>	getNotifyUponCompletionEmailAddresses()	Gets a list of email address to which an email will be sent when this task completes.
List<String>	getNotifyUponErrorEmailAddresses()	Gets a list of email address to which an email will be sent if this task encounters an error during execution.
String	getRecurringDateTime()	Gets the date/time pattern for recurring task schedule.
Date	getStartDateTime()	Gets the date at which this task should be scheduled to start.
Class<?>	getTaskClass()	Gets the Class that implements the utility to execute.
String	getTaskId()	Gets an arbitrary task id assigned to this task.
String	getTaskObjectclass()	Gets the objectclass used to represent scheduled instances of this utility in the task backend.

Methods inherited from class java.lang.Object

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

Constructor Detail

PurgeHistoricalScheduleInformation

public PurgeHistoricalScheduleInformation(PurgeHistoricalUserData uData)

Default constructor.

Parameters:

uData - the data provided by the user to do the purge historical.

Method Detail

addTaskAttributes

public void addTaskAttributes(List<RawAttribute> attributes)

Description copied from interface: TaskScheduleInformation

Adds utility specific attributes to attributes for population of the entry that is added to the task backend.

Specified by:

addTaskAttributes in interface TaskScheduleInformation

Parameters:

attributes - that will be added to the task backend

getDependencyIds

public List<String> getDependencyIds()

Description copied from interface: TaskScheduleInformation

Gets a list of task IDs upon which this task is dependent.

Specified by:

getDependencyIds in interface TaskScheduleInformation

Returns:

list of task IDs

getFailedDependencyAction

public FailedDependencyAction getFailedDependencyAction()

Description copied from interface: TaskScheduleInformation

Gets the action to take should one of the dependent task fail.

Specified by:

getFailedDependencyAction in interface TaskScheduleInformation

Returns:

action to take

getNotifyUponCompletionEmailAddresses

public List<String> getNotifyUponCompletionEmailAddresses()

Description copied from interface: TaskScheduleInformation

Gets a list of email address to which an email will be sent when this task completes.

Specified by:

getNotifyUponCompletionEmailAddresses in interface TaskScheduleInformation

Returns:

list of email addresses

getNotifyUponErrorEmailAddresses

public List<String> getNotifyUponErrorEmailAddresses()

Description copied from interface: TaskScheduleInformation

Gets a list of email address to which an email will be sent if this task encounters an error during execution.

Specified by:

getNotifyUponErrorEmailAddresses in interface TaskScheduleInformation

Returns:

list of email addresses

getRecurringDateTime

public String getRecurringDateTime()

Description copied from interface: TaskScheduleInformation

Gets the date/time pattern for recurring task schedule.

Specified by:

getRecurringDateTime in interface TaskScheduleInformation

Returns:

recurring date/time pattern at which the task should be scheduled.

getStartDateTime

public Date getStartDateTime()

Description copied from interface: TaskScheduleInformation

Gets the date at which this task should be scheduled to start.

Specified by:

getStartDateTime in interface TaskScheduleInformation

Returns:

date/time at which the task should be scheduled

getTaskClass

public Class<?> getTaskClass()

Description copied from interface: TaskScheduleInformation

Gets the Class that implements the utility to execute.

Specified by:

getTaskClass in interface TaskScheduleInformation

Returns:

class of the tasks implementation

getTaskId

public String getTaskId()

Description copied from interface: TaskScheduleInformation

Gets an arbitrary task id assigned to this task.

Specified by:

getTaskId in interface TaskScheduleInformation

Returns:

assigned task id if any or null otherwise.

getTaskObjectclass

public String getTaskObjectclass()

Description copied from interface: TaskScheduleInformation

Gets the objectclass used to represent scheduled instances of this utility in the task backend.

Specified by:

getTaskObjectclass in interface TaskScheduleInformation

Returns:

String representation of this utilities objectclass