Skip to content

Commit 9da1bba

Browse files
committed
Document AHC versioning and add more 2.1 API changes, close AsyncHttpClient#1501
Motivation: Users might expect SEMVER and would get suprised when upgrading. Modification: * Explain AHC versioning in README.md * Document some AHC config changes that were missing from CHANGES.md Result: Version explained
1 parent f00c941 commit 9da1bba

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

CHANGES.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,11 @@
77
* `AsyncHttpClient` now exposes stats with `getClientStats`.
88
* `AsyncHandlerExtensions` was dropped in favor of default methods in `AsyncHandler`.
99
* `WebSocket` and `WebSocketListener` methods were renamed to mention frames
10-
* `AsyncHttpClientConfig#isAggregateWebSocketFrameFragments` now lets you disable WebSocket fragmented frames aggregation
10+
* `AsyncHttpClientConfig` various changes:
11+
* new `getCookieStore` now lets you configure a CookieStore (enabled by default)
12+
* new `isAggregateWebSocketFrameFragments` now lets you disable WebSocket fragmented frames aggregation
13+
* new `isUseLaxCookieEncoder` lets you loosen cookie chars validation
14+
* `isAcceptAnyCertificate` was dropped, as it didn't do what its name stated
15+
* new `isUseInsecureTrustManager` lets you use a permissive TrustManager, that would typically let you accept self-signed certificates
16+
* new `isDisableHttpsEndpointIdentificationAlgorithm` disables setting `HTTPS` algorithm on the SSLEngines, typically disables SNI and HTTPS hostname verification
17+
* new `isAggregateWebSocketFrameFragments` lets you disable fragmented WebSocket frames aggregation

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,16 @@ Binaries are deployed on Maven central:
1919
</dependency>
2020
```
2121

22+
## Version
23+
24+
AHC doesn't use SEMVER, and won't.
25+
26+
* MAJOR = huge refactoring
27+
* MINOR = new features and minor API changes, upgrading should require 1 hour of work to adapt sources
28+
* FIX = no API change, just bug fixes, only those are source and binary compatible with same minor version
29+
30+
Check CHANGES.md for migration path between versions.
31+
2232
## Basics
2333

2434
Feel free to check the [Javadoc](http://www.javadoc.io/doc/org.asynchttpclient/async-http-client/) or the code for more information.

0 commit comments

Comments
 (0)