Class AsyncJobManager

java.lang.Object

com.kingsrook.qqq.backend.core.actions.async.AsyncJobManager

public class AsyncJobManager
extends Object

Class to manage running asynchronous actions, and working with their statuses.

Constructor Summary

Constructors

Constructor	Description
AsyncJobManager()

Method Summary

Modifier and Type	Method	Description
void	cancelJob(String jobUUID)
String	getForcedJobUUID()	Getter for forcedJobUUID
Optional<AsyncJobStatus>	getJobStatus(String uuid)	Get the status of the job identified by the given UUID.
Optional<AsyncJobStatus>	getJobStatusForUser(String uuid, String processName, String processUUID)	Check ownership even while the process has not produced any state yet.
void	setForcedJobUUID(String forcedJobUUID)	Setter for forcedJobUUID
<T extends Serializable> T	startJob(long timeout, TimeUnit timeUnit, AsyncJob<T> asyncJob)	Start a job - if it finishes within the specified timeout, get its results, else, get back an exception with the job id.
<T extends Serializable> String	startJob(AsyncJob<T> asyncJob)	Start a job, and always, just get back the job UUID.
<T extends Serializable> T	startJob(String jobName, long timeout, TimeUnit timeUnit, AsyncJob<T> asyncJob)	Start a job - if it finishes within the specified timeout, get its results, else, get back an exception with the job id.
<T extends Serializable> String	startJob(String jobName, AsyncJob<T> asyncJob)	Start a job, and always, just get back the job UUID.
AsyncJobManager	withForcedJobUUID(String forcedJobUUID)	Fluent setter for forcedJobUUID
AsyncJobManager	withProcessUUID(String processUUID)	Bind a user-facing job to the process whose state it produces.

Methods inherited from class java.lang.Object

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

Constructor Details

AsyncJobManager

public AsyncJobManager()

Method Details

startJob

public <T extends Serializable> T startJob(long timeout,
 TimeUnit timeUnit,
 AsyncJob<T> asyncJob)
                                    throws JobGoingAsyncException,
QException

Start a job - if it finishes within the specified timeout, get its results, else, get back an exception with the job id.

Throws:

JobGoingAsyncException

QException

startJob

public <T extends Serializable> T startJob(String jobName,
 long timeout,
 TimeUnit timeUnit,
 AsyncJob<T> asyncJob)
                                    throws JobGoingAsyncException,
QException

Start a job - if it finishes within the specified timeout, get its results, else, get back an exception with the job id.

Throws:

JobGoingAsyncException

QException

startJob

public <T extends Serializable> String startJob(AsyncJob<T> asyncJob)
                                         throws QException

Start a job, and always, just get back the job UUID.

Throws:

QException

startJob

public <T extends Serializable> String startJob(String jobName,
 AsyncJob<T> asyncJob)
                                         throws QException

Start a job, and always, just get back the job UUID.

Throws:

QException

getJobStatus

public Optional<AsyncJobStatus> getJobStatus(String uuid)

Get the status of the job identified by the given UUID.

withProcessUUID

public AsyncJobManager withProcessUUID(String processUUID)

Bind a user-facing job to the process whose state it produces.

getJobStatusForUser

public Optional<AsyncJobStatus> getJobStatusForUser(String uuid,
 String processName,
 String processUUID)
                                             throws QException

Check ownership even while the process has not produced any state yet.

Throws:

QException

cancelJob

public void cancelJob(String jobUUID)

getForcedJobUUID

public String getForcedJobUUID()

Getter for forcedJobUUID

setForcedJobUUID

public void setForcedJobUUID(String forcedJobUUID)

Setter for forcedJobUUID

withForcedJobUUID

public AsyncJobManager withForcedJobUUID(String forcedJobUUID)

Fluent setter for forcedJobUUID