Skip to content

Commit 2966fea

Browse files
breunslandelle
breun
authored and
slandelle
committed
Add async-http-client-bom (#1680)
* Added async-http-client-bom
1 parent c5eff42 commit 2966fea

File tree

4 files changed

+138
-6
lines changed

4 files changed

+138
-6
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@ test-output
1818
MANIFEST.MF
1919
work
2020
atlassian-ide-plugin.xml
21+
/bom/.flattened-pom.xml

‎README.md

+27-6
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,37 @@ It's built on top of [Netty](https://github.com/netty/netty). It's currently com
99

1010
## Installation
1111

12-
Binaries are deployed on Maven central:
12+
Binaries are deployed on Maven Central.
13+
14+
Import the AsyncHttpClient Bill of Materials (BOM) to add dependency management for AsyncHttpClient artifacts to your project:
15+
16+
```xml
17+
<dependencyManagement>
18+
<dependencies>
19+
<dependency>
20+
<groupId>org.asynchttpclient</groupId>
21+
<artifactId>async-http-client-bom</artifactId>
22+
<version>LATEST_VERSION</version>
23+
<type>pom</type>
24+
<scope>import</scope>
25+
</dependency>
26+
</dependencies>
27+
</dependencyManagement>
28+
```
29+
30+
Add a dependency on the main AsyncHttpClient artifact:
1331

1432
```xml
15-
<dependency>
16-
<groupId>org.asynchttpclient</groupId>
17-
<artifactId>async-http-client</artifactId>
18-
<version>LATEST_VERSION</version>
19-
</dependency>
33+
<dependencies>
34+
<dependency>
35+
<groupId>org.asynchttpclient</groupId>
36+
<artifactId>async-http-client</artifactId>
37+
</dependency>
38+
</dependencies>
2039
```
2140

41+
The `async-http-client-extras-*` and other modules can also be added without having to specify the version for each dependency, because they are all managed via the BOM.
42+
2243
## Version
2344

2445
AHC doesn't use SEMVER, and won't.

‎bom/pom.xml

+109
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
4+
<modelVersion>4.0.0</modelVersion>
5+
6+
<parent>
7+
<groupId>org.asynchttpclient</groupId>
8+
<artifactId>async-http-client-project</artifactId>
9+
<version>2.10.5-SNAPSHOT</version>
10+
</parent>
11+
12+
<artifactId>async-http-client-bom</artifactId>
13+
<packaging>pom</packaging>
14+
<name>Asynchronous Http Client Bill of Materials (BOM)</name>
15+
<description>Importing this BOM will provide dependency management for all AsyncHttpClient artifacts.</description>
16+
<url>http://github.com/AsyncHttpClient/async-http-client/bom</url>
17+
18+
<dependencyManagement>
19+
<dependencies>
20+
<dependency>
21+
<groupId>org.asynchttpclient</groupId>
22+
<artifactId>async-http-client</artifactId>
23+
<version>${project.version}</version>
24+
</dependency>
25+
<dependency>
26+
<groupId>org.asynchttpclient</groupId>
27+
<artifactId>async-http-client-example</artifactId>
28+
<version>${project.version}</version>
29+
</dependency>
30+
<dependency>
31+
<groupId>org.asynchttpclient</groupId>
32+
<artifactId>async-http-client-extras-guava</artifactId>
33+
<version>${project.version}</version>
34+
</dependency>
35+
<dependency>
36+
<groupId>org.asynchttpclient</groupId>
37+
<artifactId>async-http-client-extras-jdeferred</artifactId>
38+
<version>${project.version}</version>
39+
</dependency>
40+
<dependency>
41+
<groupId>org.asynchttpclient</groupId>
42+
<artifactId>async-http-client-extras-registry</artifactId>
43+
<version>${project.version}</version>
44+
</dependency>
45+
<dependency>
46+
<groupId>org.asynchttpclient</groupId>
47+
<artifactId>async-http-client-extras-retrofit2</artifactId>
48+
<version>${project.version}</version>
49+
</dependency>
50+
<dependency>
51+
<groupId>org.asynchttpclient</groupId>
52+
<artifactId>async-http-client-extras-rxjava</artifactId>
53+
<version>${project.version}</version>
54+
</dependency>
55+
<dependency>
56+
<groupId>org.asynchttpclient</groupId>
57+
<artifactId>async-http-client-extras-rxjava2</artifactId>
58+
<version>${project.version}</version>
59+
</dependency>
60+
<dependency>
61+
<groupId>org.asynchttpclient</groupId>
62+
<artifactId>async-http-client-extras-simple</artifactId>
63+
<version>${project.version}</version>
64+
</dependency>
65+
<dependency>
66+
<groupId>org.asynchttpclient</groupId>
67+
<artifactId>async-http-client-extras-typesafe-config</artifactId>
68+
<version>${project.version}</version>
69+
</dependency>
70+
<dependency>
71+
<groupId>org.asynchttpclient</groupId>
72+
<artifactId>async-http-client-netty-utils</artifactId>
73+
<version>${project.version}</version>
74+
</dependency>
75+
</dependencies>
76+
</dependencyManagement>
77+
78+
<build>
79+
<plugins>
80+
<plugin>
81+
<!-- This plugins allows using a parent for this file, so project.version can be resolved.
82+
A clean BOM without a reference to a parent is generated, so that transitive dependencies will
83+
not be included and cannot interfere with projects that use this BOM. -->
84+
<groupId>org.codehaus.mojo</groupId>
85+
<artifactId>flatten-maven-plugin</artifactId>
86+
<version>1.1.0</version>
87+
<inherited>false</inherited>
88+
<executions>
89+
<execution>
90+
<id>flatten</id>
91+
<phase>process-resources</phase>
92+
<goals>
93+
<goal>flatten</goal>
94+
</goals>
95+
<configuration>
96+
<flattenMode>bom</flattenMode>
97+
<pomElements>
98+
<properties>remove</properties>
99+
<dependencies>remove</dependencies>
100+
<build>remove</build>
101+
<scm>remove</scm>
102+
</pomElements>
103+
</configuration>
104+
</execution>
105+
</executions>
106+
</plugin>
107+
</plugins>
108+
</build>
109+
</project>

‎pom.xml

+1
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,7 @@
240240
</repository>
241241
</distributionManagement>
242242
<modules>
243+
<module>bom</module>
243244
<module>netty-utils</module>
244245
<module>client</module>
245246
<module>extras</module>

0 commit comments

Comments
 (0)