com.helger.photon.basic.longrun

Class AbstractLongRunningJob

java.lang.Object

com.helger.schedule.job.AbstractJob

com.helger.photon.basic.longrun.AbstractLongRunningJob

All Implemented Interfaces:

ILongRunningJob, org.quartz.Job

public abstract class AbstractLongRunningJob
extends com.helger.schedule.job.AbstractJob
implements ILongRunningJob

Abstract long running job.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AbstractLongRunningJob()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterExecute(org.quartz.JobDataMap aJobDataMap, org.quartz.JobExecutionContext aContext, com.helger.commons.state.ESuccess eExecSuccess)
protected void	beforeExecute(org.quartz.JobDataMap aJobDataMap, org.quartz.JobExecutionContext aContext)
protected abstract String	getCurrentUserID(org.quartz.JobDataMap aJobDataMap) Get the ID of the current user who executes the job.
protected LongRunningJobManager	getLongRunningJobManager()

Methods inherited from class com.helger.schedule.job.AbstractJob

execute, getExceptionCallbacks, onExecute, triggerCustomExceptionHandler

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.photon.basic.longrun.ILongRunningJob

createLongRunningJobResult, getJobDescription

Methods inherited from interface org.quartz.Job

execute

Constructor Detail

AbstractLongRunningJob

public AbstractLongRunningJob()

Method Detail

getCurrentUserID

@Nullable
protected abstract String getCurrentUserID(@Nonnull
                               org.quartz.JobDataMap aJobDataMap)

Get the ID of the current user who executes the job.

Parameters:

aJobDataMap - The current job data map. Never null.

Returns:

The user ID to be used. May be null but it is recommended to deliver "guest" or the like instead.

getLongRunningJobManager

@Nonnull
protected final LongRunningJobManager getLongRunningJobManager()

beforeExecute

@OverridingMethodsMustInvokeSuper
protected void beforeExecute(@Nonnull
                                                  org.quartz.JobDataMap aJobDataMap,
                                                  @Nonnull
                                                  org.quartz.JobExecutionContext aContext)

Overrides:

beforeExecute in class com.helger.schedule.job.AbstractJob

afterExecute

@OverridingMethodsMustInvokeSuper
protected void afterExecute(@Nonnull
                                                 org.quartz.JobDataMap aJobDataMap,
                                                 @Nonnull
                                                 org.quartz.JobExecutionContext aContext,
                                                 @Nonnull
                                                 com.helger.commons.state.ESuccess eExecSuccess)

Overrides:

afterExecute in class com.helger.schedule.job.AbstractJob