Skip to content

Modify the dependency httpclient5 to httpclient4. #20191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yiliuTo merged 14 commits into from
Apr 8, 2021
Merged

Modify the dependency httpclient5 to httpclient4. #20191

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
c40f0e0
Modify the dependency httpclient5 to httpclient4.
Mar 29, 2021
8d184b8
remove the dependency of sample and test.
Mar 29, 2021
25cbc6b
Merge branch 'master' of git://github.com/Azure/azure-sdk-for-java in…
Mar 30, 2021
608bc86
solve Conflict.
Mar 30, 2021
a3a5f4d
fix the pipeline failure.
Mar 30, 2021
bab3f70
fix the pipeline failure.
Mar 30, 2021
d438e03
fix the pipeline failure.
Mar 31, 2021
3665881
fix the pipeline failure.
Mar 31, 2021
d35e2c1
Merge branch 'master' of git://github.com/Azure/azure-sdk-for-java in…
Apr 1, 2021
f5e3d65
Modify method name.
Apr 1, 2021
51562f3
Merge branch 'master' of git://github.com/Azure/azure-sdk-for-java in…
Apr 1, 2021
c1ba7ac
add httpclient dependency for Server-side sample.
Apr 2, 2021
b8d1bd7
Modify README.md for azure-spring-boot-sample-keyvault-certificates-c…
Apr 2, 2021
db60d51
improve README.md for keyvault sample.
Apr 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions eng/code-quality-reports/src/main/resources/revapi/revapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,47 @@
"exampleUseChainInNewApi": ".*com\\.azure\\.core\\.util\\.serializer\\.JacksonAdapter.*",
"justification": "We allow this in com.azure.core.util.serializer.JacksonAdapter."
},
{
"regex": true,
"code": "java\\.missing\\.(oldClass|newClass)",
"new": "missing\\-class javax\\.servlet\\.ServletContextEvent",
"exampleUseChainInNewApi": ".*com\\.azure\\.keyvault\\.jca\\.org\\.apache\\.commons\\.logging\\.impl.*",
"justification": "We allow this in com.azure.keyvault.jca.org.apache.commons.logging.impl.ServletContextCleaner"
},
{
"regex": true,
"code": "java\\.missing\\.(oldClass|newClass)",
"new": "missing\\-class org\\.apache\\.avalon\\.framework\\.logger\\.Logger",
"exampleUseChainInNewApi": ".*com\\.azure\\.keyvault\\.jca\\.org\\.apache\\.commons\\.logging\\.impl\\.AvalonLogger.*",
"justification": "We allow this in com.azure.keyvault.jca.org.apache.commons.logging.impl.AvalonLogger"
},
{
"regex": true,
"code": "java\\.missing\\.(oldClass|newClass)",
"new": "missing\\-class org\\.apache\\.log\\.Logger",
"exampleUseChainInNewApi": ".*com\\.azure\\.keyvault\\.jca\\.org\\.apache\\.commons\\.logging\\.impl\\.LogKitLogger.*",
"justification": "We allow this in com.azure.keyvault.jca.org.apache.commons.logging.impl.LogKitLogger"
},
{
"regex": true,
"code": "java\\.missing\\.(oldClass|newClass)",
"new": "missing\\-class org\\.apache\\.log4j\\.Logger",
"exampleUseChainInNewApi": ".*com\\.azure\\.keyvault\\.jca\\.org\\.apache\\.commons\\.logging\\.impl\\.Log4JLogger.*",
"justification": "We allow this in com.azure.keyvault.jca.org.apache.commons.logging.impl.Log4JLogger"
},
{
"regex": true,
"code": "java.class.nonPublicPartOfAPI",
"new": "class org.apache.http.impl.client.HttpRequestTaskCallable<V extends java.lang.Object>",
"justification": "We allow this in org.apache.http.impl.client.HttpRequestFutureTask<V>"
},
{
"regex": true,
"code": "java.class.nonPublicPartOfAPI",
"new": "(class|interface) org\\.apache\\.http\\.impl\\.conn\\.CPoolEntry",
"exampleUseChainInNewApi": ".*org\\.apache\\.http\\.HttpClientConnection.*",
"justification": "We allow this in org.apache.http.HttpClientConnection>"
},
{
"regex": true,
"code": "java.class.nonPublicPartOfAPI",
Expand Down
1 change: 0 additions & 1 deletion eng/versioning/external_dependencies.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ org.apache.avro:avro-maven-plugin;1.10.1
org.apache.commons:commons-compress;1.20
org.apache.commons:commons-lang3;3.11
org.apache.httpcomponents:httpclient;4.5.13
org.apache.httpcomponents.client5:httpclient5;5.0.3
org.apache.logging.log4j:log4j-api;2.13.3
org.apache.logging.log4j:log4j-core;2.13.3
org.apache.logging.log4j:log4j-slf4j-impl;2.13.3
Expand Down
21 changes: 9 additions & 12 deletions sdk/keyvault/azure-security-keyvault-jca/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Note if you want to use Azure Managed Identity, you should set the value of `azu
### Client side SSL
If you are looking to integrate the JCA provider for client side socket connections, see the Apache HTTP client example below.

<!-- embedme ./src/samples/java/com/azure/security/keyvault/jca/ClientSSLSample.java#L28-L71 -->
<!-- embedme ./src/samples/java/com/azure/security/keyvault/jca/ClientSSLSample.java#L28-L68 -->
```java
KeyVaultJcaProvider provider = new KeyVaultJcaProvider();
Security.addProvider(provider);
Expand All @@ -86,23 +86,20 @@ SSLContext sslContext = SSLContexts
.loadTrustMaterial(keyStore, new TrustSelfSignedStrategy())
.build();

SSLConnectionSocketFactory factory = SSLConnectionSocketFactoryBuilder
.create()
.setSslContext(sslContext)
.setHostnameVerifier((hostname, session) -> true)
.build();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(
sslContext, (hostname, session) -> true);

PoolingHttpClientConnectionManager manager = PoolingHttpClientConnectionManagerBuilder
.create()
.setSSLSocketFactory(factory)
.build();
PoolingHttpClientConnectionManager manager = new PoolingHttpClientConnectionManager(
RegistryBuilder.<ConnectionSocketFactory>create()
.register("https", sslConnectionSocketFactory)
.build());

String result = null;

try (CloseableHttpClient client = HttpClients.custom().setConnectionManager(manager).build()) {
HttpGet httpGet = new HttpGet("https://localhost:8766");
HttpClientResponseHandler<String> responseHandler = (ClassicHttpResponse response) -> {
int status = response.getCode();
ResponseHandler<String> responseHandler = (HttpResponse response) -> {
int status = response.getStatusLine().getStatusCode();
String result1 = "Not success";
if (status == 204) {
result1 = "Success";
Expand Down
12 changes: 4 additions & 8 deletions sdk/keyvault/azure-security-keyvault-jca/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,6 @@
<pattern>org.apache.commons</pattern>
<shadedPattern>com.azure.keyvault.jca.org.apache.commons</shadedPattern>
</relocation>
<relocation>
<pattern>org.apache.hc</pattern>
<shadedPattern>com.azure.keyvault.jca.org.apache.hc</shadedPattern>
</relocation>
<relocation>
<pattern>mozilla</pattern>
<shadedPattern>com.azure.keyvault.jca.mozilla</shadedPattern>
Expand Down Expand Up @@ -114,8 +110,8 @@
<bannedDependencies>
<includes>
<include>com.fasterxml.jackson.core:jackson-databind:[2.12.2]</include> <!-- {x-include-update;com.fasterxml.jackson.core:jackson-databind;external_dependency} -->
<include>org.apache.httpcomponents.client5:httpclient5:[5.0.3]</include> <!-- {x-include-update;org.apache.httpcomponents.client5:httpclient5;external_dependency} -->
<include>org.conscrypt:conscrypt-openjdk-uber:[2.2.1]</include> <!-- {x-include-update;org.conscrypt:conscrypt-openjdk-uber;external_dependency} -->
<include>org.apache.httpcomponents:httpclient:[4.5.13]</include> <!-- {x-include-update;org.apache.httpcomponents:httpclient;external_dependency} -->
<include>org.slf4j:slf4j-nop:[1.7.30]</include> <!-- {x-include-update;org.slf4j:slf4j-nop;external_dependency} -->
</includes>
</bannedDependencies>
Expand All @@ -127,9 +123,9 @@
<dependencies>
<!-- Apache HttpClient -->
<dependency>
<groupId>org.apache.httpcomponents.client5</groupId>
<artifactId>httpclient5</artifactId>
<version>5.0.3</version> <!-- {x-version-update;org.apache.httpcomponents.client5:httpclient5;external_dependency} -->
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.13</version> <!-- {x-version-update;org.apache.httpcomponents:httpclient;external_dependency} -->
<optional>true</optional>
</dependency>
<!-- Conscrypt -->
Expand Down
57 changes: 26 additions & 31 deletions ...security-keyvault-jca/src/main/java/com/azure/security/keyvault/jca/LegacyRestClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
// Licensed under the MIT License.
package com.azure.security.keyvault.jca;

import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.classic.methods.HttpPost;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClients;
import org.apache.hc.core5.http.ClassicHttpResponse;
import org.apache.hc.core5.http.ContentType;
import org.apache.hc.core5.http.HttpEntity;
import org.apache.hc.core5.http.io.HttpClientResponseHandler;
import org.apache.hc.core5.http.io.entity.EntityUtils;
import org.apache.hc.core5.http.io.entity.HttpEntities;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.ResponseHandler;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

import java.io.IOException;
import java.util.Map;
Expand Down Expand Up @@ -39,16 +39,7 @@ public String get(String url, Map<String, String> headers) {
httpGet.addHeader(key, value);
});
}
HttpClientResponseHandler<String> responseHandler = (ClassicHttpResponse response) -> {
int status = response.getCode();
String result1 = null;
if (status >= 200 && status < 300) {
HttpEntity entity = response.getEntity();
result1 = entity != null ? EntityUtils.toString(entity) : null;
}
return result1;
};
result = client.execute(httpGet, responseHandler);
result = client.execute(httpGet, responseHandler());
} catch (IOException ioe) {
ioe.printStackTrace();
}
Expand All @@ -60,20 +51,24 @@ public String post(String url, String body, String contentType) {
String result = null;
try (CloseableHttpClient client = HttpClients.createDefault()) {
HttpPost httpPost = new HttpPost(url);
httpPost.setEntity(HttpEntities.create(body, ContentType.create(contentType)));
HttpClientResponseHandler<String> responseHandler = (ClassicHttpResponse response) -> {
int status = response.getCode();
String result1 = null;
if (status >= 200 && status < 300) {
HttpEntity entity = response.getEntity();
result1 = entity != null ? EntityUtils.toString(entity) : null;
}
return result1;
};
result = client.execute(httpPost, responseHandler);
httpPost.setEntity(
new StringEntity(body, ContentType.create(contentType)));
result = client.execute(httpPost, responseHandler());
} catch (IOException ioe) {
ioe.printStackTrace();
}
return result;
}

private ResponseHandler<String> responseHandler() {

@yiliuTo yiliuTo Apr 1, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we change the function name to "createResponseHandler"

@han-gao han-gao Apr 1, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, it's easier to understand.

return (HttpResponse response) -> {
int status = response.getStatusLine().getStatusCode();
String result1 = null;
if (status >= 200 && status < 300) {
HttpEntity entity = response.getEntity();
result1 = entity != null ? EntityUtils.toString(entity) : null;
}
return result1;
};
}
}
41 changes: 19 additions & 22 deletions ...curity-keyvault-jca/src/samples/java/com/azure/security/keyvault/jca/ClientSSLSample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
// Licensed under the MIT License.
package com.azure.security.keyvault.jca;

import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClients;
import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager;
import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder;
import org.apache.hc.client5.http.ssl.SSLConnectionSocketFactory;
import org.apache.hc.client5.http.ssl.SSLConnectionSocketFactoryBuilder;
import org.apache.hc.client5.http.ssl.TrustSelfSignedStrategy;
import org.apache.hc.core5.http.ClassicHttpResponse;
import org.apache.hc.core5.http.io.HttpClientResponseHandler;
import org.apache.hc.core5.ssl.SSLContexts;
import org.apache.http.HttpResponse;
import org.apache.http.client.ResponseHandler;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.config.RegistryBuilder;
import org.apache.http.conn.socket.ConnectionSocketFactory;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.ssl.SSLContexts;
import org.apache.http.conn.ssl.TrustSelfSignedStrategy;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.impl.conn.PoolingHttpClientConnectionManager;

import javax.net.ssl.SSLContext;
import java.io.IOException;
Expand Down Expand Up @@ -42,23 +42,20 @@ public static void main(String[] args) throws Exception {
.loadTrustMaterial(keyStore, new TrustSelfSignedStrategy())
.build();

SSLConnectionSocketFactory factory = SSLConnectionSocketFactoryBuilder
.create()
.setSslContext(sslContext)
.setHostnameVerifier((hostname, session) -> true)
.build();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(
sslContext, (hostname, session) -> true);

PoolingHttpClientConnectionManager manager = PoolingHttpClientConnectionManagerBuilder
.create()
.setSSLSocketFactory(factory)
.build();
PoolingHttpClientConnectionManager manager = new PoolingHttpClientConnectionManager(
RegistryBuilder.<ConnectionSocketFactory>create()
.register("https", sslConnectionSocketFactory)
.build());

String result = null;

try (CloseableHttpClient client = HttpClients.custom().setConnectionManager(manager).build()) {
HttpGet httpGet = new HttpGet("https://localhost:8766");
HttpClientResponseHandler<String> responseHandler = (ClassicHttpResponse response) -> {
int status = response.getCode();
ResponseHandler<String> responseHandler = (HttpResponse response) -> {
int status = response.getStatusLine().getStatusCode();
String result1 = "Not success";
if (status == 204) {
result1 = "Success";
Expand Down
64 changes: 29 additions & 35 deletions ...security-keyvault-jca/src/test/java/com/azure/security/keyvault/jca/ServerSocketTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@

package com.azure.security.keyvault.jca;

import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClients;
import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager;
import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder;
import org.apache.hc.client5.http.ssl.SSLConnectionSocketFactory;
import org.apache.hc.client5.http.ssl.SSLConnectionSocketFactoryBuilder;
import org.apache.hc.client5.http.ssl.TrustSelfSignedStrategy;
import org.apache.hc.core5.http.ClassicHttpResponse;
import org.apache.hc.core5.http.io.HttpClientResponseHandler;
import org.apache.hc.core5.ssl.SSLContexts;
import org.apache.http.HttpResponse;
import org.apache.http.client.ResponseHandler;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.config.RegistryBuilder;
import org.apache.http.conn.socket.ConnectionSocketFactory;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.conn.ssl.TrustSelfSignedStrategy;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.impl.conn.PoolingHttpClientConnectionManager;
import org.apache.http.ssl.SSLContexts;
import org.junit.jupiter.api.Test;

import javax.net.ssl.KeyManagerFactory;
Expand Down Expand Up @@ -104,26 +104,23 @@ public void testServerSocket() throws Exception {
.loadTrustMaterial((final X509Certificate[] chain, final String authType) -> true)
.build();

SSLConnectionSocketFactory sslSocketFactory = SSLConnectionSocketFactoryBuilder
.create()
.setSslContext(sslContext)
.setHostnameVerifier((hostname, session) -> true)
.build();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(
sslContext, (hostname, session) -> true);

PoolingHttpClientConnectionManager cm = PoolingHttpClientConnectionManagerBuilder
.create()
.setSSLSocketFactory(sslSocketFactory)
.build();
PoolingHttpClientConnectionManager manager = new PoolingHttpClientConnectionManager(
RegistryBuilder.<ConnectionSocketFactory>create()
.register("https", sslConnectionSocketFactory)
.build());

/*
* And now execute the test.
*/
String result = null;

try (CloseableHttpClient client = HttpClients.custom().setConnectionManager(cm).build()) {
try (CloseableHttpClient client = HttpClients.custom().setConnectionManager(manager).build()) {
HttpGet httpGet = new HttpGet("https://localhost:8765");
HttpClientResponseHandler<String> responseHandler = (ClassicHttpResponse response) -> {
int status = response.getCode();
ResponseHandler<String> responseHandler = (HttpResponse response) -> {
int status = response.getStatusLine().getStatusCode();
String result1 = null;
if (status == 204) {
result1 = "Success";
Expand Down Expand Up @@ -210,26 +207,23 @@ public void testServerSocketWithSelfSignedClientTrust() throws Exception {
.loadTrustMaterial(ks, new TrustSelfSignedStrategy())
.build();

SSLConnectionSocketFactory sslSocketFactory = SSLConnectionSocketFactoryBuilder
.create()
.setSslContext(sslContext)
.setHostnameVerifier((hostname, session) -> true)
.build();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(
sslContext, (hostname, session) -> true);

PoolingHttpClientConnectionManager cm = PoolingHttpClientConnectionManagerBuilder
.create()
.setSSLSocketFactory(sslSocketFactory)
.build();
PoolingHttpClientConnectionManager manager = new PoolingHttpClientConnectionManager(
RegistryBuilder.<ConnectionSocketFactory>create()
.register("https", sslConnectionSocketFactory)
.build());

/*
* And now execute the test.
*/
String result = null;

try (CloseableHttpClient client = HttpClients.custom().setConnectionManager(cm).build()) {
try (CloseableHttpClient client = HttpClients.custom().setConnectionManager(manager).build()) {
HttpGet httpGet = new HttpGet("https://localhost:8766");
HttpClientResponseHandler<String> responseHandler = (ClassicHttpResponse response) -> {
int status = response.getCode();
ResponseHandler<String> responseHandler = (HttpResponse response) -> {
int status = response.getStatusLine().getStatusCode();
String result1 = null;
if (status == 204) {
result1 = "Success";
Expand Down