Package org.jobrunr.jobs

Class Job

java.lang.Object

org.jobrunr.jobs.AbstractJob

org.jobrunr.jobs.Job

All Implemented Interfaces:

Lockable

public class Job
extends AbstractJob

Defines the job with its JobDetails, History and Job Metadata. Note: Jobs are managed by JobRunr and may under no circumstances be updated during Job Processing. They may be deleted though.

During Job Processing, JobRunr updates the job every x amount of seconds (where x is the pollIntervalInSeconds and defaults to 15s) to distinguish running jobs from orphaned jobs (orphaned jobs are jobs that have the state in PROGRESS but are not running anymore due to JVM or container crash).

Field Summary

Fields

Modifier and Type	Field	Description
static Map<String,Function<Job,Comparable>>	ALLOWED_SORT_COLUMNS

Constructor Summary

Constructors

Constructor	Description
Job(UUID id, int version, JobDetails jobDetails, List<JobState> jobHistory, ConcurrentMap<String,Object> metadata)
Job(UUID id, JobDetails jobDetails)
Job(UUID id, JobDetails jobDetails, JobState jobState)
Job(JobDetails jobDetails)
Job(JobDetails jobDetails, JobState jobState)

Method Summary

Modifier and Type	Method	Description
Job	delete(String reason)
void	enqueue()
Job	failed(String message, Exception exception)
Instant	getCreatedAt()
UUID	getId()
<T extends JobState> T	getJobState()
JobState	getJobState(int element)
List<JobState>	getJobStates()
<T extends JobState> Stream<T>	getJobStatesOfType(Class<T> clazz)
<T extends JobState> Optional<T>	getLastJobStateOfType(Class<T> clazz)
Map<String,Object>	getMetadata()
Optional<String>	getRecurringJobId()
StateName	getState()
List<JobState>	getStateChangesForJobFilters()	This method is only to be called by JobRunr itself.
Instant	getUpdatedAt()
boolean	hasState(StateName state)
boolean	hasStateChange()
static UUID	newUUID()
void	scheduleAt(Instant instant, String reason)
void	setRecurringJobId(String recurringJobId)
void	startProcessingOn(BackgroundJobServer backgroundJobServer)
Job	succeeded()
String	toString()
Job	updateProcessing()

Methods inherited from class org.jobrunr.jobs.AbstractJob

getAmountOfRetries, getJobDetails, getJobName, getJobSignature, getLabels, getVersion, lock, setAmountOfRetries, setJobName, setLabels

Methods inherited from class java.lang.Object

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

Field Details

ALLOWED_SORT_COLUMNS

public static Map<String,Function<Job,Comparable>> ALLOWED_SORT_COLUMNS

Constructor Details

Job

public Job(JobDetails jobDetails)

Job

public Job(UUID id,
 JobDetails jobDetails)

Job

public Job(JobDetails jobDetails,
 JobState jobState)

Job

public Job(UUID id,
 JobDetails jobDetails,
 JobState jobState)

Job

public Job(UUID id,
 int version,
 JobDetails jobDetails,
 List<JobState> jobHistory,
 ConcurrentMap<String,Object> metadata)

Method Details

newUUID

public static UUID newUUID()

getId

public UUID getId()

Specified by:

getId in class AbstractJob

setRecurringJobId

public void setRecurringJobId(String recurringJobId)

getRecurringJobId

public Optional<String> getRecurringJobId()

getJobStates

public List<JobState> getJobStates()

getJobStatesOfType

public <T extends JobState> Stream<T> getJobStatesOfType(Class<T> clazz)

getLastJobStateOfType

public <T extends JobState> Optional<T> getLastJobStateOfType(Class<T> clazz)

getJobState

public <T extends JobState> T getJobState()

getJobState

public JobState getJobState(int element)

getState

public StateName getState()

hasState

public boolean hasState(StateName state)

hasStateChange

public boolean hasStateChange()

getStateChangesForJobFilters

public List<JobState> getStateChangesForJobFilters()

This method is only to be called by JobRunr itself. It may not be called externally as it will break the JobFilters

Returns:

all the stateChanges since they were last retrieved.

enqueue

public void enqueue()

scheduleAt

public void scheduleAt(Instant instant,
 String reason)

startProcessingOn

public void startProcessingOn(BackgroundJobServer backgroundJobServer)

updateProcessing

public Job updateProcessing()

succeeded

public Job succeeded()

failed

public Job failed(String message,
 Exception exception)

delete

public Job delete(String reason)

getCreatedAt

public Instant getCreatedAt()

getUpdatedAt

public Instant getUpdatedAt()

getMetadata

public Map<String,Object> getMetadata()

toString

public String toString()

Overrides:

toString in class Object