cc0892a440
* WIP Spring boot example Signed-off-by: Francesco Guardiani <francescoguard@gmail.com> * Applied suggestions Signed-off-by: Francesco Guardiani <francescoguard@gmail.com> * Updated after rebase Signed-off-by: Francesco Guardiani <francescoguard@gmail.com> |
||
|---|---|---|
| .github/workflows | ||
| .mvn/wrapper | ||
| amqp | ||
| api | ||
| benchmarks | ||
| core | ||
| docs | ||
| examples | ||
| formats/json-jackson | ||
| http | ||
| kafka | ||
| .editorconfig | ||
| .gitignore | ||
| LICENSE | ||
| README.md | ||
| maintainer_guidelines.md | ||
| mvnw | ||
| mvnw.cmd | ||
| pom.xml | ||
| pr_guidelines.md | ||
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:
- cloudevents-api
- cloudevents-core
- cloudevents-json-jackson
- cloudevents-http-basic
- cloudevents-http-restful-ws
- cloudevents-http-vertx
- cloudevents-kafka
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 (
@slinkydeveloperon slack), Fabio José (@fabiojoseon 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.