Package org.axonframework.deadline.jobrunr

Class DeadlineDetails

java.lang.Object

org.axonframework.deadline.jobrunr.DeadlineDetails

public class DeadlineDetails
extends Object

Wraps the details of a deadline scheduled through the JobRunrDeadlineManager: the deadline's name, and its scope descriptor, payload and metadata in their stored form. The details are themselves converted into a String, which JobRunr stores as the argument of the job that fires the deadline.

The field names are those of Axon Framework 4.13, so that both versions read each other's jobs.

Since:

4.7.0

Author:

Tom de Backer, Gerard Klijs

Constructor Summary

Constructors

Constructor	Description
DeadlineDetails(String deadlineName, String scopeDescriptor, String scopeDescriptorClass, @Nullable String payload, @Nullable String payloadClass, @Nullable String payloadRevision, @Nullable String metaData)	Creates a new DeadlineDetails object from the stored form of a deadline's parts.

Method Summary

Modifier and Type	Method	Description
String	getDeadlineName()	Returns the name of the deadline.
@Nullable String	getMetaData()	Returns the stored metadata of the deadline.
@Nullable String	getPayload()	Returns the stored payload of the deadline.
@Nullable String	getPayloadClass()	Returns the type name of the payload of the deadline.
@Nullable String	getPayloadRevision()	Returns the revision of the payload type of the deadline.
String	getScopeDescriptor()	Returns the stored ScopeDescriptor of the deadline.
String	getScopeDescriptorClass()	Returns the class name of the ScopeDescriptor of the deadline.

Methods inherited from class java.lang.Object

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

Constructor Details

DeadlineDetails

public DeadlineDetails(String deadlineName,
 String scopeDescriptor,
 String scopeDescriptorClass,
 @Nullable String payload,
 @Nullable String payloadClass,
 @Nullable String payloadRevision,
 @Nullable String metaData)

Creates a new DeadlineDetails object from the stored form of a deadline's parts.

Parameters:

deadlineName - the name of the deadline

scopeDescriptor - the stored ScopeDescriptor describing the scope of the deadline

scopeDescriptorClass - the class name of the ScopeDescriptor

payload - the stored payload of the deadline, if any

payloadClass - the type name of the payload

payloadRevision - the revision of the payload type, if any

metaData - the stored metadata of the deadline

Method Details

getDeadlineName

public String getDeadlineName()

Returns the name of the deadline.

Returns:

the name of the deadline

getScopeDescriptor

public String getScopeDescriptor()

Returns the stored ScopeDescriptor of the deadline.

Returns:

the stored ScopeDescriptor of the deadline

getScopeDescriptorClass

public String getScopeDescriptorClass()

Returns the class name of the ScopeDescriptor of the deadline.

Returns:

the class name of the ScopeDescriptor of the deadline

getPayload

public @Nullable String getPayload()

Returns the stored payload of the deadline.

Returns:

the stored payload of the deadline, if any

getPayloadClass

public @Nullable String getPayloadClass()

Returns the type name of the payload of the deadline.

Returns:

the type name of the payload of the deadline

getPayloadRevision

public @Nullable String getPayloadRevision()

Returns the revision of the payload type of the deadline.

Returns:

the revision of the payload type of the deadline, if any

getMetaData

public @Nullable String getMetaData()

Returns the stored metadata of the deadline.

Returns:

the stored metadata of the deadline