Java SDK for CloudEvents

cloudevents hacktoberfest java-api kafka sdk-java

Go to file

Francesco Guardiani 34408236db Moved CloudEventUtils from impl to io.cloudevents.core (#261 ) Renamed CloudEventUtils#toVisitable to CloudEventUtils#toReader Added CloudEventUtils#toEvent Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>		2020-11-13 10:00:49 +01:00
.github/workflows	Release process docs (#248 )	2020-09-29 13:35:57 +02:00
.mvn/wrapper	Add Maven wrapper (#144 )	2020-04-29 18:21:22 +02:00
api	Improvements to CloudEventReader (#263 )	2020-11-13 09:54:07 +01:00
benchmarks	Bump to 2.0.0-SNAPSHOT (#255 )	2020-11-09 14:13:56 +01:00
core	Moved CloudEventUtils from impl to io.cloudevents.core (#261 )	2020-11-13 10:00:49 +01:00
docs	Update website deps to latest version (#265 )	2020-11-13 09:58:52 +01:00
examples	Bump to 2.0.0-SNAPSHOT (#255 )	2020-11-09 14:13:56 +01:00
formats/json-jackson	Moved CloudEventUtils from impl to io.cloudevents.core (#261 )	2020-11-13 10:00:49 +01:00
http	Improvements to CloudEventReader (#263 )	2020-11-13 09:54:07 +01:00
kafka	Moved CloudEventUtils from impl to io.cloudevents.core (#261 )	2020-11-13 10:00:49 +01:00
.editorconfig	Added editorconfig check during the verify phase (#239 )	2020-09-28 10:00:21 +02:00
.gitignore	Improved a bit the docs website (#185 )	2020-06-25 11:24:18 +02:00
LICENSE	Formatted code and added copyright headers (#140 )	2020-04-28 13:56:06 +02:00
README.md	Cleanup readme (#256 )	2020-11-09 14:40:40 +01:00
maintainer_guidelines.md	Release process docs (#248 )	2020-09-29 13:35:57 +02:00
mvnw	Add Maven wrapper (#144 )	2020-04-29 18:21:22 +02:00
mvnw.cmd	Add Maven wrapper (#144 )	2020-04-29 18:21:22 +02:00
pom.xml	Bump to 2.0.0-SNAPSHOT (#255 )	2020-11-09 14:13:56 +01:00
pr_guidelines.md	copy guidance from javascript repo (#159 )	2020-06-04 15:02:20 +02:00

README.md

Java SDK for CloudEvents API

A Java API for the CloudEvents specification

Look at https://cloudevents.github.io/sdk-java/ for more documentation.

Status

This SDK is considered work in progress. The community is working hard to bring you a new major version of the SDK with major enhancements both to APIs and to implementation.

If you want to know more about v1 of this SDK, check out the v1 readme

Stay tuned!

Supported features of the specification:

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

Motivation

The CloudEvents specification is a vendor-neutral specification for defining the format of event data that is being exchanged between different cloud systems. The specification basically defines an abstract envelope for any event data payload, without knowing specific implementation details of the actual underlying event. The current version of the spec is at 1.0 and it describes a simple event format, which was demonstrated at KubeCon 2018 using different Serverless platforms, such as Apache Openwhisk.

Documentation

Documentation is available at https://cloudevents.github.io/sdk-java/

Javadocs are available on javadoc.io:

Used By

Occurrent	Knative Eventing

Community

There are bi-weekly calls immediately following the Serverless/CloudEvents call at 9am PT (US Pacific). Which means they will typically start at 10am PT, but if the other call ends early then the SDK call will start early as well. See the CloudEvents meeting minutes to determine which week will have the call.
Slack: #cloudeventssdk channel under CNCF's Slack workspace.
Email: https://lists.cncf.io/g/cncf-cloudevents-sdk
Contact for additional information: Francesco Guardiani (@slinkydeveloper on slack), Fabio José (@fabiojose on slack).

Each SDK may have its own unique processes, tooling and guidelines, common governance related material can be found in the CloudEvents community directory. In particular, in there you will find information concerning how SDK projects are managed, guidelines for how PR reviews and approval, and our Code of Conduct information.