com.liferay.portal.kernel.scheduler
Class SchedulerEngineUtil

java.lang.Object
  extended by com.liferay.portal.kernel.scheduler.SchedulerEngineUtil

public class SchedulerEngineUtil
extends java.lang.Object

Author:
Bruno Farache, Shuyang Zhou, Tina Tian, Raymond Augé

Constructor Summary
SchedulerEngineUtil()
           
 
Method Summary
static void addJob(Trigger trigger, StorageType storageType, java.lang.String description, java.lang.String destinationName, Message message, java.lang.String messageListenerClassName, java.lang.String portletId, int exceptionsMaxSize)
           
static void addJob(Trigger trigger, StorageType storageType, java.lang.String description, java.lang.String destinationName, java.lang.Object payload, java.lang.String messageListenerClassName, java.lang.String portletId, int exceptionsMaxSize)
           
static void addScriptingJob(Trigger trigger, StorageType storageType, java.lang.String description, java.lang.String language, java.lang.String script, int exceptionsMaxSize)
           
static void auditSchedulerJobs(Message message, TriggerState triggerState)
           
static void delete(SchedulerEntry schedulerEntry, StorageType storageType)
           
static void delete(java.lang.String groupName, StorageType storageType)
           
static void delete(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
           
static java.lang.String getCronText(java.util.Calendar calendar, boolean timeZoneSensitive)
           
static java.lang.String getCronText(javax.portlet.PortletRequest portletRequest, java.util.Calendar calendar, boolean timeZoneSensitive, int recurrenceType)
           
static java.util.Date getEndTime(SchedulerResponse schedulerResponse)
           
static java.util.Date getEndTime(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
           
static java.util.Date getFinalFireTime(SchedulerResponse schedulerResponse)
           
static java.util.Date getFinalFireTime(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
           
static SchedulerEngineUtil getInstance()
           
static ObjectValuePair<java.lang.Exception,java.util.Date>[] getJobExceptions(SchedulerResponse schedulerResponse)
           
static ObjectValuePair<java.lang.Exception,java.util.Date>[] getJobExceptions(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
           
static TriggerState getJobState(SchedulerResponse schedulerResponse)
           
static TriggerState getJobState(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
           
static java.util.Date getNextFireTime(SchedulerResponse schedulerResponse)
           
static java.util.Date getNextFireTime(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
           
static java.util.Date getPreviousFireTime(SchedulerResponse schedulerResponse)
           
static java.util.Date getPreviousFireTime(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
           
static SchedulerResponse getScheduledJob(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
           
static java.util.List<SchedulerResponse> getScheduledJobs()
           
static java.util.List<SchedulerResponse> getScheduledJobs(StorageType storageType)
           
static java.util.List<SchedulerResponse> getScheduledJobs(java.lang.String groupName, StorageType storageType)
           
static java.util.Date getStartTime(SchedulerResponse schedulerResponse)
           
static java.util.Date getStartTime(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
           
static void initialize()
           
static java.lang.String namespaceGroupName(java.lang.String groupName, StorageType storageType)
           
static void pause(java.lang.String groupName, StorageType storageType)
           
static void pause(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
           
static void resume(java.lang.String groupName, StorageType storageType)
           
static void resume(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
           
static void schedule(SchedulerEntry schedulerEntry, StorageType storageType, java.lang.String portletId, int exceptionsMaxSize)
           
static void schedule(Trigger trigger, StorageType storageType, java.lang.String description, java.lang.String destinationName, Message message, int exceptionsMaxSize)
           
static void schedule(Trigger trigger, StorageType storageType, java.lang.String description, java.lang.String destinationName, java.lang.Object payload, int exceptionsMaxSize)
           
 void setSchedulerEngine(SchedulerEngine schedulerEngine)
           
static void shutdown()
           
static void start()
           
static void suppressError(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
           
static void unschedule(SchedulerEntry schedulerEntry, StorageType storageType)
           
static void unschedule(java.lang.String groupName, StorageType storageType)
           
static void unschedule(java.lang.String jobName, java.lang.String groupName, StorageType storageType)
           
static void update(java.lang.String jobName, java.lang.String groupName, StorageType storageType, java.lang.String description, java.lang.String language, java.lang.String script, int exceptionsMaxSize)
           
static void update(Trigger trigger, StorageType storageType)
           
static void updateMemorySchedulerClusterMaster()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SchedulerEngineUtil

public SchedulerEngineUtil()
Method Detail

addJob

public static void addJob(Trigger trigger,
                          StorageType storageType,
                          java.lang.String description,
                          java.lang.String destinationName,
                          Message message,
                          java.lang.String messageListenerClassName,
                          java.lang.String portletId,
                          int exceptionsMaxSize)
                   throws SchedulerException
Throws:
SchedulerException

addJob

public static void addJob(Trigger trigger,
                          StorageType storageType,
                          java.lang.String description,
                          java.lang.String destinationName,
                          java.lang.Object payload,
                          java.lang.String messageListenerClassName,
                          java.lang.String portletId,
                          int exceptionsMaxSize)
                   throws SchedulerException
Throws:
SchedulerException

addScriptingJob

public static void addScriptingJob(Trigger trigger,
                                   StorageType storageType,
                                   java.lang.String description,
                                   java.lang.String language,
                                   java.lang.String script,
                                   int exceptionsMaxSize)
                            throws SchedulerException
Throws:
SchedulerException

auditSchedulerJobs

public static void auditSchedulerJobs(Message message,
                                      TriggerState triggerState)
                               throws SchedulerException
Throws:
SchedulerException

delete

public static void delete(SchedulerEntry schedulerEntry,
                          StorageType storageType)
                   throws SchedulerException
Throws:
SchedulerException

delete

public static void delete(java.lang.String groupName,
                          StorageType storageType)
                   throws SchedulerException
Throws:
SchedulerException

delete

public static void delete(java.lang.String jobName,
                          java.lang.String groupName,
                          StorageType storageType)
                   throws SchedulerException
Throws:
SchedulerException

getCronText

public static java.lang.String getCronText(java.util.Calendar calendar,
                                           boolean timeZoneSensitive)

getCronText

public static java.lang.String getCronText(javax.portlet.PortletRequest portletRequest,
                                           java.util.Calendar calendar,
                                           boolean timeZoneSensitive,
                                           int recurrenceType)

getEndTime

public static java.util.Date getEndTime(SchedulerResponse schedulerResponse)

getEndTime

public static java.util.Date getEndTime(java.lang.String jobName,
                                        java.lang.String groupName,
                                        StorageType storageType)
                                 throws SchedulerException
Throws:
SchedulerException

getFinalFireTime

public static java.util.Date getFinalFireTime(SchedulerResponse schedulerResponse)

getFinalFireTime

public static java.util.Date getFinalFireTime(java.lang.String jobName,
                                              java.lang.String groupName,
                                              StorageType storageType)
                                       throws SchedulerException
Throws:
SchedulerException

getInstance

public static SchedulerEngineUtil getInstance()

getJobExceptions

public static ObjectValuePair<java.lang.Exception,java.util.Date>[] getJobExceptions(SchedulerResponse schedulerResponse)

getJobExceptions

public static ObjectValuePair<java.lang.Exception,java.util.Date>[] getJobExceptions(java.lang.String jobName,
                                                                                     java.lang.String groupName,
                                                                                     StorageType storageType)
                                                                              throws SchedulerException
Throws:
SchedulerException

getJobState

public static TriggerState getJobState(SchedulerResponse schedulerResponse)

getJobState

public static TriggerState getJobState(java.lang.String jobName,
                                       java.lang.String groupName,
                                       StorageType storageType)
                                throws SchedulerException
Throws:
SchedulerException

getNextFireTime

public static java.util.Date getNextFireTime(SchedulerResponse schedulerResponse)

getNextFireTime

public static java.util.Date getNextFireTime(java.lang.String jobName,
                                             java.lang.String groupName,
                                             StorageType storageType)
                                      throws SchedulerException
Throws:
SchedulerException

getPreviousFireTime

public static java.util.Date getPreviousFireTime(SchedulerResponse schedulerResponse)

getPreviousFireTime

public static java.util.Date getPreviousFireTime(java.lang.String jobName,
                                                 java.lang.String groupName,
                                                 StorageType storageType)
                                          throws SchedulerException
Throws:
SchedulerException

getScheduledJob

public static SchedulerResponse getScheduledJob(java.lang.String jobName,
                                                java.lang.String groupName,
                                                StorageType storageType)
                                         throws SchedulerException
Throws:
SchedulerException

getScheduledJobs

public static java.util.List<SchedulerResponse> getScheduledJobs()
                                                          throws SchedulerException
Throws:
SchedulerException

getScheduledJobs

public static java.util.List<SchedulerResponse> getScheduledJobs(StorageType storageType)
                                                          throws SchedulerException
Throws:
SchedulerException

getScheduledJobs

public static java.util.List<SchedulerResponse> getScheduledJobs(java.lang.String groupName,
                                                                 StorageType storageType)
                                                          throws SchedulerException
Throws:
SchedulerException

getStartTime

public static java.util.Date getStartTime(SchedulerResponse schedulerResponse)

getStartTime

public static java.util.Date getStartTime(java.lang.String jobName,
                                          java.lang.String groupName,
                                          StorageType storageType)
                                   throws SchedulerException
Throws:
SchedulerException

initialize

public static void initialize()
                       throws SchedulerException
Throws:
SchedulerException

namespaceGroupName

public static java.lang.String namespaceGroupName(java.lang.String groupName,
                                                  StorageType storageType)

pause

public static void pause(java.lang.String groupName,
                         StorageType storageType)
                  throws SchedulerException
Throws:
SchedulerException

pause

public static void pause(java.lang.String jobName,
                         java.lang.String groupName,
                         StorageType storageType)
                  throws SchedulerException
Throws:
SchedulerException

resume

public static void resume(java.lang.String groupName,
                          StorageType storageType)
                   throws SchedulerException
Throws:
SchedulerException

resume

public static void resume(java.lang.String jobName,
                          java.lang.String groupName,
                          StorageType storageType)
                   throws SchedulerException
Throws:
SchedulerException

schedule

public static void schedule(SchedulerEntry schedulerEntry,
                            StorageType storageType,
                            java.lang.String portletId,
                            int exceptionsMaxSize)
                     throws SchedulerException
Throws:
SchedulerException

schedule

public static void schedule(Trigger trigger,
                            StorageType storageType,
                            java.lang.String description,
                            java.lang.String destinationName,
                            Message message,
                            int exceptionsMaxSize)
                     throws SchedulerException
Throws:
SchedulerException

schedule

public static void schedule(Trigger trigger,
                            StorageType storageType,
                            java.lang.String description,
                            java.lang.String destinationName,
                            java.lang.Object payload,
                            int exceptionsMaxSize)
                     throws SchedulerException
Throws:
SchedulerException

shutdown

public static void shutdown()
                     throws SchedulerException
Throws:
SchedulerException

start

public static void start()
                  throws SchedulerException
Throws:
SchedulerException

suppressError

public static void suppressError(java.lang.String jobName,
                                 java.lang.String groupName,
                                 StorageType storageType)
                          throws SchedulerException
Throws:
SchedulerException

unschedule

public static void unschedule(SchedulerEntry schedulerEntry,
                              StorageType storageType)
                       throws SchedulerException
Throws:
SchedulerException

unschedule

public static void unschedule(java.lang.String groupName,
                              StorageType storageType)
                       throws SchedulerException
Throws:
SchedulerException

unschedule

public static void unschedule(java.lang.String jobName,
                              java.lang.String groupName,
                              StorageType storageType)
                       throws SchedulerException
Throws:
SchedulerException

update

public static void update(java.lang.String jobName,
                          java.lang.String groupName,
                          StorageType storageType,
                          java.lang.String description,
                          java.lang.String language,
                          java.lang.String script,
                          int exceptionsMaxSize)
                   throws SchedulerException
Throws:
SchedulerException

update

public static void update(Trigger trigger,
                          StorageType storageType)
                   throws SchedulerException
Throws:
SchedulerException

updateMemorySchedulerClusterMaster

public static void updateMemorySchedulerClusterMaster()
                                               throws SchedulerException
Throws:
SchedulerException

setSchedulerEngine

public void setSchedulerEngine(SchedulerEngine schedulerEngine)