com.helger.photon.basic.longrun

Class LongRunningJobManager

java.lang.Object

com.helger.photon.basic.longrun.LongRunningJobManager

@ThreadSafe
public final class LongRunningJobManager
extends Object

Constructor Summary

Constructors

Constructor and Description
LongRunningJobManager(LongRunningJobResultManager aResultMgr)

Method Summary

Modifier and Type	Method and Description
com.helger.commons.collection.ext.ICommonsCollection<LongRunningJobData>	getAllRunningJobs()
int	getRunningJobCount()
void	onEndJob(String sJobID, com.helger.commons.state.ESuccess eExecSucess, LongRunningJobResult aResult) End a job.
String	onStartJob(ILongRunningJob aJob, String sStartingUserID) Start a long running job
void	waitUntilAllJobsAreFinished()

Methods inherited from class java.lang.Object

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

Constructor Detail

LongRunningJobManager

public LongRunningJobManager(@Nonnull
                             LongRunningJobResultManager aResultMgr)

Method Detail

onStartJob

@Nonnull
 @Nonempty
public String onStartJob(@Nonnull
                                               ILongRunningJob aJob,
                                               @Nullable
                                               String sStartingUserID)

Start a long running job

Parameters:

aJob - The job that is to be started

sStartingUserID - The ID of the user who started the job

Returns:

The internal long running job ID

onEndJob

public void onEndJob(@Nullable
                     String sJobID,
                     @Nonnull
                     com.helger.commons.state.ESuccess eExecSucess,
                     @Nonnull
                     LongRunningJobResult aResult)

End a job.

Parameters:

sJobID - The internal long running job ID created from onStartJob(ILongRunningJob,String).

eExecSucess - Was the job execution successful or not from a technical point of view? May not be null. If a JobExecutionException was thrown, this should be ESuccess.FAILURE.

aResult - The main job results.

getRunningJobCount

@Nonnegative
public int getRunningJobCount()

getAllRunningJobs

@Nonnull
 @Nonempty
public com.helger.commons.collection.ext.ICommonsCollection<LongRunningJobData> getAllRunningJobs()

waitUntilAllJobsAreFinished

public void waitUntilAllJobsAreFinished()
                                 throws InterruptedException

Throws:

InterruptedException