Prepare to release v3.0.0 (#1971)

AsyncHttpClient · Jul 29, 2024 · 2ae9892 · 2ae9892
1 parent 144a026
commit 2ae9892
Show file tree

Hide file tree

Showing 71 changed files with 95 additions and 531 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,4 +1,4 @@
-   Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+   Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/README.md b/README.md
@@ -20,32 +20,18 @@ Maven:
     <dependency>
         <groupId>org.asynchttpclient</groupId>
         <artifactId>async-http-client</artifactId>
-        <version>3.0.0.Beta3</version>
+        <version>3.0.0</version>
     </dependency>
 </dependencies>
 ```
 
 Gradle:
 ```groovy
 dependencies {
-    implementation 'org.asynchttpclient:async-http-client:3.0.0.Beta3'
+    implementation 'org.asynchttpclient:async-http-client:3.0.0'
 }
 ```
 
-## Version
-
-AHC doesn't use SEMVER, and won't.
-
-* MAJOR = huge refactoring
-* MINOR = new features and minor API changes, upgrading should require 1 hour of work to adapt sources
-* FIX = no API change, just bug fixes, only those are source and binary compatible with same minor version
-
-Check CHANGES.md for migration path between versions.
-
-## Basics
-
-Feel free to check the [Javadoc](http://www.javadoc.io/doc/org.asynchttpclient/async-http-client/) or the code for more information.
-
 ### Dsl
 
 Import the Dsl helpers to use convenient methods to bootstrap components:
@@ -112,7 +98,7 @@ This body can be of type:
 * `String`
 * `java.nio.ByteBuffer`
 * `java.io.InputStream`
-* `Publisher<io.netty.bufferByteBuf>`
+* `Publisher<io.netty.buffer.ByteBuf>`
 * `org.asynchttpclient.request.body.generator.BodyGenerator`
 
 `BodyGenerator` is a generic abstraction that let you create request bodies on the fly.
@@ -244,75 +230,34 @@ Async Http Client also supports WebSocket.
 You need to pass a `WebSocketUpgradeHandler` where you would register a `WebSocketListener`.
 
 ```java
-WebSocket websocket=c.prepareGet("ws://demos.kaazing.com/echo")
+WebSocket websocket = c.prepareGet("ws://demos.kaazing.com/echo")
         .execute(new WebSocketUpgradeHandler.Builder().addWebSocketListener(
-        new WebSocketListener(){
-
-            @Override
-            public void onOpen(WebSocket websocket){
-                websocket.sendTextFrame("...").sendTextFrame("...");
-            }
-
-            @Override
-            public void onClose(WebSocket websocket) {
-                // ...
-            }
-
-            @Override
-            public void onTextFrame(String payload,boolean finalFragment,int rsv){
-                 System.out.println(payload);
-            }
-
-            @Override
-            public void onError(Throwable t){
-                t.printStackTrace();
-            }
-        }).build()).get();
+                new WebSocketListener() {
+
+                  @Override
+                  public void onOpen(WebSocket websocket) {
+                    websocket.sendTextFrame("...").sendTextFrame("...");
+                  }
+
+                  @Override
+                  public void onClose(WebSocket websocket) {
+                    // ...
+                  }
+
+                  @Override
+                  public void onTextFrame(String payload, boolean finalFragment, int rsv) {
+                    System.out.println(payload);
+                  }
+
+                  @Override
+                  public void onError(Throwable t) {
+                    t.printStackTrace();
+                  }
+                }).build()).get();
 ```
 
-## WebDAV
-
-AsyncHttpClient has build in support for the WebDAV protocol.
-The API can be used the same way normal HTTP request are made:
-
-```java
-        Request mkcolRequest=new RequestBuilder("MKCOL").setUrl("http://host:port/folder1").build();
-        Response response=c.executeRequest(mkcolRequest).get();
-```
-
-or
-
-```java
-        Request propFindRequest=new RequestBuilder("PROPFIND").setUrl("http://host:port").build();
-        Response response=c.executeRequest(propFindRequest,new AsyncHandler() {
-            // ...
-        }).get();
-```
-
-## More
-
-You can find more information on Jean-François Arcand's blog. Jean-François is the original author of this library.
-Code is sometimes not up-to-date but gives a pretty good idea of advanced features.
-
-* http://web.archive.org/web/20111224171448/http://jfarcand.wordpress.com/2011/01/12/going-asynchronous-using-asynchttpclient-for-dummies/
-* http://web.archive.org/web/20111224171241/http://jfarcand.wordpress.com/2010/12/21/going-asynchronous-using-asynchttpclient-the-basic/
-* http://web.archive.org/web/20111224162752/http://jfarcand.wordpress.com/2011/01/04/going-asynchronous-using-asynchttpclient-the-complex/
-* http://web.archive.org/web/20120218183108/http://jfarcand.wordpress.com/2011/12/21/writing-websocket-clients-using-asynchttpclient/
-
 ## User Group
 
 Keep up to date on the library development by joining the Asynchronous HTTP Client discussion group
 
 [GitHub Discussions](https://github.com/AsyncHttpClient/async-http-client/discussions)
-
-## Contributing
-
-Of course, Pull Requests are welcome.
-
-Here are the few rules we'd like you to respect if you do so:
-
-* Only edit the code related to the suggested change, so DON'T automatically format the classes you've edited.
-* Use IntelliJ default formatting rules.
-* Regarding licensing:
-    * You must be the original author of the code you suggest.
-    * You must give the copyright to "the AsyncHttpClient Project"
diff --git a/client/pom.xml b/client/pom.xml
@@ -19,7 +19,7 @@
     <parent>
         <groupId>org.asynchttpclient</groupId>
         <artifactId>async-http-client-project</artifactId>
-        <version>3.0.0.Beta3</version>
+        <version>3.0.0</version>
     </parent>
 
     <modelVersion>4.0.0</modelVersion>

diff --git a/client/src/main/java/org/asynchttpclient/BoundRequestBuilder.java b/client/src/main/java/org/asynchttpclient/BoundRequestBuilder.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/ClientStats.java b/client/src/main/java/org/asynchttpclient/ClientStats.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/HostStats.java b/client/src/main/java/org/asynchttpclient/HostStats.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/Param.java b/client/src/main/java/org/asynchttpclient/Param.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/SslEngineFactory.java b/client/src/main/java/org/asynchttpclient/SslEngineFactory.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/channel/ChannelPool.java b/client/src/main/java/org/asynchttpclient/channel/ChannelPool.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/channel/ChannelPoolPartitioning.java b/client/src/main/java/org/asynchttpclient/channel/ChannelPoolPartitioning.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/channel/KeepAliveStrategy.java b/client/src/main/java/org/asynchttpclient/channel/KeepAliveStrategy.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/channel/NoopChannelPool.java b/client/src/main/java/org/asynchttpclient/channel/NoopChannelPool.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/config/AsyncHttpClientConfigDefaults.java b/client/src/main/java/org/asynchttpclient/config/AsyncHttpClientConfigDefaults.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/handler/MaxRedirectException.java b/client/src/main/java/org/asynchttpclient/handler/MaxRedirectException.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/DiscardEvent.java b/client/src/main/java/org/asynchttpclient/netty/DiscardEvent.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/EagerResponseBodyPart.java b/client/src/main/java/org/asynchttpclient/netty/EagerResponseBodyPart.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/LazyResponseBodyPart.java b/client/src/main/java/org/asynchttpclient/netty/LazyResponseBodyPart.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/NettyResponse.java b/client/src/main/java/org/asynchttpclient/netty/NettyResponse.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/NettyResponseFuture.java b/client/src/main/java/org/asynchttpclient/netty/NettyResponseFuture.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/NettyResponseStatus.java b/client/src/main/java/org/asynchttpclient/netty/NettyResponseStatus.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/OnLastHttpContentCallback.java b/client/src/main/java/org/asynchttpclient/netty/OnLastHttpContentCallback.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/ChannelManager.java b/client/src/main/java/org/asynchttpclient/netty/channel/ChannelManager.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/Channels.java b/client/src/main/java/org/asynchttpclient/netty/channel/Channels.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/DefaultChannelPool.java b/client/src/main/java/org/asynchttpclient/netty/channel/DefaultChannelPool.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/NettyConnectListener.java b/client/src/main/java/org/asynchttpclient/netty/channel/NettyConnectListener.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/future/StackTraceInspector.java b/client/src/main/java/org/asynchttpclient/netty/future/StackTraceInspector.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/handler/AsyncHttpClientHandler.java b/client/src/main/java/org/asynchttpclient/netty/handler/AsyncHttpClientHandler.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/handler/HttpHandler.java b/client/src/main/java/org/asynchttpclient/netty/handler/HttpHandler.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/handler/WebSocketHandler.java b/client/src/main/java/org/asynchttpclient/netty/handler/WebSocketHandler.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/request/NettyRequest.java b/client/src/main/java/org/asynchttpclient/netty/request/NettyRequest.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/request/NettyRequestFactory.java b/client/src/main/java/org/asynchttpclient/netty/request/NettyRequestFactory.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/request/NettyRequestSender.java b/client/src/main/java/org/asynchttpclient/netty/request/NettyRequestSender.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/request/WriteProgressListener.java b/client/src/main/java/org/asynchttpclient/netty/request/WriteProgressListener.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/BodyChunkedInput.java b/client/src/main/java/org/asynchttpclient/netty/request/body/BodyChunkedInput.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/BodyFileRegion.java b/client/src/main/java/org/asynchttpclient/netty/request/body/BodyFileRegion.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/NettyBody.java b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyBody.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

diff --git a/client/src/main/java/org/asynchttpclient/netty/request/body/NettyBodyBody.java b/client/src/main/java/org/asynchttpclient/netty/request/body/NettyBodyBody.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright (c) 2014-2023 AsyncHttpClient Project. All rights reserved.
+ *    Copyright (c) 2014-2024 AsyncHttpClient Project. All rights reserved.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.