Skip to content

Commit 0a34654

Browse files
jacekbilskijacekbilski
authored
Deprecating to Jakarta EE 8 (#732)
* Adding/fixing Jakarta EE 9+ links. Signed-off-by: Jacek Bilski <jacek@bilski.tech> * Random typos and consistency fixes. Signed-off-by: Jacek Bilski <jacek@bilski.tech> * Making Jakarta EE 9+ module a first-class citizen. Signed-off-by: Jacek Bilski <jacek@bilski.tech> * Deprecating Jakarta EE 8 `cloudevents-http-restful-ws` module. Signed-off-by: Jacek Bilski <jacek@bilski.tech> * `io.cloudevents.http.restful.ws.CloudEventsProvider` does not implement `jakarta.ws.rs.ext.Providers` - removing. Signed-off-by: Jacek Bilski <jacek@bilski.tech> --------- Signed-off-by: Jacek Bilski <jacek@bilski.tech>
1 parent 9f3073a commit 0a34654

33 files changed

Lines changed: 673 additions & 104 deletions

‎.gitignore‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,3 @@ _site/
4545

4646
# MacOS
4747
*.DS_Store
48-
/http/restful-ws-jakarta/src/main/*
49-

‎README.md‎

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ Using the Java SDK you can:
1111

1212
- Access, create and manipulate `CloudEvent` inside your application.
1313
- Serialize and deserialize `CloudEvent` back and forth using the _CloudEvents
14-
Event Format_, like Json.
14+
Event Format_, like JSON.
1515
- Read and write `CloudEvent` back and forth to HTTP, Kafka, AMQP using the
1616
_CloudEvents Protocol Binding_ implementations we provide for a wide range
17-
of well known Java frameworks/libraries.
17+
of well-known Java frameworks/libraries.
1818

1919
To check out the complete documentation and how to get started, look at the dedicated website
2020
https://cloudevents.github.io/sdk-java/.
@@ -32,26 +32,27 @@ Stay tuned!
3232

3333
Supported features of the specification:
3434

35-
| | [v0.3](https://github.com/cloudevents/spec/tree/v0.3) | [v1.0](https://github.com/cloudevents/spec/tree/v1.0) |
36-
| :-------------------------------------: | :---------------------------------------------------: | :---------------------------------------------------: |
37-
| CloudEvents Core | :heavy_check_mark: | :heavy_check_mark: |
38-
| AMQP Protocol Binding | :x: | :x: |
39-
| - [Proton](amqp) | :heavy_check_mark: | :heavy_check_mark: |
40-
| AVRO Event Format | :x: | :x: |
41-
| HTTP Protocol Binding | :heavy_check_mark: | :heavy_check_mark: |
42-
| - [Vert.x](http/vertx) | :heavy_check_mark: | :heavy_check_mark: |
43-
| - [Jakarta Restful WS](http/restful-ws) | :heavy_check_mark: | :heavy_check_mark: |
44-
| - [Basic](http/basic) | :heavy_check_mark: | :heavy_check_mark: |
45-
| - [Spring](spring) | :heavy_check_mark: | :heavy_check_mark: |
46-
| - [http4k][http4k]<sup>†</sup>| :heavy_check_mark: | :heavy_check_mark: |
47-
| JSON Event Format | :heavy_check_mark: | :heavy_check_mark: |
48-
| - [Jackson](formats/json-jackson) | :heavy_check_mark: | :heavy_check_mark: |
49-
| Protobuf Event Format | :heavy_check_mark: | :heavy_check_mark: |
50-
| - [Proto](formats/protobuf) | :heavy_check_mark: | :heavy_check_mark: |
51-
| [Kafka Protocol Binding](kafka) | :heavy_check_mark: | :heavy_check_mark: |
52-
| MQTT Protocol Binding | :x: | :x: |
53-
| NATS Protocol Binding | :x: | :x: |
54-
| Web hook | :x: | :x: |
35+
| | [v0.3](https://github.com/cloudevents/spec/tree/v0.3) | [v1.0](https://github.com/cloudevents/spec/tree/v1.0) |
36+
|:------------------------------------------------------:|:-----------------------------------------------------:|:-----------------------------------------------------:|
37+
| CloudEvents Core | :heavy_check_mark: | :heavy_check_mark: |
38+
| AMQP Protocol Binding | :x: | :x: |
39+
| - [Proton](amqp) | :heavy_check_mark: | :heavy_check_mark: |
40+
| AVRO Event Format | :x: | :x: |
41+
| HTTP Protocol Binding | :heavy_check_mark: | :heavy_check_mark: |
42+
| - [Vert.x](http/vertx) | :heavy_check_mark: | :heavy_check_mark: |
43+
| - [Jakarta EE 8 Restful WS](http/restful-ws) | :heavy_check_mark: | :heavy_check_mark: |
44+
| - [Jakarta EE 9+ Restful WS](http/restful-ws-jakarta) | :heavy_check_mark: | :heavy_check_mark: |
45+
| - [Basic](http/basic) | :heavy_check_mark: | :heavy_check_mark: |
46+
| - [Spring](spring) | :heavy_check_mark: | :heavy_check_mark: |
47+
| - [http4k][http4k]<sup>†</sup> | :heavy_check_mark: | :heavy_check_mark: |
48+
| JSON Event Format | :heavy_check_mark: | :heavy_check_mark: |
49+
| - [Jackson](formats/json-jackson) | :heavy_check_mark: | :heavy_check_mark: |
50+
| Protobuf Event Format | :heavy_check_mark: | :heavy_check_mark: |
51+
| - [Proto](formats/protobuf) | :heavy_check_mark: | :heavy_check_mark: |
52+
| [Kafka Protocol Binding](kafka) | :heavy_check_mark: | :heavy_check_mark: |
53+
| MQTT Protocol Binding | :x: | :x: |
54+
| NATS Protocol Binding | :x: | :x: |
55+
| Web hook | :x: | :x: |
5556

5657
<sub>† Source/artifacts hosted externally</sub>
5758

@@ -69,6 +70,7 @@ Javadocs are available on [javadoc.io](https://www.javadoc.io):
6970
- [cloudevents-xml](https://www.javadoc.io/doc/io.cloudevents/cloudevents-xml)
7071
- [cloudevents-http-basic](https://www.javadoc.io/doc/io.cloudevents/cloudevents-http-basic)
7172
- [cloudevents-http-restful-ws](https://www.javadoc.io/doc/io.cloudevents/cloudevents-http-restful-ws)
73+
- [cloudevents-http-restful-ws-jakarta](https://www.javadoc.io/doc/io.cloudevents/cloudevents-http-restful-ws-jakarta)
7274
- [cloudevents-http-vertx](https://www.javadoc.io/doc/io.cloudevents/cloudevents-http-vertx)
7375
- [cloudevents-kafka](https://www.javadoc.io/doc/io.cloudevents/cloudevents-kafka)
7476
- [cloudevents-amqp](https://www.javadoc.io/doc/io.cloudevents/cloudevents-amqp)

‎docs/http-basic.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,16 @@ This module is designed to be usable with various HTTP APIs.
1212
There are also more specialized HTTP bindings:
1313

1414
- [`cloudevents-http-vertx`](http-vertx.md)
15-
- [`cloudevents-http-restful-ws`](http-jakarta-restful-ws.md)
15+
- [`cloudevents-http-restful-ws`](http-jakarta-restful-ws.md) (deprecated, please use `cloudevents-http-restful-ws-jakarta`)
16+
- [`cloudevents-http-restful-ws-jakarta`](http-jakarta-restful-ws-jakarta.md)
1617
- [`cloudevents-spring`](spring.md)
1718

18-
Since this module is generic it doesn't offer optimal performance for all HTTP
19+
Since this module is generic, it doesn't offer optimal performance for all HTTP
1920
implementations. For better performance consider implementing `MessageReader`
2021
and `MessageWriter` that are tailored for specific HTTP implementation. As a
21-
reference you can take aforementioned existing bindings.
22+
reference, you can take the aforementioned existing bindings.
2223

23-
For Maven based projects, use the following to configure the CloudEvents Generic
24+
For Maven-based projects, use the following to configure the CloudEvents Generic
2425
HTTP Transport:
2526

2627
```xml

‎docs/http-jakarta-restful-ws-jakarta.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ nav_order: 5
55

66
# HTTP Protocol Binding for Jakarta EE 9+ - Jakarta RESTful Web Services
77

8-
[![Javadocs](https://www.javadoc.io/badge/io.cloudevents/cloudevents-http-restful-ws.svg?color=green)](https://www.javadoc.io/doc/io.cloudevents/cloudevents-http-restful-ws)
8+
[![Javadocs](https://www.javadoc.io/badge/io.cloudevents/cloudevents-http-restful-ws-jakarta.svg?color=green)](https://www.javadoc.io/doc/io.cloudevents/cloudevents-http-restful-ws-jakarta)
99

10-
For Maven based projects, use the following to configure the CloudEvents Jakarta
10+
For Maven-based projects, use the following to configure the CloudEvents Jakarta
1111
RESTful Web Services Binding for Jakarta EE 9+:
1212

1313
```xml
@@ -20,7 +20,7 @@ RESTful Web Services Binding for Jakarta EE 9+:
2020

2121
This integration is tested with Jersey (Requires JDK11 or higher), RestEasy & Microprofile Liberty.
2222

23-
#### * Before using this package ensure your web framework does support the `jakarta.*` namespace.
23+
#### * Before using this package ensure your web framework does support the `jakarta.*` namespace.
2424

2525
## Receiving CloudEvents
2626

@@ -41,8 +41,6 @@ import jakarta.ws.rs.core.Response;
4141
@Path("/")
4242
public class EventReceiverResource {
4343

44-
45-
4644
@GET
4745
@Path("getMinEvent")
4846
public CloudEvent getMinEvent() {

‎docs/http-jakarta-restful-ws.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@ title: CloudEvents HTTP Jakarta RESTful Web Services
33
nav_order: 5
44
---
55

6-
# HTTP Protocol Binding for Jakarta EE8 - RESTful Web Services
6+
# HTTP Protocol Binding for Jakarta EE 8 - RESTful Web Services
7+
8+
This module is deprecated and will be removed in version 5.0.
9+
Please migrate to Jakarta EE 9+ and use the `cloudevents-http-restful-ws-jakarta` module instead.
710

811
[![Javadocs](http://www.javadoc.io/badge/io.cloudevents/cloudevents-http-restful-ws.svg?color=green)](http://www.javadoc.io/doc/io.cloudevents/cloudevents-http-restful-ws)
912

0 commit comments

Comments
 (0)