From 3d47188334c2a011f91c8c5a5ab6a337ad8b7b3f Mon Sep 17 00:00:00 2001 From: Ryan Baxter Date: Sun, 9 Jul 2017 14:15:11 -0400 Subject: [PATCH] Added documentation --- docs/src/main/asciidoc/spring-cloud-commons.adoc | 13 +++++++++++++ .../commons/httpclient/HttpClientConfiguration.java | 4 ++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/src/main/asciidoc/spring-cloud-commons.adoc b/docs/src/main/asciidoc/spring-cloud-commons.adoc index b9921306..0dc29a29 100644 --- a/docs/src/main/asciidoc/spring-cloud-commons.adoc +++ b/docs/src/main/asciidoc/spring-cloud-commons.adoc @@ -487,3 +487,16 @@ spring: inetutils: useOnlySiteLocalInterfaces: true ---- + +[[http-clients]] +=== HTTP Client Factories + +Spring Cloud Commons provides beans for creating both Apache HTTP clients (`ApacheHttpClientFactory`) +as well as OK HTTP clients (`OkHttpClientFactory`). The `OkHttpClientFactory` bean will only be created +if the OK HTTP jar is on the classpath. In addition, Spring Cloud Commons provides beans for creating +the connection managers used by both clients, `ApacheHttpClientConnectionManagerFactory` for the Apache +HTTP client and `OkHttpClientConnectionPoolFactory` for the OK HTTP client. You can provide +your own implementation of these beans if you would like to customize how the HTTP clients are created +in downstream projects. You can also disable the creation of these beans by setting +`spring.cloud.httpclientfactories.apache.enabled` or `spring.cloud.httpclientfactories.ok.enabled` to +`false`. \ No newline at end of file diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/commons/httpclient/HttpClientConfiguration.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/commons/httpclient/HttpClientConfiguration.java index f992ff17..df3de178 100644 --- a/spring-cloud-commons/src/main/java/org/springframework/cloud/commons/httpclient/HttpClientConfiguration.java +++ b/spring-cloud-commons/src/main/java/org/springframework/cloud/commons/httpclient/HttpClientConfiguration.java @@ -15,7 +15,7 @@ import org.springframework.context.annotation.Configuration; public class HttpClientConfiguration { @Configuration - @ConditionalOnProperty(name = "spring.cloud.httpclient.apache.enabled", matchIfMissing = true) + @ConditionalOnProperty(name = "spring.cloud.httpclientfactories.apache.enabled", matchIfMissing = true) static class ApacheHttpClientConfiguration { @Bean @@ -32,7 +32,7 @@ public class HttpClientConfiguration { } @Configuration - @ConditionalOnProperty(name = "spring.cloud.httpclient.ok.enabled", matchIfMissing = true) + @ConditionalOnProperty(name = "spring.cloud.httpclientfactories.ok.enabled", matchIfMissing = true) @ConditionalOnClass(OkHttpClient.class) static class OkHttpClientConfiguration {