Cwikius-Spring/spring-security
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-security.git synced 2025-05-31 09:12:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Align webclient section level in documentation

Browse Source 
Make "WebClient for Servlet Environments" section level align with
other documents in "additional-topics".
This commit is contained in:
Tadaya Tsuyukubo 2019-04-22 16:46:52 -07:00 committed by Josh Cummings
parent 5aacd0c955
commit 0957ecb1e9
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/manual/src/docs/asciidoc/_includes/servlet/additional-topics/webclient.adoc
View File

@ -1,5 +1,5 @@
[[servlet-webclient]] [[servlet-webclient]]
= WebClient for Servlet Environments == WebClient for Servlet Environments
[NOTE] [NOTE]
==== ====
@ -26,7 +26,7 @@ Spring Security builds on this support to provide additional benefits:
* Support for the ability to transparently include the current OAuth token or explicitly select which token should be used. * Support for the ability to transparently include the current OAuth token or explicitly select which token should be used.
[[servlet-webclient-setup]] [[servlet-webclient-setup]]
== WebClient OAuth2 Setup === WebClient OAuth2 Setup
The first step is ensuring to setup the `WebClient` correctly. The first step is ensuring to setup the `WebClient` correctly.
An example of setting up `WebClient` in a servlet environment can be found below: An example of setting up `WebClient` in a servlet environment can be found below:
@ -49,7 +49,7 @@ WebClient webClient(ClientRegistrationRepository clientRegistrations,
---- ----
[[servlet-webclient-implicit]] [[servlet-webclient-implicit]]
== Implicit OAuth2AuthorizedClient === Implicit OAuth2AuthorizedClient
If we set `defaultOAuth2AuthorizedClient` to `true` in our setup and the user authenticated with oauth2Login (i.e. OIDC), then the current authentication is used to automatically provide the access token. If we set `defaultOAuth2AuthorizedClient` to `true` in our setup and the user authenticated with oauth2Login (i.e. OIDC), then the current authentication is used to automatically provide the access token.
Alternatively, if we set `defaultClientRegistrationId` to a valid `ClientRegistration` id, that registration is used to provide the access token. Alternatively, if we set `defaultClientRegistrationId` to a valid `ClientRegistration` id, that registration is used to provide the access token.
@ -65,7 +65,7 @@ Mono<String> body = this.webClient
---- ----
[[servlet-webclient-explicit]] [[servlet-webclient-explicit]]
== Explicit OAuth2AuthorizedClient === Explicit OAuth2AuthorizedClient
The `OAuth2AuthorizedClient` can be explicitly provided by setting it on the request attributes. The `OAuth2AuthorizedClient` can be explicitly provided by setting it on the request attributes.
In the example below we resolve the `OAuth2AuthorizedClient` using Spring WebFlux or Spring MVC argument resolver support. In the example below we resolve the `OAuth2AuthorizedClient` using Spring WebFlux or Spring MVC argument resolver support.
@ -86,7 +86,7 @@ Mono<String> explicit(@RegisteredOAuth2AuthorizedClient("client-id") OAuth2Autho
[[servlet-webclient-clientregistrationid]] [[servlet-webclient-clientregistrationid]]
== clientRegistrationId === clientRegistrationId
Alternatively, it is possible to specify the `clientRegistrationId` on the request attributes and the `WebClient` will attempt to lookup the `OAuth2AuthorizedClient`. Alternatively, it is possible to specify the `clientRegistrationId` on the request attributes and the `WebClient` will attempt to lookup the `OAuth2AuthorizedClient`.
If it is not found, one will automatically be acquired. If it is not found, one will automatically be acquired.