sdk-java/docs/index.md

Java SDK for CloudEvents

A Java API for the CloudEvents specification

1. Supported Specification Features
2. Modules
3. Get Started
4. Use an event format

Supported Specification Features

Supported features of the specification:

	v0.3	v1.0
CloudEvents Core	✔️	✔️
AMQP Protocol Binding	❌	❌
AVRO Event Format	❌	❌
HTTP Protocol Binding	✔️	✔️
- Vert.x	✔️	✔️
JSON Event Format	✔️	✔️
- Jackson	✔️	✔️
Kafka Protocol Binding	❌	❌
MQTT Protocol Binding	❌	❌
NATS Protocol Binding	❌	❌
Web hook	❌	❌

Modules

The CloudEvents SDK for Java is composed by several modules, each one providing a different feature from the different subspecs of CloudEvents specification:

• cloudevents-api: Base module providing
  • CloudEvent class, the in memory representation of a CloudEvent
  • CloudEventBuilder, the builder to create CloudEvents programmatically
  • EventFormat, the abstraction to implement Event Formats
  • Message/MessageVisitor, the abstractions to implement Protocol bindings
• cloudevents-json-jackson: Implementation of JSON Event format with Jackson
• cloudevents-http-vertx: Implementation of HTTP Protocol Binding with Vert.x Core

The latest SDK version is 2.0.0-SNAPSHOT.

Get Started

Use an event format