Package org.axonframework.eventsourcing.eventstore.jpa

Class AggregateEventEntry

java.lang.Object

org.axonframework.eventsourcing.eventstore.jpa.AggregateEventEntry

@Entity
public class AggregateEventEntry
extends Object

A JPA entry dedicated for storing EventMessages in the AggregateBasedJpaEventStorageEngine.

Since:

5.0.0

Author:

Steven van Beelen

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AggregateEventEntry()	Default constructor required by JPA.
	AggregateEventEntry(long globalIndex, String identifier, String type, String version, byte[] payload, byte[] metadata, String timestamp, @Nullable String aggregateType, @Nullable String aggregateIdentifier, @Nullable Long aggregateSequenceNumber)	Constructor for an AggregateEventEntry when reading events, since all parameters should be given.
	AggregateEventEntry(String identifier, String type, String version, byte[] payload, byte[] metadata, Object timestamp, @Nullable String aggregateType, @Nullable String aggregateIdentifier, @Nullable Long aggregateSequenceNumber)	Constructor for a AggregateEventEntry when appending events, since the globalIndex() will be defined by the storage layer.

Method Summary

Modifier and Type	Method	Description
@Nullable String	aggregateIdentifier()	Returns the aggregateIdentifier of the stored EventMessage.
@Nullable Long	aggregateSequenceNumber()	Returns the aggregate sequence number of the stored EventMessage.
@Nullable String	aggregateType()	Returns the aggregate type of the stored EventMessage.
long	globalIndex()	Returns the global index of the stored EventMessage, reflecting its position in the event store.
String	identifier()	Returns the identifier of the stored EventMessage.
byte[]	metadata()	Returns the metadata of the stored EventMessage.
byte[]	payload()	Returns the payload of the stored EventMessage.
Instant	timestamp()	Returns the timestamp of the stored EventMessage.
String	timestampAsString()	Returns the timestamp of the stored EventMessage as a String.
String	type()	Returns the type of the stored EventMessage.
String	version()	Returns the version of the stored EventMessage.

Methods inherited from class java.lang.Object

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

Constructor Details

AggregateEventEntry

public AggregateEventEntry(String identifier,
 String type,
 String version,
 byte[] payload,
 byte[] metadata,
 Object timestamp,
 @Nullable String aggregateType,
 @Nullable String aggregateIdentifier,
 @Nullable Long aggregateSequenceNumber)

Constructor for a AggregateEventEntry when appending events, since the globalIndex() will be defined by the storage layer.

Parameters:

identifier - The identifier of the EventMessage.

type - The MessageType.name() of an Message.type().

version - The MessageType.version() of an Message.type().

payload - The Message.payload() as a byte[].

metadata - The Message.metadata() as a byte[].

timestamp - The time at which the EventMessage was originally created.

aggregateType - The type of the aggregate that published this EventMessage. May be null if the event does not originate from an aggregate.

aggregateIdentifier - The identifier of the aggregate that published this EventMessage. May be null if the event does not originate from an aggregate.

aggregateSequenceNumber - The sequence number of the EventMessage in the aggregate. May be null if the event does not originate from an aggregate.

AggregateEventEntry

public AggregateEventEntry(long globalIndex,
 String identifier,
 String type,
 String version,
 byte[] payload,
 byte[] metadata,
 String timestamp,
 @Nullable String aggregateType,
 @Nullable String aggregateIdentifier,
 @Nullable Long aggregateSequenceNumber)

Constructor for an AggregateEventEntry when reading events, since all parameters should be given.

Parameters:

globalIndex - The position of the EventMessage in the event store.

identifier - The identifier of the EventMessage.

type - The MessageType.name() of an Message.type().

version - The MessageType.version() of an Message.type().

payload - The Message.payload() as a byte[].

metadata - The Message.metadata() as a byte[].

timestamp - The time at which the EventMessage was originally created.

aggregateType - The type of the aggregate that published this EventMessage. May be null if the event does not originate from an aggregate.

aggregateIdentifier - The identifier of the aggregate that published this EventMessage. May be null if the event does not originate from an aggregate.

aggregateSequenceNumber - The sequence number of the EventMessage in the aggregate. May be null if the event does not originate from an aggregate.

AggregateEventEntry

protected AggregateEventEntry()

Default constructor required by JPA.

Method Details

globalIndex

public long globalIndex()

Returns the global index of the stored EventMessage, reflecting its position in the event store.

Returns:

The global index of the stored EventMessage, reflecting its position in the event store.

identifier

public String identifier()

Returns the identifier of the stored EventMessage.

Returns:

The identifier of the stored EventMessage.

type

public String type()

Returns the type of the stored EventMessage.

Returns:

The type of the stored EventMessage.

version

public String version()

Returns the version of the stored EventMessage.

Returns:

The version of the stored EventMessage.

payload

public byte[] payload()

Returns the payload of the stored EventMessage.

Returns:

The payload of the stored EventMessage.

metadata

public byte[] metadata()

Returns the metadata of the stored EventMessage.

Returns:

The metadata of the stored EventMessage.

timestamp

public Instant timestamp()

Returns the timestamp of the stored EventMessage.

Returns:

The timestamp of the stored EventMessage.

timestampAsString

public String timestampAsString()

Returns the timestamp of the stored EventMessage as a String.

Returns:

The timestamp of the stored EventMessage as a String.

aggregateType

public @Nullable String aggregateType()

Returns the aggregate type of the stored EventMessage.

Will be null if the event did not originate from an aggregate.

Returns:

The aggregate type of the stored EventMessage.

aggregateIdentifier

public @Nullable String aggregateIdentifier()

Returns the aggregateIdentifier of the stored EventMessage.

Will be null if the event did not originate from an aggregate.

Returns:

The aggregateIdentifier of the stored EventMessage.

aggregateSequenceNumber

public @Nullable Long aggregateSequenceNumber()

Returns the aggregate sequence number of the stored EventMessage.

Will be null if the event did not originate from an aggregate.

Returns:

The aggregate sequence number of the stored EventMessage.