|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SchedulerService
Method Summary | |
---|---|
void |
addJob(JobDetails job) Adds the job that would be scheduled using the Scheduler Service |
void |
createScheduledTask(org.w3c.dom.Document xmlDoc) Create a Schedule task definition in the metadata repository. |
void |
createScheduledTask(ScheduledTask schTask) Create a Schedule task definition in the metadata repository. |
void |
deleteJob(JobDetails job) Deletes the specified Job that has been registered with the Scheduler Service |
JobDetails[] |
deleteScheduledTask(java.lang.String taskName) Delete the Schedule task definition from the metadata repository. |
void |
deleteTrigger(java.lang.String job) Deletes the specified trigger that has been registered with a Job |
java.util.List |
getAllHistoryOfJob() Returns a run history of all the Jobs in the system |
JobDetails[] |
getAllJobDetails() Returns a list of Job-details for all the Jobs in the system |
java.lang.String[] |
getAllJobs() Returns a list of name of all the Scheduler Jobs |
JobHistory |
getHistoryOfJob(long jobHistoryID) Returns the details of the jobHitory for the jobHistoryID passed as a parameter |
java.util.List |
getHistoryOfJob(java.lang.String jobName) Lists the detail of the runs made for the specified schedule Job |
JobDetails |
getJobDetail(java.lang.String name) Returns the JobDetail for the specified job |
JobDetails[] |
getJobDetails(java.lang.String name) Searches the jobs with the specified search criteria.Wild card characters can be specified as the search criteria |
JobParameter |
getJobParameter(long id, java.lang.String parameterType) Returns the Resource Object with the whose ID specified in the parameter - Sanjeev |
JobParameter |
getJobParameter(java.lang.String name, java.lang.String parameterType) Returns the Resource Object with the name specified in the parameter - Sanjeev |
java.util.HashMap |
getJobParameters(java.lang.String searchCriteria, java.lang.String parameterType) Returns a HashMap of key and name of the Job Parameters |
java.lang.String[] |
getJobs(java.lang.String name) Searches the job with the specified name.Wild card characters can be specified as the search criteria |
JobDetails[] |
getJobsOfSchedulerTask(java.lang.String scheduleTaskName) Returns a list of the Job Details for all the jobs for the specified Task |
JobHistory |
getLastHistoryOfJob(java.lang.String name) Returns the details of the last job run for the Job specified |
java.lang.String[] |
getScheduledTasks(java.lang.String searchCriteria) Returns a list of Schedule Tasks which match the search criteria provided |
int |
getStatus() Returns the Scheduler Status |
int |
getStatusOfJob(java.lang.String jobName) |
Trigger[] |
getTriggersOfJob(java.lang.String jobName) It returns all the triggers attached to a schedule Job. |
java.util.HashMap |
listScheduledTasks() Returns a list of all the schedule tasks |
ScheduledTask |
lookupScheduledTask(java.lang.String name) Finds the Task that is specified as parameter |
ScheduledTask[] |
lookupScheduledTaskbyClass(java.lang.String className) Finds the Task that is specified as parameter |
void |
pauseJob(java.lang.String jobName) Pauses the action of the specified schedule Job |
void |
pauseTrigger(java.lang.String triggerName) Pauses the action of the running schedule task |
void |
rescheduleJob(java.lang.String name, java.lang.String existingTriggerName, Trigger trigger) Updates the trigger attached with the job |
void |
resetRunningJobStatus() This method is invoked after invocation of shut down of scheduler service/shutdown of server This method reset the status of all the running jobs to stopped in job history table |
void |
resumeJob(java.lang.String jobName) Resumes the action of the paused schedule Job |
void |
scheduleJob(JobDetails job, Trigger trigger) Schedules the specified job as per the trigger details provided |
void |
scheduleJob(java.lang.String jobName, Trigger trigger) Schedules the specified job as per the trigger details provided |
java.util.HashMap |
searchJobs(SearchCriteria searchCriteria) Retrieves list of schedule Jobs based on the search criteria For specifying searchcriteria use JOB_NAME_FILTER, TASK_FILTER and JOB_STATUS_FILTER as parameters only. |
void |
start() Starts the Scheduler Service |
void |
stop() Stops the Scheduler |
void |
stopJob(java.lang.String jobName) Stops the instance of the Job that is running |
void |
triggerNow(java.lang.String jobName) Runs the specified job |
void |
triggerNow(java.lang.String jobName, NowTrigger trigger) Runs the specified job at the current time |
void |
updateJob(JobDetails job) Updates the schedule Job that has been created.The update can either be for the job details or the job parameters. |
void |
updateScheduledTask(org.w3c.dom.Document xmlDoc) Update a Schedule task definition in the metadata repository. |
void |
updateScheduledTask(ScheduledTask schTask) Update a Schedule task definition in the metadata repository. |
Method Detail |
---|
void start() throws SchedulerException, SchedulerAccessDeniedException
SchedulerException
SchedulerAccessDeniedException
void scheduleJob(JobDetails job, Trigger trigger) throws SchedulerException, RequiredParameterNotSetException, ParameterValueTypeNotSupportedException, IncorrectScheduleTaskDefinationException, SchedulerAccessDeniedException
Job
- Detail of the job that is to be scheduledtrigger
- Trigger Details to specify when the scheduled job will be triggeredSchedulerException
- is thrown when Job Parameters are not of one of the expected Data-TypesRequiredParameterNotSetException
- This exception will be thrown if value is not set for required parameters of a schedule Job.ParameterValueTypeNotSupported
- Exception This exception will be thrown if value set for required parameters of a schedule Job is not supported in application. Only following type is supported String, Boolean & LongIncorrectScheduleTaskDefination
- Exception This exception will be thrown if SchedulerTask definition is not correctSchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the userParameterValueTypeNotSupportedException
IncorrectScheduleTaskDefinationException
void scheduleJob(java.lang.String jobName, Trigger trigger) throws SchedulerException, oracle.iam.platform.kernel.StaleDataException, SchedulerAccessDeniedException
jobName
- Name of the job that is to be scheduledtrigger
- Trigger Details to specify when the scheduled job will be triggeredSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.oracle.iam.platform.kernel.StaleDataException
- This exception will be thrown if data is already updatedSchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the uservoid deleteJob(JobDetails job) throws SchedulerException, LastModifyDateNotSetException, oracle.iam.platform.kernel.StaleDataException, SchedulerAccessDeniedException, SchedulerJobNotDeletableException
job
- JobDetails of the job that is to be deleted.SchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.oracle.iam.platform.kernel.StaleDataException
- This exception will be thrown if data is already updatedLastModifyDateNotSetException
- This exception will be thrown if last modify date is not set for the object.SchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the userSchedulerJobNotDeletableException
- This exception will be thrown if Schedule Job cannot be deleted because it is running.void deleteTrigger(java.lang.String job) throws SchedulerException, SchedulerAccessDeniedException
jobName
- name of job that has to be deleteSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.SchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the uservoid addJob(JobDetails job) throws SchedulerException, RequiredParameterNotSetException, ParameterValueTypeNotSupportedException, IncorrectScheduleTaskDefinationException, SchedulerAccessDeniedException
job
- JDetails of the job that is to be added.SchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.RequiredParameterNotSetException
- This exception will be thrown if value is not set for required parameters of a schedule job.ParameterValueTypeNotSupportedException
- This exception will be thrown if value set for required parameters of a schedule job is not supported in application. Only following type is supported String, Boolean & LongIncorrectScheduleTaskDefinationException
- This exception will be thrown if SchedulerTask definition is not correctSchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the uservoid updateJob(JobDetails job) throws SchedulerException, RequiredParameterNotSetException, ParameterValueTypeNotSupportedException, IncorrectScheduleTaskDefinationException, oracle.iam.platform.kernel.StaleDataException, LastModifyDateNotSetException, SchedulerAccessDeniedException
job
- JobDetails of the job (and or job parameters ) that is to be updatedSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.RequiredParameterNotSetException
- This exception will be thrown if value is not set for required parameters of a schedule Job.ParameterValueTypeNotSupportedException
- This exception will be thrown if value set for required parameters of a schedule Job is not supported in application. Only following type is supported String, Boolean & LongIncorrectScheduleTaskDefinationException
- This exception will be thrown if SchedulerTask definition is not correctoracle.iam.platform.kernel.StaleDataException
- This exception will be thrown if data is already updatedLastModifyDateNotSetException
- This exception will be thrown if last modify date is not set for the object.SchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the uservoid triggerNow(java.lang.String jobName) throws SchedulerException, SchedulerAccessDeniedException
jobName
- The job that is to be triggeredSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.SchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the uservoid triggerNow(java.lang.String jobName, NowTrigger trigger) throws SchedulerException, SchedulerAccessDeniedException
jobName
- The job that is to be triggeredtrigger
- Trigger details for the execution of the specified jobSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.SchedulerAccessDeniedException
- SchedulerAccessDeniedException This exception will be thrown if access permission for operation is not available to the uservoid stopJob(java.lang.String jobName) throws SchedulerException, SchedulerAccessDeniedException
name
- of the schedule JobSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.SchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the userTrigger[] getTriggersOfJob(java.lang.String jobName) throws SchedulerException
name
- of the schedule JobSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.void rescheduleJob(java.lang.String name, java.lang.String existingTriggerName, Trigger trigger) throws SchedulerException, LastModifyDateNotSetException, oracle.iam.platform.kernel.StaleDataException, SchedulerAccessDeniedException
name
- of the schedule JobexistingTriggerName
- OLD Trigger Name that is to be replacedtrigger
- New Trigger Details, set the lastModifyDate with the Date on which you are going to updateSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.oracle.iam.platform.kernel.StaleDataException
- This exception will be thrown if data is already updatedLastModifyDateNotSetException
- This exception will be thrown if last modify date is not set for the object.SchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the userJobDetails getJobDetail(java.lang.String name) throws SchedulerException
name
- of the JobSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.void stop() throws SchedulerException, SchedulerAccessDeniedException
SchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.SchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the userScheduledTask lookupScheduledTask(java.lang.String name) throws IncorrectScheduleTaskDefinationException
name
- of the schedule task whose details are to be fetchedIncorrectScheduleTaskDefinationException
- This exception will be thrown if SchedulerTask definition is not correctScheduledTask[] lookupScheduledTaskbyClass(java.lang.String className) throws IncorrectScheduleTaskDefinationException
className
- of the schedule task class whose details are to be fetchedIncorrectScheduleTaskDefinationException
- This exception will be thrown if SchedulerTask definition is not correctJobDetails[] deleteScheduledTask(java.lang.String taskName) throws SchedulerException, DeleteScheduleTaskDefinitionException, SchedulerAccessDeniedException, LastModifyDateNotSetException, oracle.iam.platform.kernel.StaleDataException, SchedulerJobNotDeletableException
taskName
- of the schedule task to be deletedSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.DeleteScheduleTaskDefinationException
- This exception will be thrown if MetaData repository throw any exception while deleting a Schedule task from MDS.SchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the user.LastModifyDateNotSetException
- This exception will be thrown if last modify date is not set for the object.oracle.iam.platform.kernel.StaleDataException
- This exception will be thrown if data is already updatedSchedulerJobNotDeletableException
- This exception will be thrown if Schedule Job cannot be deleted because it is running.DeleteScheduleTaskDefinitionException
void updateScheduledTask(org.w3c.dom.Document xmlDoc) throws SchedulerException, SchedulerAccessDeniedException, CreateScheduleTaskDefinitionException, UpdateScheduleTaskDefinitionException, IncorrectScheduleTaskDefinationException
xmlDoc
- of the XML contains schedule task definition to be createdSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.SchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the user.IncorrectScheduleTaskDefinationException
- This exception will be thrown if schedule task definition is incorrect.UpdateScheduleTaskDefinitionException
- This exception is thrown if any exception thrown from MDS repository while creating a schedule task.CreateScheduleTaskDefinitionException
void updateScheduledTask(ScheduledTask schTask) throws SchedulerException, SchedulerAccessDeniedException, CreateScheduleTaskDefinitionException, UpdateScheduleTaskDefinitionException, IncorrectScheduleTaskDefinationException
schTask
- is value object defined for scheduled task.SchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.SchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the user.IncorrectScheduleTaskDefinationException
- This exception will be thrown if schedule task defination is incorrect.UpdateScheduleTaskDefinitionException
- This exception is thrown if any exception thrown from MDS repository while creating a schedule task.CreateScheduleTaskDefinitionException
void createScheduledTask(org.w3c.dom.Document xmlDoc) throws SchedulerException, SchedulerAccessDeniedException, CreateScheduleTaskDefinitionException, IncorrectScheduleTaskDefinationException
xmlDoc
- of the XML contains schedule task definition to be createdSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.SchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the user.IncorrectScheduleTaskDefinationException
- This exception will be thrown if schedule task definition is incorrect.CreateScheduleTaskDefinitionException
- This exception is thrown if any exception thrown from MDS repository while creating a schedule task.void createScheduledTask(ScheduledTask schTask) throws SchedulerException, SchedulerAccessDeniedException, CreateScheduleTaskDefinitionException, IncorrectScheduleTaskDefinationException
schTask
- is value object defined for scheduled task.SchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.SchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the user.IncorrectScheduleTaskDefinationException
- This exception will be thrown if schedule task defination is incorrect.CreateScheduleTaskDefinitionException
- This exception is thrown if any exception thrown from MDS repository while creating a schedule task.java.util.HashMap listScheduledTasks() throws IncorrectScheduleTaskDefinationException
IncorrectScheduleTaskDefinationException
- This exception will be thrown if SchedulerTask definition is not correctjava.lang.String[] getAllJobs() throws SchedulerException
SchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.java.lang.String[] getJobs(java.lang.String name) throws SchedulerException
name
- of the job that is to be searchedSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.JobDetails[] getJobDetails(java.lang.String name) throws SchedulerException
search
- criteria of the job that is to be searchedSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.java.lang.String[] getScheduledTasks(java.lang.String searchCriteria) throws IncorrectScheduleTaskDefinationException
searchCriteria
- using which schedule tasks are to be foundIncorrectScheduleTaskDefinationException
- This exception will be thrown if SchedulerTask definition is not correctint getStatusOfJob(java.lang.String jobName) throws SchedulerException
JobName
- whose status is to be fetchedSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.java.util.List getHistoryOfJob(java.lang.String jobName)
name
- of the Schedule Job whose RUN-history is to be fetchedjava.util.List getAllHistoryOfJob()
JobHistory getLastHistoryOfJob(java.lang.String name) throws NoJobHistoryFoundException
name
- of the schedule Job whose history is to be retrievedNoJobHistoryFoundException
- when no history is available for the JobJobHistory getHistoryOfJob(long jobHistoryID) throws NoJobHistoryFoundException
jobHistoryID
- Id for which the details have to be fetchedNoJobHistoryFoundException
void resumeJob(java.lang.String jobName) throws SchedulerException, SchedulerAccessDeniedException
name
- of the schedule JobSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.SchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the uservoid pauseJob(java.lang.String jobName) throws SchedulerException, SchedulerAccessDeniedException
name
- of the schedule JobSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.SchedulerAccessDeniedException
- This exception will be thrown if access permission for operation is not available to the userJobDetails[] getJobsOfSchedulerTask(java.lang.String scheduleTaskName) throws SchedulerException
scheduleTaskName
- name of the schedule taskSchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.int getStatus()
JobDetails[] getAllJobDetails() throws SchedulerException
SchedulerException
- when an error occurs at the Quartz Engine or scheduler is not running.java.util.HashMap getJobParameters(java.lang.String searchCriteria, java.lang.String parameterType)
searchCriteria
- . This API allows passing wildcard, type of IT Resource type values etc as search criteria.parameterType
- type of parameter for e.g ITResource If a * is passed as SearchCriteria, API returns all the instances in the system.JobParameter getJobParameter(long id, java.lang.String parameterType) throws JobParameterNotFoundException
id
- of ResourceparameterType
- type of parameterJobParameterNotFoundException
- if no IT Resource found against the lookup criteriaJobParameter getJobParameter(java.lang.String name, java.lang.String parameterType) throws JobParameterNotFoundException
name
- of the JobParameter valueparameterType
- type of parameterJobParameterNotFoundException
- if no IT Resource found against the lookup criteriavoid pauseTrigger(java.lang.String triggerName) throws SchedulerException, SchedulerAccessDeniedException
triggerName
- Name of the TriggerSchedulerException
SchedulerAccessDeniedException
java.util.HashMap searchJobs(SearchCriteria searchCriteria) throws SchedulerException, SchedulerAccessDeniedException
SchedulerException
SchedulerAccessDeniedException
- Access related exceptionvoid resetRunningJobStatus() throws SchedulerException, SchedulerAccessDeniedException
SchedulerException
SchedulerAccessDeniedException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |