Link Search Menu Expand Document

Java SDK for CloudEvents

  1. Introduction
  2. Supported features
  3. Get Started
  4. Modules

Introduction

The Java SDK for CloudEvents is a collection of Java libraries to adopt CloudEvents in your Java application.

Using the Java SDK you can:

  • Access, create and manipulate CloudEvent inside your application.
  • Serialize and deserialize CloudEvent back and forth using the CloudEvents Event Format, like Json.
  • Read and write CloudEvent back and forth to HTTP, Kafka, AMQP using the CloudEvents Protocol Binding implementations we provide for a wide range of well known Java frameworks/libraries.

Supported features

  v0.3 v1.0
CloudEvents Core :heavy_check_mark: :heavy_check_mark:
AMQP Protocol Binding :x: :x:
- Proton :heavy_check_mark: :heavy_check_mark:
AVRO Event Format :x: :x:
HTTP Protocol Binding :heavy_check_mark: :heavy_check_mark:
- Vert.x :heavy_check_mark: :heavy_check_mark:
- Jakarta Restful WS :heavy_check_mark: :heavy_check_mark:
- Basic :heavy_check_mark: :heavy_check_mark:
- Spring :heavy_check_mark: :heavy_check_mark:
- http4k :heavy_check_mark: :heavy_check_mark:
JSON Event Format :heavy_check_mark: :heavy_check_mark:
- Jackson :heavy_check_mark: :heavy_check_mark:
Protobuf Event Format :heavy_check_mark: :heavy_check_mark:
- Proto :heavy_check_mark: :heavy_check_mark:
Kafka Protocol Binding :heavy_check_mark: :heavy_check_mark:
MQTT Protocol Binding :x: :x:
NATS Protocol Binding :x: :x:
Web hook :x: :x:

† Source/artifacts hosted externally

Get Started

In order to start learning how to create, access and manipulate CloudEvents, check out the Core module documentation.

If you want to serialize and deserialize events and data back and forth to JSON, check out the Jackson Json module documentation.

Depending on the protocol and framework you’re using, if you want to send and receive CloudEvents, check out the dedicated pages:

If you’re interested in implementing an object conforming to the CloudEvent and related interfaces, in order to interoperate with the other components of the SDK, check out the API module documentation.

You can also check out the Examples.

Modules

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

You can look at the latest published artifacts on Maven Central.