COM.safe.fmeserver.api.schedule

Interface IFMEScheduleManager

All Known Implementing Classes:

FMEScheduleManager

public interface IFMEScheduleManager

Method Summary

Methods

Modifier and Type	Method and Description
IFMECronTrigger	createCronTrigger(java.util.Date startTime, java.util.Date endTime, java.lang.String cronExpression) Creates a trigger that will occur at the given time, until the given end time.
IFMEDateIntervalTrigger	createDateIntervalTrigger(java.util.Date startTime) Creates a trigger that will occur at the given time, and not repeat.
IFMEDateIntervalTrigger	createDateIntervalTrigger(java.util.Date startTime, java.util.Date endTime, IFMEDateIntervalTrigger.IntervalUnit intervalUnit, int repeatInterval) Creates a trigger that will occur at the given time, and repeat at the the given interval until the given end time.
IFMETask	createTask(IFMETaskConfig taskConfig, IFMETrigger trigger, boolean isEnabled, java.util.Map<java.lang.String,java.lang.String> directives) Creates the task to be scheduled.
IFMETransformationTaskConfig	createTransformationTaskConfig(java.lang.String category, java.lang.String name, java.lang.String description, IFMETransformationRequest transformationRequest) Creates a task configuration for a transformation request.
long	getNumTasks(java.util.Map<java.lang.String,java.lang.String> directives) Gets the number of schedule tasks.
IFMETask	getTask(java.lang.String category, java.lang.String name) Gets the scheduled task.
java.util.List<IFMETask>	getTasks(java.util.Map<java.lang.String,java.lang.String> directives) Gets a list of schedule tasks.
boolean	removeTask(java.lang.String category, java.lang.String name) Removes the scheduled task.
void	scheduleTask(IFMETask task) Schedules the task.
void	scheduleTask(IFMETaskConfig taskConfig, IFMETrigger trigger) Schedules the task with the given task configuration and trigger.
boolean	taskExists(java.lang.String category, java.lang.String name) Checks if the scheduled task exists.
void	updateTask(IFMETask task) Updates the scheduled task.

Method Detail

createTransformationTaskConfig

IFMETransformationTaskConfig createTransformationTaskConfig(java.lang.String category,
                                                          java.lang.String name,
                                                          java.lang.String description,
                                                          IFMETransformationRequest transformationRequest)

Creates a task configuration for a transformation request.

Parameters:

category - the task category

name - the task name

description - the task description

transformationRequest - the transformation request

Returns:

a new IFMETransformationTaskConfig instance.

createDateIntervalTrigger

IFMEDateIntervalTrigger createDateIntervalTrigger(java.util.Date startTime,
                                                java.util.Date endTime,
                                                IFMEDateIntervalTrigger.IntervalUnit intervalUnit,
                                                int repeatInterval)

Creates a trigger that will occur at the given time, and repeat at the the given interval until the given end time. For example, the interval unit WEEK with a repeat interval 2 would fire every second week. Note: If repeatInterval is zero, the trigger will not repeat. It will occur at the given startTime. In addition the endTime will be set to be the startTime and IntervalUnit defaulted to be SECOND.

Parameters:

startTime - the time in which the trigger should start firing. If null, the trigger starts firing immediately.

endTime - the time in which trigger should stop firing. If null, the trigger never stops firing unless removed.

intervalUnit - the interval unit

repeatInterval - the repeat interval. If repeat interval is zero, the trigger will NOT repeat.

Returns:

a new IFMEDateIntervalTrigger instance.

createDateIntervalTrigger

IFMEDateIntervalTrigger createDateIntervalTrigger(java.util.Date startTime)

Creates a trigger that will occur at the given time, and not repeat. Note: The IntervalUnit will be defaulted to SECOND and repeat interval will be zero.

Parameters:

startTime - the time in which the trigger should start firing. If null, the trigger starts firing immediately.

Returns:

a new IFMEDateIntervalTrigger instance.

createCronTrigger

IFMECronTrigger createCronTrigger(java.util.Date startTime,
                                java.util.Date endTime,
                                java.lang.String cronExpression)

Creates a trigger that will occur at the given time, until the given end time. The time zone will be set to the system's default time zone. For example, the expression 0 0 10 * * ?, is resolved to 10:00 am in this time zone.

Parameters:

startTime - the time in which the trigger should start firing. If null, the trigger starts firing immediately.

endTime - the time in which trigger should stop firing. If null, the trigger never stops firing unless removed.

cronExpression - the cron expression.

Returns:

a new IFMECronTrigger instance.

scheduleTask

void scheduleTask(IFMETaskConfig taskConfig,
                IFMETrigger trigger)
                  throws FMEServerException

Schedules the task with the given task configuration and trigger. The task by default is enabled.

Parameters:

taskConfig - the task configuration.

trigger - the trigger.

Throws:

FMEServerException - if a FME Server exception occurred

getTask

IFMETask getTask(java.lang.String category,
               java.lang.String name)
                 throws FMEServerException

Gets the scheduled task.

Parameters:

category - the task category.

name - the task name.

Returns:

a new IFMETask instance.

Throws:

FMEServerException - if a FME Server exception occurred

removeTask

boolean removeTask(java.lang.String category,
                 java.lang.String name)
                   throws FMEServerException

Removes the scheduled task.

Parameters:

category - the task category.

name - the task name.

Returns:

true if task existed and was removed, otherwise false if task did not exist.

Throws:

FMEServerException - if a FME Server exception occurred

taskExists

boolean taskExists(java.lang.String category,
                 java.lang.String name)
                   throws FMEServerException

Checks if the scheduled task exists.

Parameters:

category - the task category.

name - the task name.

Returns:

true if task exists, otherwise false if task does not exist.

Throws:

FMEServerException - if a FME Server exception occurred

getTasks

java.util.List<IFMETask> getTasks(java.util.Map<java.lang.String,java.lang.String> directives)
                                  throws FMEServerException

Gets a list of schedule tasks.

Parameters:

directives - a Map of keyword and values specifying schedule tasks to return

If null then the first 100 schedule tasks are returned.

If TASK_LIMIT keyword used, then directive value must specify the starting point and the duration. Spaces are treated as delimiters. For example, the value "0 10" means the first schedule tasks will start at position 0 and 10 subsequent schedule tasks will be returned.

Returns:

a list of schedule tasks.

Throws:

FMEServerException - if a FME Server exception occurred

getNumTasks

long getNumTasks(java.util.Map<java.lang.String,java.lang.String> directives)
                 throws FMEServerException

Gets the number of schedule tasks.

Parameters:

directives - a Map of keyword and values specifying schedule tasks to return

If null then the total number of schedule tasks is returned.

Returns:

the number of schedule tasks.

Throws:

FMEServerException - if a FME Server exception occurred

createTask

IFMETask createTask(IFMETaskConfig taskConfig,
                  IFMETrigger trigger,
                  boolean isEnabled,
                  java.util.Map<java.lang.String,java.lang.String> directives)

Creates the task to be scheduled.

Parameters:

taskConfig - the task configuration.

trigger - the trigger.

isEnabled - true if task is enabled, otherwise false.

directives - reserved for future use. If null, defaults used.

Returns:

a new IFMETask instance.

scheduleTask

void scheduleTask(IFMETask task)
                  throws FMEServerException

Schedules the task.

Parameters:

task - the schedule task.

Throws:

FMEServerException - if a FME Server exception occurred

updateTask

void updateTask(IFMETask task)
                throws FMEServerException

Updates the scheduled task.

Parameters:

task - the scheduled task.

Throws:

FMEServerException - if a FME Server exception occurred