Cwikius-Spring
/
spring-security
mirror of https://github.com/spring-projects/spring-security.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify ServerBearerExchangeFilterFunction Docs 

Fixes gh-8220
This commit is contained in:
Josh Cummings 2020-03-27 13:23:57 -06:00
parent 636f0b94cf
commit 81ad2958bd
No known key found for this signature in database
GPG Key ID: 49EF60DD7FF83443
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/manual/src/docs/asciidoc/_includes/servlet/oauth2/oauth2-resourceserver.adoc
View File

@ -2020,7 +2020,7 @@ http
=== Bearer Token Propagation === Bearer Token Propagation
Now that you're in possession of a bearer token, it might be handy to pass that to downstream services. Now that you're resource server has validated the token, it might be handy to pass it to downstream services.
This is quite simple with `{security-api-url}org/springframework/security/oauth2/server/resource/web/reactive/function/client/ServletBearerExchangeFilterFunction.html[ServletBearerExchangeFilterFunction]`, which you can see in the following example: This is quite simple with `{security-api-url}org/springframework/security/oauth2/server/resource/web/reactive/function/client/ServletBearerExchangeFilterFunction.html[ServletBearerExchangeFilterFunction]`, which you can see in the following example:
[source,java] [source,java]
@ -2064,12 +2064,12 @@ this.rest.get()
In this case, the filter will fall back and simply forward the request onto the rest of the web filter chain. In this case, the filter will fall back and simply forward the request onto the rest of the web filter chain.
[NOTE] [NOTE]
Unlike the https://docs.spring.io/spring-security/site/docs/current-SNAPSHOT/api/org/springframework/security/oauth2/client/web/reactive/function/client/ServletOAuth2AuthorizedClientExchangeFilterFunction.html[OAuth 2.0 Client filter function], this filter function makes no attempt to renew the token, should it be expired. Unlike the {security-api-url}org/springframework/security/oauth2/client/web/reactive/function/client/ServletOAuth2AuthorizedClientExchangeFilterFunction.html[OAuth 2.0 Client filter function], this filter function makes no attempt to renew the token, should it be expired.
To obtain this level of support, please use the OAuth 2.0 Client filter. To obtain this level of support, please use the OAuth 2.0 Client filter.
==== `RestTemplate` support ==== `RestTemplate` support
There is no dedicated support for `RestTemplate` at the moment, but you can achieve propagation quite simply with your own interceptor: There is no `RestTemplate` equivalent for `ServletBearerExchangeFilterFunction` at the moment, but you can propagate the request's bearer token quite simply with your own interceptor:
[source,java] [source,java]
---- ----
@ -2094,6 +2094,11 @@ RestTemplate rest() {
} }
---- ----
[NOTE]
Unlike the {security-api-url}org/springframework/security/oauth2/client/OAuth2AuthorizedClientManager.html[OAuth 2.0 Authorized Client Manager], this filter interceptor makes no attempt to renew the token, should it be expired.
To obtain this level of support, please create an interceptor using the <<oauth2client,OAuth 2.0 Authorized Client Manager>>.
[[oauth2resourceserver-bearertoken-failure]] [[oauth2resourceserver-bearertoken-failure]]
=== Bearer Token Failure === Bearer Token Failure