org.onehippo.repository.scheduling

Interface RepositoryScheduler

public interface RepositoryScheduler

Repository service for scheduling jobs.

Method Summary

Modifier and Type	Method and Description
boolean	checkExists(String jobName, String groupName) Return whether a job already exists.
void	deleteJob(String jobIdentifier) Removes a job and its associated triggers.
void	deleteJob(String jobName, String groupName) Removes a job and its associated triggers.
void	executeJob(String jobIdentifier) Trigger the job (execute it now) identified by jobIdentifier.
void	executeJob(String jobName, String groupName) Trigger the job (execute it now) identified by jobName and groupName.
void	scheduleJob(RepositoryJobInfo jobInfo, RepositoryJobTrigger trigger) Schedule a job.

Method Detail

scheduleJob

void scheduleJob(RepositoryJobInfo jobInfo,
                 RepositoryJobTrigger trigger)
          throws javax.jcr.RepositoryException

Schedule a job.

Parameters:

jobInfo - information about the job to schedule.

trigger - when to schedule the job.

Throws:

javax.jcr.RepositoryException - if an error occurs while trying to schedule the job.

deleteJob

void deleteJob(String jobName,
               String groupName)
        throws javax.jcr.RepositoryException

Removes a job and its associated triggers.

Parameters:

jobName - name of the job.

groupName - name of the group, may be null to indicate the default group.

Throws:

javax.jcr.RepositoryException - if an error occurs while trying to remove the job.

deleteJob

void deleteJob(String jobIdentifier)
        throws javax.jcr.RepositoryException

Removes a job and its associated triggers.

Parameters:

jobIdentifier - name of the job.

Throws:

javax.jcr.RepositoryException - if an error occurs while trying to remove the job.

checkExists

boolean checkExists(String jobName,
                    String groupName)
             throws javax.jcr.RepositoryException

Return whether a job already exists.

Parameters:

jobName - name of the job.

groupName - name of the the group, may be null to indicate the default group.

Returns:

whether the job exists or not

Throws:

javax.jcr.RepositoryException - if an error occurs while checking for the existence of the job.

executeJob

void executeJob(String jobName,
                String groupName)
         throws javax.jcr.RepositoryException

Trigger the job (execute it now) identified by jobName and groupName.

Parameters:

jobName - name of the job

groupName - name of the group, may be null to indicate the default group.

Throws:

javax.jcr.RepositoryException

executeJob

void executeJob(String jobIdentifier)
         throws javax.jcr.RepositoryException

Trigger the job (execute it now) identified by jobIdentifier.

Parameters:

jobIdentifier - name of the job

Throws:

javax.jcr.RepositoryException