com.liferay.portal.scheduler.quartz

Class QuartzSchedulerEngine

java.lang.Object

com.liferay.portal.scheduler.quartz.QuartzSchedulerEngine

All Implemented Interfaces:

com.liferay.portal.kernel.scheduler.SchedulerEngine

public class QuartzSchedulerEngine
extends java.lang.Object
implements com.liferay.portal.kernel.scheduler.SchedulerEngine

Author:

Michael C. Han, Bruno Farache, Shuyang Zhou, Wesley Gong, Tina Tian

Field Summary

Fields

Modifier and Type	Field and Description
protected com.liferay.portal.service.QuartzLocalService	quartzLocalService

Fields inherited from interface com.liferay.portal.kernel.scheduler.SchedulerEngine

AUDIT_ACTION, DESCRIPTION, DESCRIPTION_MAX_LENGTH, DESTINATION_NAME, DISABLE, END_TIME, EXCEPTIONS_MAX_SIZE, FINAL_FIRE_TIME, GROUP_NAME, GROUP_NAME_MAX_LENGTH, JOB_NAME, JOB_NAME_MAX_LENGTH, JOB_STATE, LANGUAGE, MESSAGE, MESSAGE_LISTENER_CLASS_NAME, MESSAGE_LISTENER_UUID, NEXT_FIRE_TIME, PORTLET_ID, PREVIOUS_FIRE_TIME, RECEIVER_KEY, SCRIPT, START_TIME, STORAGE_TYPE

Constructor Summary

Constructors

Constructor and Description
QuartzSchedulerEngine()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	delete(java.lang.String groupName)
void	delete(java.lang.String jobName, java.lang.String groupName)
void	destroy()
protected java.lang.String	fixMaxLength(java.lang.String argument, int maxLength)
protected com.liferay.portal.kernel.scheduler.JobState	getJobState(org.quartz.JobDataMap jobDataMap)
protected com.liferay.portal.kernel.messaging.Message	getMessage(org.quartz.JobDataMap jobDataMap)
protected com.liferay.portal.kernel.messaging.MessageListener	getMessageListener(java.lang.String messageListenerClassName, java.lang.ClassLoader classLoader)
protected java.lang.String	getOriginalGroupName(java.lang.String groupName)
protected org.quartz.Trigger	getQuartzTrigger(com.liferay.portal.kernel.scheduler.Trigger trigger)
protected com.liferay.portal.kernel.scheduler.messaging.SchedulerResponse	getScheduledJob(org.quartz.Scheduler scheduler, org.quartz.JobKey jobKey)
com.liferay.portal.kernel.scheduler.messaging.SchedulerResponse	getScheduledJob(java.lang.String jobName, java.lang.String groupName)
java.util.List<com.liferay.portal.kernel.scheduler.messaging.SchedulerResponse>	getScheduledJobs()
protected java.util.List<com.liferay.portal.kernel.scheduler.messaging.SchedulerResponse>	getScheduledJobs(org.quartz.Scheduler scheduler, java.lang.String groupName)
java.util.List<com.liferay.portal.kernel.scheduler.messaging.SchedulerResponse>	getScheduledJobs(java.lang.String groupName)
protected org.quartz.Scheduler	getScheduler(java.lang.String groupName)
protected com.liferay.portal.kernel.scheduler.StorageType	getStorageType(java.lang.String groupName)
protected org.quartz.Scheduler	initializeScheduler(java.lang.String propertiesPrefix, boolean useQuartzCluster)
protected void	initJobState()
void	pause(java.lang.String groupName)
void	pause(java.lang.String jobName, java.lang.String groupName)
protected void	registerMessageListeners(java.lang.String jobName, java.lang.String groupName, java.lang.String destinationName, com.liferay.portal.kernel.messaging.Message message)
void	resume(java.lang.String groupName)
void	resume(java.lang.String jobName, java.lang.String groupName)
protected void	schedule(org.quartz.Scheduler scheduler, com.liferay.portal.kernel.scheduler.StorageType storageType, org.quartz.Trigger trigger, java.lang.String description, java.lang.String destinationName, com.liferay.portal.kernel.messaging.Message message)
void	schedule(com.liferay.portal.kernel.scheduler.Trigger trigger, java.lang.String description, java.lang.String destination, com.liferay.portal.kernel.messaging.Message message)
void	shutdown()
void	start()
void	suppressError(java.lang.String jobName, java.lang.String groupName)
protected void	unregisterMessageListener(org.quartz.Scheduler scheduler, org.quartz.JobKey jobKey)
protected void	unschedule(org.quartz.Scheduler scheduler, org.quartz.JobKey jobKey)
void	unschedule(java.lang.String groupName)
void	unschedule(java.lang.String jobName, java.lang.String groupName)
protected void	update(org.quartz.Scheduler scheduler, com.liferay.portal.kernel.scheduler.Trigger trigger)
void	update(com.liferay.portal.kernel.scheduler.Trigger trigger)
protected void	updateJobState(org.quartz.Scheduler scheduler, org.quartz.JobKey jobKey, com.liferay.portal.kernel.scheduler.TriggerState triggerState, boolean suppressError)

Methods inherited from class java.lang.Object

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

Field Detail

quartzLocalService

@BeanReference(name="com.liferay.portal.service.QuartzLocalService")
protected com.liferay.portal.service.QuartzLocalService quartzLocalService

Constructor Detail

QuartzSchedulerEngine

public QuartzSchedulerEngine()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

delete

public void delete(java.lang.String groupName)
            throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

delete in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

delete

public void delete(java.lang.String jobName,
          java.lang.String groupName)
            throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

delete in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

destroy

public void destroy()

getScheduledJob

public com.liferay.portal.kernel.scheduler.messaging.SchedulerResponse getScheduledJob(java.lang.String jobName,
                                                                              java.lang.String groupName)
                                                                                throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

getScheduledJob in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

getScheduledJobs

public java.util.List<com.liferay.portal.kernel.scheduler.messaging.SchedulerResponse> getScheduledJobs()
                                                                                                 throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

getScheduledJobs in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

getScheduledJobs

public java.util.List<com.liferay.portal.kernel.scheduler.messaging.SchedulerResponse> getScheduledJobs(java.lang.String groupName)
                                                                                                 throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

getScheduledJobs in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

pause

public void pause(java.lang.String groupName)
           throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

pause in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

pause

public void pause(java.lang.String jobName,
         java.lang.String groupName)
           throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

pause in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

resume

public void resume(java.lang.String groupName)
            throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

resume in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

resume

public void resume(java.lang.String jobName,
          java.lang.String groupName)
            throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

resume in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

schedule

public void schedule(com.liferay.portal.kernel.scheduler.Trigger trigger,
            java.lang.String description,
            java.lang.String destination,
            com.liferay.portal.kernel.messaging.Message message)
              throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

schedule in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

shutdown

public void shutdown()
              throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

shutdown in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

start

public void start()
           throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

start in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

suppressError

public void suppressError(java.lang.String jobName,
                 java.lang.String groupName)
                   throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

suppressError in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

unschedule

public void unschedule(java.lang.String groupName)
                throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

unschedule in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

unschedule

public void unschedule(java.lang.String jobName,
              java.lang.String groupName)
                throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

unschedule in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

update

public void update(com.liferay.portal.kernel.scheduler.Trigger trigger)
            throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

update in interface com.liferay.portal.kernel.scheduler.SchedulerEngine

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

fixMaxLength

protected java.lang.String fixMaxLength(java.lang.String argument,
                            int maxLength)

getJobState

protected com.liferay.portal.kernel.scheduler.JobState getJobState(org.quartz.JobDataMap jobDataMap)

getMessage

protected com.liferay.portal.kernel.messaging.Message getMessage(org.quartz.JobDataMap jobDataMap)

getMessageListener

protected com.liferay.portal.kernel.messaging.MessageListener getMessageListener(java.lang.String messageListenerClassName,
                                                                     java.lang.ClassLoader classLoader)
                                                                          throws com.liferay.portal.kernel.scheduler.SchedulerException

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

getOriginalGroupName

protected java.lang.String getOriginalGroupName(java.lang.String groupName)

getQuartzTrigger

protected org.quartz.Trigger getQuartzTrigger(com.liferay.portal.kernel.scheduler.Trigger trigger)
                                       throws com.liferay.portal.kernel.scheduler.SchedulerException

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

getScheduledJob

protected com.liferay.portal.kernel.scheduler.messaging.SchedulerResponse getScheduledJob(org.quartz.Scheduler scheduler,
                                                                              org.quartz.JobKey jobKey)
                                                                                   throws java.lang.Exception

Throws:

java.lang.Exception

getScheduledJobs

protected java.util.List<com.liferay.portal.kernel.scheduler.messaging.SchedulerResponse> getScheduledJobs(org.quartz.Scheduler scheduler,
                                                                                               java.lang.String groupName)
                                                                                                    throws java.lang.Exception

Throws:

java.lang.Exception

getScheduler

protected org.quartz.Scheduler getScheduler(java.lang.String groupName)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getStorageType

protected com.liferay.portal.kernel.scheduler.StorageType getStorageType(java.lang.String groupName)

initializeScheduler

protected org.quartz.Scheduler initializeScheduler(java.lang.String propertiesPrefix,
                                       boolean useQuartzCluster)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

initJobState

protected void initJobState()
                     throws java.lang.Exception

Throws:

java.lang.Exception

registerMessageListeners

protected void registerMessageListeners(java.lang.String jobName,
                            java.lang.String groupName,
                            java.lang.String destinationName,
                            com.liferay.portal.kernel.messaging.Message message)
                                 throws com.liferay.portal.kernel.scheduler.SchedulerException

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

schedule

protected void schedule(org.quartz.Scheduler scheduler,
            com.liferay.portal.kernel.scheduler.StorageType storageType,
            org.quartz.Trigger trigger,
            java.lang.String description,
            java.lang.String destinationName,
            com.liferay.portal.kernel.messaging.Message message)
                 throws java.lang.Exception

Throws:

java.lang.Exception

unregisterMessageListener

protected void unregisterMessageListener(org.quartz.Scheduler scheduler,
                             org.quartz.JobKey jobKey)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

unschedule

protected void unschedule(org.quartz.Scheduler scheduler,
              org.quartz.JobKey jobKey)
                   throws java.lang.Exception

Throws:

java.lang.Exception

update

protected void update(org.quartz.Scheduler scheduler,
          com.liferay.portal.kernel.scheduler.Trigger trigger)
               throws java.lang.Exception

Throws:

java.lang.Exception

updateJobState

protected void updateJobState(org.quartz.Scheduler scheduler,
                  org.quartz.JobKey jobKey,
                  com.liferay.portal.kernel.scheduler.TriggerState triggerState,
                  boolean suppressError)
                       throws java.lang.Exception

Throws:

java.lang.Exception