com.liferay.portal.scheduler

Class ClusterSchedulerEngine

java.lang.Object

com.liferay.portal.scheduler.ClusterSchedulerEngine

All Implemented Interfaces:

com.liferay.portal.kernel.bean.IdentifiableBean, com.liferay.portal.kernel.scheduler.SchedulerEngine, com.liferay.portal.kernel.scheduler.SchedulerEngineClusterManager

public class ClusterSchedulerEngine
extends java.lang.Object
implements com.liferay.portal.kernel.bean.IdentifiableBean, com.liferay.portal.kernel.scheduler.SchedulerEngine, com.liferay.portal.kernel.scheduler.SchedulerEngineClusterManager

Author:

Tina Tian

Field Summary

Fields

Modifier and Type	Field and Description
protected com.liferay.portal.kernel.scheduler.SchedulerEngine	schedulerEngine

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
ClusterSchedulerEngine(com.liferay.portal.kernel.scheduler.SchedulerEngine schedulerEngine)

Method Summary

Methods

Modifier and Type	Method and Description
protected <T> T	callMaster(java.lang.String masterAddressString, com.liferay.portal.kernel.util.MethodKey methodKey, java.lang.Object... arguments)
static com.liferay.portal.kernel.scheduler.SchedulerEngine	createClusterSchedulerEngine(com.liferay.portal.kernel.scheduler.SchedulerEngine schedulerEngine)
void	delete(java.lang.String groupName)
void	delete(java.lang.String jobName, java.lang.String groupName)
java.lang.String	getBeanIdentifier()
protected java.lang.String	getFullName(java.lang.String jobName, java.lang.String groupName)
protected java.lang.String	getMasterAddressString(boolean asynchronous)
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()
java.util.List<com.liferay.portal.kernel.scheduler.messaging.SchedulerResponse>	getScheduledJobs(java.lang.String groupName)
void	initialize()
protected void	initMemoryClusteredJobs(java.util.List<com.liferay.portal.kernel.scheduler.messaging.SchedulerResponse> schedulerResponses)
protected boolean	isMemoryClusteredSlaveJob(java.lang.String groupName)
protected void	masterToSlave(java.lang.String masterAddressString, boolean asynchronous)
void	pause(java.lang.String groupName)
void	pause(java.lang.String jobName, java.lang.String groupName)
protected void	removeMemoryClusteredJobs(java.lang.String groupName)
protected com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,com.liferay.portal.kernel.scheduler.StorageType>	resolveGroupName(java.lang.String groupName)
void	resume(java.lang.String groupName)
void	resume(java.lang.String jobName, java.lang.String groupName)
void	schedule(com.liferay.portal.kernel.scheduler.Trigger trigger, java.lang.String description, java.lang.String destinationName, com.liferay.portal.kernel.messaging.Message message)
void	setBeanIdentifier(java.lang.String beanIdentifier)
protected void	setClusterableThreadLocal(java.lang.String groupName)
void	shutdown()
protected void	slaveToMaster()
void	start()
void	suppressError(java.lang.String jobName, java.lang.String groupName)
void	unschedule(java.lang.String groupName)
void	unschedule(java.lang.String jobName, java.lang.String groupName)
void	update(com.liferay.portal.kernel.scheduler.Trigger trigger)
protected void	updateMemoryClusteredJob(java.lang.String jobName, java.lang.String groupName, com.liferay.portal.kernel.scheduler.TriggerState triggerState)
protected void	updateMemoryClusteredJobs(java.lang.String groupName, com.liferay.portal.kernel.scheduler.TriggerState triggerState)
com.liferay.portal.model.Lock	updateMemorySchedulerClusterMaster()

Methods inherited from class java.lang.Object

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

Field Detail

schedulerEngine

@BeanReference(name="com.liferay.portal.scheduler.ClusterSchedulerEngineService")
protected com.liferay.portal.kernel.scheduler.SchedulerEngine schedulerEngine

Constructor Detail

ClusterSchedulerEngine

public ClusterSchedulerEngine(com.liferay.portal.kernel.scheduler.SchedulerEngine schedulerEngine)

Method Detail

createClusterSchedulerEngine

public static com.liferay.portal.kernel.scheduler.SchedulerEngine createClusterSchedulerEngine(com.liferay.portal.kernel.scheduler.SchedulerEngine schedulerEngine)

delete

@Clusterable(acceptor=com.liferay.portal.scheduler.ClusterSchedulerEngine.SchedulerClusterInvokeAcceptor.class)
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

@Clusterable(acceptor=com.liferay.portal.scheduler.ClusterSchedulerEngine.SchedulerClusterInvokeAcceptor.class)
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

getBeanIdentifier

public java.lang.String getBeanIdentifier()

Specified by:

getBeanIdentifier in interface com.liferay.portal.kernel.bean.IdentifiableBean

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

initialize

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

Specified by:

initialize in interface com.liferay.portal.kernel.scheduler.SchedulerEngineClusterManager

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

pause

@Clusterable(acceptor=com.liferay.portal.scheduler.ClusterSchedulerEngine.SchedulerClusterInvokeAcceptor.class)
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

@Clusterable(acceptor=com.liferay.portal.scheduler.ClusterSchedulerEngine.SchedulerClusterInvokeAcceptor.class)
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

@Clusterable(acceptor=com.liferay.portal.scheduler.ClusterSchedulerEngine.SchedulerClusterInvokeAcceptor.class)
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

@Clusterable(acceptor=com.liferay.portal.scheduler.ClusterSchedulerEngine.SchedulerClusterInvokeAcceptor.class)
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

@Clusterable(acceptor=com.liferay.portal.scheduler.ClusterSchedulerEngine.SchedulerClusterInvokeAcceptor.class)
public void schedule(com.liferay.portal.kernel.scheduler.Trigger trigger,
                                                                                                                java.lang.String description,
                                                                                                                java.lang.String destinationName,
                                                                                                                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

setBeanIdentifier

public void setBeanIdentifier(java.lang.String beanIdentifier)

Specified by:

setBeanIdentifier in interface com.liferay.portal.kernel.bean.IdentifiableBean

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

@Clusterable(acceptor=com.liferay.portal.scheduler.ClusterSchedulerEngine.SchedulerClusterInvokeAcceptor.class)
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

@Clusterable(acceptor=com.liferay.portal.scheduler.ClusterSchedulerEngine.SchedulerClusterInvokeAcceptor.class)
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

@Clusterable(acceptor=com.liferay.portal.scheduler.ClusterSchedulerEngine.SchedulerClusterInvokeAcceptor.class)
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

@Clusterable(acceptor=com.liferay.portal.scheduler.ClusterSchedulerEngine.SchedulerClusterInvokeAcceptor.class)
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

updateMemorySchedulerClusterMaster

public com.liferay.portal.model.Lock updateMemorySchedulerClusterMaster()
                                                                 throws com.liferay.portal.kernel.scheduler.SchedulerException

Specified by:

updateMemorySchedulerClusterMaster in interface com.liferay.portal.kernel.scheduler.SchedulerEngineClusterManager

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

callMaster

protected <T> T callMaster(java.lang.String masterAddressString,
               com.liferay.portal.kernel.util.MethodKey methodKey,
               java.lang.Object... arguments)
                throws com.liferay.portal.kernel.scheduler.SchedulerException

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

getFullName

protected java.lang.String getFullName(java.lang.String jobName,
                           java.lang.String groupName)

getMasterAddressString

protected java.lang.String getMasterAddressString(boolean asynchronous)
                                           throws com.liferay.portal.kernel.scheduler.SchedulerException

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

initMemoryClusteredJobs

protected void initMemoryClusteredJobs(java.util.List<com.liferay.portal.kernel.scheduler.messaging.SchedulerResponse> schedulerResponses)
                                throws java.lang.Exception

Throws:

java.lang.Exception

isMemoryClusteredSlaveJob

protected boolean isMemoryClusteredSlaveJob(java.lang.String groupName)
                                     throws com.liferay.portal.kernel.scheduler.SchedulerException

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

masterToSlave

protected void masterToSlave(java.lang.String masterAddressString,
                 boolean asynchronous)
                      throws com.liferay.portal.kernel.scheduler.SchedulerException

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

removeMemoryClusteredJobs

protected void removeMemoryClusteredJobs(java.lang.String groupName)

resolveGroupName

protected com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,com.liferay.portal.kernel.scheduler.StorageType> resolveGroupName(java.lang.String groupName)

setClusterableThreadLocal

protected void setClusterableThreadLocal(java.lang.String groupName)

slaveToMaster

protected void slaveToMaster()
                      throws com.liferay.portal.kernel.scheduler.SchedulerException

Throws:

com.liferay.portal.kernel.scheduler.SchedulerException

updateMemoryClusteredJob

protected void updateMemoryClusteredJob(java.lang.String jobName,
                            java.lang.String groupName,
                            com.liferay.portal.kernel.scheduler.TriggerState triggerState)

updateMemoryClusteredJobs

protected void updateMemoryClusteredJobs(java.lang.String groupName,
                             com.liferay.portal.kernel.scheduler.TriggerState triggerState)