com.helger.photon.basic.longrun

Class AbstractScopeAwareLongRunningJob

java.lang.Object

com.helger.schedule.job.AbstractJob

com.helger.schedule.job.AbstractScopeAwareJob

com.helger.photon.basic.longrun.AbstractScopeAwareLongRunningJob

All Implemented Interfaces:

ILongRunningJob, org.quartz.Job

public abstract class AbstractScopeAwareLongRunningJob
extends com.helger.schedule.job.AbstractScopeAwareJob
implements ILongRunningJob

Abstract scope aware long running job.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AbstractScopeAwareLongRunningJob()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterExecuteInScope(org.quartz.JobDataMap aJobDataMap, org.quartz.JobExecutionContext aContext, com.helger.commons.state.ESuccess eExecSuccess)
protected void	beforeExecuteInScope(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.AbstractScopeAwareJob

afterExecute, beforeExecute, createMockHttpServletRequest, createMockHttpServletResponse, getApplicationScopeID

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

AbstractScopeAwareLongRunningJob

public AbstractScopeAwareLongRunningJob()

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()

Returns:

The LongRunningJobManager to be used. May not return null.

beforeExecuteInScope

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

Overrides:

beforeExecuteInScope in class com.helger.schedule.job.AbstractScopeAwareJob

afterExecuteInScope

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

Overrides:

afterExecuteInScope in class com.helger.schedule.job.AbstractScopeAwareJob