io.cloudevents.impl

Class DefaultCloudEventImpl<T>

java.lang.Object

io.cloudevents.impl.DefaultCloudEventImpl<T>

Type Parameters:

T - generic type of the underlying data field.

All Implemented Interfaces:

CloudEvent<T>, java.io.Serializable

public class DefaultCloudEventImpl<T>
extends java.lang.Object
implements CloudEvent<T>, java.io.Serializable

Default Java implementation of the CloudEvent API.

See Also:

Serialized Form

Field Summary

Fields inherited from interface io.cloudevents.CloudEvent

CLOUD_EVENTS_VERSION_KEY, EVENT_ID_KEY, EVENT_TIME_KEY, EVENT_TYPE_KEY, EVENT_TYPE_VERSION_KEY, HEADER_PREFIX, SCHEMA_URL_KEY, SOURCE_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultCloudEventImpl(java.lang.String eventType, java.lang.String cloudEventsVersion, java.net.URI source, java.lang.String eventID, java.lang.String eventTypeVersion, java.time.ZonedDateTime eventTime, java.net.URI schemaURL, java.lang.String contentType, java.util.Map extensions, T data)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCloudEventsVersion() The version of the CloudEvents specification which the event uses.
java.util.Optional<java.lang.String>	getContentType() Describe the data encoding format
java.util.Optional<T>	getData() The event payload.
java.lang.String	getEventID() ID of the event.
java.util.Optional<java.time.ZonedDateTime>	getEventTime() Timestamp of when the event happened.
java.lang.String	getEventType() Type of occurrence which has happened.
java.util.Optional<java.lang.String>	getEventTypeVersion() The version of the eventType.
java.util.Optional<java.util.Map>	getExtensions() This is for additional metadata and this does not have a mandated structure.
java.util.Optional<java.net.URI>	getSchemaURL() A link to the schema that the data attribute adheres to.
java.net.URI	getSource() This describes the event producer.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCloudEventImpl

public DefaultCloudEventImpl(java.lang.String eventType,
                             java.lang.String cloudEventsVersion,
                             java.net.URI source,
                             java.lang.String eventID,
                             java.lang.String eventTypeVersion,
                             java.time.ZonedDateTime eventTime,
                             java.net.URI schemaURL,
                             java.lang.String contentType,
                             java.util.Map extensions,
                             T data)

Method Detail

getCloudEventsVersion

public java.lang.String getCloudEventsVersion()

Description copied from interface: CloudEvent

The version of the CloudEvents specification which the event uses. This enables the interpretation of the context.

Specified by:

getCloudEventsVersion in interface CloudEvent<T>

getExtensions

public java.util.Optional<java.util.Map> getExtensions()

Description copied from interface: CloudEvent

This is for additional metadata and this does not have a mandated structure. This enables a place for custom fields a producer or middleware might want to include and provides a place to test metadata before adding them to the CloudEvents specification.

Specified by:

getExtensions in interface CloudEvent<T>

getEventType

public java.lang.String getEventType()

Description copied from interface: CloudEvent

Type of occurrence which has happened. Often this property is used for routing, observability, policy enforcement, etc.

Specified by:

getEventType in interface CloudEvent<T>

getSource

public java.net.URI getSource()

Description copied from interface: CloudEvent

This describes the event producer. Often this will include information such as the type of the event source, the organization publishing the event, and some unique identifiers. The exact syntax and semantics behind the data encoded in the URI is event producer defined.

Specified by:

getSource in interface CloudEvent<T>

getEventID

public java.lang.String getEventID()

Description copied from interface: CloudEvent

ID of the event. The semantics of this string are explicitly undefined to ease the implementation of producers. Enables deduplication.

Specified by:

getEventID in interface CloudEvent<T>

getEventTypeVersion

public java.util.Optional<java.lang.String> getEventTypeVersion()

Description copied from interface: CloudEvent

The version of the eventType. This enables the interpretation of data by eventual consumers, requires the consumer to be knowledgeable about the producer.

Specified by:

getEventTypeVersion in interface CloudEvent<T>

getEventTime

public java.util.Optional<java.time.ZonedDateTime> getEventTime()

Description copied from interface: CloudEvent

Timestamp of when the event happened.

Specified by:

getEventTime in interface CloudEvent<T>

getSchemaURL

public java.util.Optional<java.net.URI> getSchemaURL()

Description copied from interface: CloudEvent

A link to the schema that the data attribute adheres to.

Specified by:

getSchemaURL in interface CloudEvent<T>

getContentType

public java.util.Optional<java.lang.String> getContentType()

Description copied from interface: CloudEvent

Describe the data encoding format

Specified by:

getContentType in interface CloudEvent<T>

getData

public java.util.Optional<T> getData()

Description copied from interface: CloudEvent

The event payload. The payload depends on the eventType, schemaURL and eventTypeVersion, the payload is encoded into a media format which is specified by the contentType attribute (e.g. application/json).

Specified by:

getData in interface CloudEvent<T>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object