org.opends.server.backends.task
Class RecurringTask

java.lang.Object
  org.opends.server.backends.task.RecurringTask

public class RecurringTask
extends java.lang.Object

This class defines a information about a recurring task, which will be used to repeatedly schedule tasks for processing.

Constructor Summary

RecurringTask(TaskScheduler taskScheduler, Entry recurringTaskEntry)
Creates a new recurring task based on the information in the provided entry.

Method Summary

Entry	getRecurringTaskEntry() Retrieves the entry containing the data for this recurring task.
DN	getRecurringTaskEntryDN() Retrieves the DN of the entry containing the data for this recurring task.
java.lang.String	getRecurringTaskID() Retrieves the unique ID assigned to this recurring task.
java.lang.String	getTaskClassName() Retrieves the fully-qualified name of the Java class that provides the implementation logic for this recurring task.
Task	scheduleNextIteration() Schedules the next iteration of this recurring task for processing.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecurringTask

public RecurringTask(TaskScheduler taskScheduler,
                     Entry recurringTaskEntry)
              throws DirectoryException

Creates a new recurring task based on the information in the provided entry.

Parameters:

taskScheduler - A reference to the task scheduler that may be used to schedule new tasks.

recurringTaskEntry - The entry containing the information to use to define the task to process.

Throws:

DirectoryException - If the provided entry does not contain a valid recurring task definition.

Method Detail

getRecurringTaskID

public java.lang.String getRecurringTaskID()

Retrieves the unique ID assigned to this recurring task.

Returns:

The unique ID assigned to this recurring task.

getRecurringTaskEntryDN

public DN getRecurringTaskEntryDN()

Retrieves the DN of the entry containing the data for this recurring task.

Returns:

The DN of the entry containing the data for this recurring task.

getRecurringTaskEntry

public Entry getRecurringTaskEntry()

Retrieves the entry containing the data for this recurring task.

Returns:

The entry containing the data for this recurring task.

getTaskClassName

public java.lang.String getTaskClassName()

Retrieves the fully-qualified name of the Java class that provides the implementation logic for this recurring task.

Returns:

The fully-qualified name of the Java class that provides the implementation logic for this recurring task.

scheduleNextIteration

public Task scheduleNextIteration()

Schedules the next iteration of this recurring task for processing.

Returns:

The task that has been scheduled for processing.