SpringCloud/spring-cloud-openfeign
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

gh-631 - Add support for customizing OAuth2FeignReqeustInterceptor.accessTokenProvider (injecting e.g. LoadBalancerInterceptor) (#642)

Browse Source
This commit is contained in:
voytech.m
2021-12-13 18:07:41 +01:00
committed by GitHub
parent bf1aa72fad
commit 7f91d7ec5a
10 changed files with 438 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/src/main/asciidoc/_configprops.adoc
View File

@@ -30,5 +30,6 @@
|feign.httpclient.time-to-live-unit | |
|feign.metrics.enabled | `true` | Enables metrics capability for Feign.
|feign.okhttp.enabled | `false` | Enables the use of the OK HTTP Client by Feign.
|===
|feign.oauth2.enabled | `false` | Enables the use OAuth2FeignRequestInterceptor to resolve access token.
|feign.oauth2.load-balanced | `false` | Enables `LoadBalancerInterceptor` or `RetryloadBalancerInterceptor` for `OAuth2FeignRequestInterceptor.accessTokenProvider` to use load balancing when resolving authentication token.
|===

10
docs/src/main/asciidoc/spring-cloud-openfeign.adoc
View File

@@ -761,6 +761,16 @@ feign.client.refresh-enabled=true
----
TIP: DO NOT annotate the `@FeignClient` interface with the `@RefreshScope` annotation.
=== OAuth2 Support
OAuth2 support can be enabled by setting following flag:
----
feign.oauth2.enabled=true
----
When the flag is set to true, and the oauth2 client context resource details are present, a bean of class `OAuth2FeignRequestInterceptor` is created. Before each request, the interceptor resolves the required access token and includes it as a header.
Sometimes, when load balancing is enabled for Feign clients, you may want to use load balancing for fetching access tokens, too. To do so, you should ensure that the load balancer is on the classpath (spring-cloud-starter-loadbalancer) and explicitly enable load balancing for OAuth2FeignRequestInterceptor by setting the following flag:
----
feign.oauth2.load-balanced=true
----
== Configuration properties