com.liferay.portal.kernel.scheduler

Class SchedulerEngineHelperUtil

Object

com.liferay.portal.kernel.scheduler.SchedulerEngineHelperUtil

public class SchedulerEngineHelperUtil
extends Object

Author:

Michael C. Han

Constructor Summary

Constructors

Constructor and Description
SchedulerEngineHelperUtil()

Method Summary

Modifier and Type	Method and Description
static void	addScriptingJob(Trigger trigger, StorageType storageType, String description, String language, String script, int exceptionsMaxSize)
static void	auditSchedulerJobs(Message message, TriggerState triggerState)
static void	delete(SchedulerEntry schedulerEntry, StorageType storageType)
static void	delete(String groupName, StorageType storageType)
static void	delete(String jobName, String groupName, StorageType storageType)
static String	getCronText(Calendar calendar, boolean timeZoneSensitive)
static String	getCronText(PortletRequest portletRequest, Calendar calendar, boolean timeZoneSensitive, int recurrenceType)
static Date	getEndTime(SchedulerResponse schedulerResponse)
static Date	getEndTime(String jobName, String groupName, StorageType storageType)
static Date	getFinalFireTime(SchedulerResponse schedulerResponse)
static Date	getFinalFireTime(String jobName, String groupName, StorageType storageType)
static ObjectValuePair<Exception,Date>[]	getJobExceptions(SchedulerResponse schedulerResponse)
static ObjectValuePair<Exception,Date>[]	getJobExceptions(String jobName, String groupName, StorageType storageType)
static TriggerState	getJobState(SchedulerResponse schedulerResponse)
static TriggerState	getJobState(String jobName, String groupName, StorageType storageType)
static Date	getNextFireTime(SchedulerResponse schedulerResponse)
static Date	getNextFireTime(String jobName, String groupName, StorageType storageType)
static Date	getPreviousFireTime(SchedulerResponse schedulerResponse)
static Date	getPreviousFireTime(String jobName, String groupName, StorageType storageType)
static SchedulerResponse	getScheduledJob(String jobName, String groupName, StorageType storageType)
static List<SchedulerResponse>	getScheduledJobs()
static List<SchedulerResponse>	getScheduledJobs(StorageType storageType)
static List<SchedulerResponse>	getScheduledJobs(String groupName, StorageType storageType)
static SchedulerEngineHelper	getSchedulerEngineHelper() Deprecated. As of Judson (7.1.x), replaced by _getSchedulerEngineHelper()
static Date	getStartTime(SchedulerResponse schedulerResponse)
static Date	getStartTime(String jobName, String groupName, StorageType storageType)
static void	pause(String groupName, StorageType storageType)
static void	pause(String jobName, String groupName, StorageType storageType)
static void	register(MessageListener messageListener, SchedulerEntry schedulerEntry, String destinationName)
static void	resume(String groupName, StorageType storageType)
static void	resume(String jobName, String groupName, StorageType storageType)
static void	schedule(Trigger trigger, StorageType storageType, String description, String destinationName, Message message, int exceptionsMaxSize)
static void	schedule(Trigger trigger, StorageType storageType, String description, String destinationName, Object payload, int exceptionsMaxSize)
static void	shutdown()
static void	start()
static void	suppressError(String jobName, String groupName, StorageType storageType)
static void	unregister(MessageListener messageListener)
static void	unschedule(SchedulerEntry schedulerEntry, StorageType storageType)
static void	unschedule(String groupName, StorageType storageType)
static void	unschedule(String jobName, String groupName, StorageType storageType)
static void	update(String jobName, String groupName, StorageType storageType, String description, String language, String script, int exceptionsMaxSize)
static void	update(Trigger trigger, StorageType storageType)

Methods inherited from class Object

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

Constructor Detail

SchedulerEngineHelperUtil

public SchedulerEngineHelperUtil()

Method Detail

addScriptingJob

public static void addScriptingJob(Trigger trigger,
                                   StorageType storageType,
                                   String description,
                                   String language,
                                   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(String groupName,
                          StorageType storageType)
                   throws SchedulerException

Throws:

SchedulerException

delete

public static void delete(String jobName,
                          String groupName,
                          StorageType storageType)
                   throws SchedulerException

Throws:

SchedulerException

getCronText

public static String getCronText(Calendar calendar,
                                 boolean timeZoneSensitive)

getCronText

public static String getCronText(PortletRequest portletRequest,
                                 Calendar calendar,
                                 boolean timeZoneSensitive,
                                 int recurrenceType)

getEndTime

public static Date getEndTime(SchedulerResponse schedulerResponse)

getEndTime

public static Date getEndTime(String jobName,
                              String groupName,
                              StorageType storageType)
                       throws SchedulerException

Throws:

SchedulerException

getFinalFireTime

public static Date getFinalFireTime(SchedulerResponse schedulerResponse)

getFinalFireTime

public static Date getFinalFireTime(String jobName,
                                    String groupName,
                                    StorageType storageType)
                             throws SchedulerException

Throws:

SchedulerException

getJobExceptions

public static ObjectValuePair<Exception,Date>[] getJobExceptions(SchedulerResponse schedulerResponse)

getJobExceptions

public static ObjectValuePair<Exception,Date>[] getJobExceptions(String jobName,
                                                                 String groupName,
                                                                 StorageType storageType)
                                                          throws SchedulerException

Throws:

SchedulerException

getJobState

public static TriggerState getJobState(SchedulerResponse schedulerResponse)

getJobState

public static TriggerState getJobState(String jobName,
                                       String groupName,
                                       StorageType storageType)
                                throws SchedulerException

Throws:

SchedulerException

getNextFireTime

public static Date getNextFireTime(SchedulerResponse schedulerResponse)

getNextFireTime

public static Date getNextFireTime(String jobName,
                                   String groupName,
                                   StorageType storageType)
                            throws SchedulerException

Throws:

SchedulerException

getPreviousFireTime

public static Date getPreviousFireTime(SchedulerResponse schedulerResponse)

getPreviousFireTime

public static Date getPreviousFireTime(String jobName,
                                       String groupName,
                                       StorageType storageType)
                                throws SchedulerException

Throws:

SchedulerException

getScheduledJob

public static SchedulerResponse getScheduledJob(String jobName,
                                                String groupName,
                                                StorageType storageType)
                                         throws SchedulerException

Throws:

SchedulerException

getScheduledJobs

public static List<SchedulerResponse> getScheduledJobs()
                                                throws SchedulerException

Throws:

SchedulerException

getScheduledJobs

public static List<SchedulerResponse> getScheduledJobs(StorageType storageType)
                                                throws SchedulerException

Throws:

SchedulerException

getScheduledJobs

public static List<SchedulerResponse> getScheduledJobs(String groupName,
                                                       StorageType storageType)
                                                throws SchedulerException

Throws:

SchedulerException

getSchedulerEngineHelper

@Deprecated
public static SchedulerEngineHelper getSchedulerEngineHelper()

Deprecated. As of Judson (7.1.x), replaced by _getSchedulerEngineHelper()

getStartTime

public static Date getStartTime(SchedulerResponse schedulerResponse)

getStartTime

public static Date getStartTime(String jobName,
                                String groupName,
                                StorageType storageType)
                         throws SchedulerException

Throws:

SchedulerException

pause

public static void pause(String groupName,
                         StorageType storageType)
                  throws SchedulerException

Throws:

SchedulerException

pause

public static void pause(String jobName,
                         String groupName,
                         StorageType storageType)
                  throws SchedulerException

Throws:

SchedulerException

register

public static void register(MessageListener messageListener,
                            SchedulerEntry schedulerEntry,
                            String destinationName)

resume

public static void resume(String groupName,
                          StorageType storageType)
                   throws SchedulerException

Throws:

SchedulerException

resume

public static void resume(String jobName,
                          String groupName,
                          StorageType storageType)
                   throws SchedulerException

Throws:

SchedulerException

schedule

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

Throws:

SchedulerException

schedule

public static void schedule(Trigger trigger,
                            StorageType storageType,
                            String description,
                            String destinationName,
                            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(String jobName,
                                 String groupName,
                                 StorageType storageType)
                          throws SchedulerException

Throws:

SchedulerException

unregister

public static void unregister(MessageListener messageListener)

unschedule

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

Throws:

SchedulerException

unschedule

public static void unschedule(String groupName,
                              StorageType storageType)
                       throws SchedulerException

Throws:

SchedulerException

unschedule

public static void unschedule(String jobName,
                              String groupName,
                              StorageType storageType)
                       throws SchedulerException

Throws:

SchedulerException

update

public static void update(String jobName,
                          String groupName,
                          StorageType storageType,
                          String description,
                          String language,
                          String script,
                          int exceptionsMaxSize)
                   throws SchedulerException

Throws:

SchedulerException

update

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

Throws:

SchedulerException