Package org.axonframework.deadline.jobrunr

Class DeadlineDetails

java.lang.Object

org.axonframework.deadline.jobrunr.DeadlineDetails

public class DeadlineDetails
extends Object

Pojo that contains the information about a Job, will be serialized and deserialized using the configured Serializer on the JobRunrDeadlineManager.

Since:

4.7.0

Author:

Tom de Backer, Gerard Klijs

Constructor Summary

Constructors

Constructor	Description
DeadlineDetails(String deadlineName, String scopeDescriptor, String scopeDescriptorClass, String payload, String payloadClass, String payloadRevision, String metaData)	Creates a new DeadlineDetails object, likely based on a DeadlineMessage.

Method Summary

Modifier and Type	Method	Description
GenericDeadlineMessage	asDeadLineMessage(Serializer serializer)	Returns the DeadlineDetails as an GenericDeadlineMessage, with the timestamp set using the GenericEventMessage.clock to set to the current time.
String	getDeadlineName()	Returns the String with the name of the deadline.
ScopeDescriptor	getDeserializedScopeDescriptor(Serializer serializer)	Returns the serialized ScopeDescriptor using the supplied Serializer.
String	getMetaData()	Returns the String containing the metadata about the deadline.
String	getPayload()	Returns the serialized String of the payload.
String	getPayloadClass()	Returns the String with the class of the payload.
String	getPayloadRevision()	Returns the String with the revision of the payload.
String	getScopeDescriptor()	Returns the serialized String which tells what the scope is of the deadline.
String	getScopeDescriptorClass()	Returns the String with the class of the scope descriptor.

Methods inherited from class java.lang.Object

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

Constructor Details

DeadlineDetails

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

Creates a new DeadlineDetails object, likely based on a DeadlineMessage.

Parameters:

deadlineName - The String with the name of the deadline.

scopeDescriptor - The String which tells what the scope is of the deadline.

scopeDescriptorClass - The String which tells what the class of the scope descriptor is.

payload - The String with the payload. This can be null.

payloadClass - The String which tells what the class of the scope payload is.

payloadRevision - The String which tells what the revision of the scope payload is.

metaData - The String containing the metadata about the deadline.

Method Details

getDeadlineName

public String getDeadlineName()

Returns the String with the name of the deadline.

Returns:

The String with the name of the deadline.

getScopeDescriptor

public String getScopeDescriptor()

Returns the serialized String which tells what the scope is of the deadline.

Returns:

The serialized String which tells what the scope is of the deadline.

getScopeDescriptorClass

public String getScopeDescriptorClass()

Returns the String with the class of the scope descriptor.

Returns:

The String with the class of the scope descriptor.

getPayload

public String getPayload()

Returns the serialized String of the payload. This can be null.

Returns:

The serialized String of the payload. This can be null.

getPayloadClass

public String getPayloadClass()

Returns the String with the class of the payload. This can be null.

Returns:

The String with the class of the payload. This can be null.

getPayloadRevision

public String getPayloadRevision()

Returns the String with the revision of the payload. This can be null.

Returns:

The String with the revision of the payload. This can be null.

getMetaData

public String getMetaData()

Returns the String containing the metadata about the deadline.

Returns:

The String containing the metadata about the deadline.

asDeadLineMessage

public GenericDeadlineMessage asDeadLineMessage(Serializer serializer)

Returns the DeadlineDetails as an GenericDeadlineMessage, with the timestamp set using the GenericEventMessage.clock to set to the current time.

Returns:

the GenericDeadlineMessage with all the properties of this pojo, and a timestamp.

getDeserializedScopeDescriptor

public ScopeDescriptor getDeserializedScopeDescriptor(Serializer serializer)

Returns the serialized ScopeDescriptor using the supplied Serializer. This will be an instance of the scopeDescriptorClass property.

Returns:

the ScopeDescriptor that is serialized using the supplied Serializer.