Package es.kukenan.smartfi.events.common

Class AbstractEvent<B extends AbstractEventBody>

java.lang.Object

es.kukenan.smartfi.events.common.AbstractEvent<B>

Type Parameters:

B - the type of the event's body attribute.

All Implemented Interfaces:

Event

Direct Known Subclasses:

AbstractScheduledEvent

public abstract class AbstractEvent<B extends AbstractEventBody>
extends Object
implements Event

Base class for any platform event.

Field Summary

Fields

Modifier and Type	Field	Description
private B	body	Event body.
private String	channel	The channel that sent event.
private @NotBlank String	companyId	The company identifier (multi-tenant context).
private final @NotBlank String	context	The functional context in which the event was created.
private ZonedDateTime	creationDate	Event creation timestamp (UTC), ISO_8601 UTC relative date.
private Long	creationTs	Event creation timestamp (UTC), milliseconds from EPOCH.
private String	manager	The manager who sent the event.
private @NotBlank String	messageId	Arbitrary application-specific identifier for the message/event.
private String	operationType	Optional operation type identifier, some kind of event sub-type.
private @NotBlank String	origin	The service that sent the event.
private @NotBlank String	requestId	An unique request (transaction) identifier, UUID format.
private String	session	The session identifier.
private final @NotBlank String	typeId	Event type identifier.
private String	userAgent	The User-Agent header.
private String	userId	The user identifier.
private String	userIp	The user IP Address.
static final ZoneOffset	UTC	Default offset to use internally for ANY date and dateTime.
private @NotBlank String	version	Event version.

Constructor Summary

Constructors

Constructor	Description
AbstractEvent(String context, String typeId)	Minimal constructor.
AbstractEvent(String requestId, String companyId, String origin, String context, String typeId, String operationType, String messageId, String version, Long creationTs, String channel, String session, String manager, String userId, B body)	State constructor, creationDate is created from creationTs.
AbstractEvent(String requestId, String companyId, String origin, String context, String typeId, String operationType, String messageId, String version, Long creationTs, String channel, String session, String manager, String userId, B body, String userIp, String userAgent)	State constructor, creationDate is created from creationTs.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

UTC

public static final ZoneOffset UTC

Default offset to use internally for ANY date and dateTime.

context

@NotBlank
private final @NotBlank String context

The functional context in which the event was created.

typeId

@NotBlank
private final @NotBlank String typeId

Event type identifier.

operationType

private String operationType

Optional operation type identifier, some kind of event sub-type.

requestId

@NotBlank
private @NotBlank String requestId

An unique request (transaction) identifier, UUID format.

companyId

@NotBlank
private @NotBlank String companyId

The company identifier (multi-tenant context).

origin

@NotBlank
private @NotBlank String origin

The service that sent the event.

messageId

@NotBlank
private @NotBlank String messageId

Arbitrary application-specific identifier for the message/event.

version

@NotBlank
private @NotBlank String version

Event version.

creationTs

private Long creationTs

Event creation timestamp (UTC), milliseconds from EPOCH.

creationDate

private ZonedDateTime creationDate

Event creation timestamp (UTC), ISO_8601 UTC relative date.

channel

private String channel

The channel that sent event.

session

private String session

The session identifier.

manager

private String manager

The manager who sent the event.

userId

private String userId

The user identifier.

body

@NotNull
@Valid
private B extends AbstractEventBody body

Event body.

userIp

private String userIp

The user IP Address.

userAgent

private String userAgent

The User-Agent header.

Constructor Details

AbstractEvent

public AbstractEvent(String context,
 String typeId)

Minimal constructor.

Parameters:

context - context

typeId - typeId

AbstractEvent

public AbstractEvent(String requestId,
 String companyId,
 String origin,
 String context,
 String typeId,
 String operationType,
 String messageId,
 String version,
 Long creationTs,
 String channel,
 String session,
 String manager,
 String userId,
 B body)

State constructor, creationDate is created from creationTs.

Parameters:

requestId - requestId

companyId - companyId

origin - origin

context - context

typeId - typeId

operationType - operationType

messageId - messageId

version - version

creationTs - creationTs

channel - channel

session - session

manager - manager

userId - userId

body - body

AbstractEvent

public AbstractEvent(String requestId,
 String companyId,
 String origin,
 String context,
 String typeId,
 String operationType,
 String messageId,
 String version,
 Long creationTs,
 String channel,
 String session,
 String manager,
 String userId,
 B body,
 String userIp,
 String userAgent)

State constructor, creationDate is created from creationTs.

Parameters:

requestId - requestId

companyId - companyId

origin - origin

context - context

typeId - typeId

operationType - operationType

messageId - messageId

version - version

creationTs - creationTs

channel - channel

session - session

manager - manager

userId - userId

body - body

userIp - userIp

userAgent - userAgent