Skip to content

Commit 3469bcb

Browse files
committed
Address Antora Warnings
1 parent b4083f1 commit 3469bcb

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

docs/modules/ROOT/pages/reactive/oauth2/login/advanced.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ The Redirection Endpoint is used by the Authorization Server for returning the A
207207
OAuth 2.0 Login leverages the Authorization Code Grant.
208208
Therefore, the authorization credential is the authorization code.
209209

210-
The default Authorization Response redirection endpoint is `/login/oauth2/code/{registrationId}`.
210+
The default Authorization Response redirection endpoint is `+/login/oauth2/code/{registrationId}+`.
211211

212212
If you would like to customize the Authorization Response redirection endpoint, configure it as shown in the following example:
213213

@@ -739,5 +739,5 @@ class OAuth2LoginSecurityConfig {
739739
----
740740
====
741741

742-
NOTE: `OidcClientInitiatedServerLogoutSuccessHandler` supports the `{baseUrl}` placeholder.
742+
NOTE: `OidcClientInitiatedServerLogoutSuccessHandler` supports the `+{baseUrl}+` placeholder.
743743
If used, the application's base URL, like `https://app.example.org`, will replace it at request time.

docs/modules/ROOT/pages/servlet/authentication/persistence.adoc

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,11 @@ The {security-api-url}org/springframework/security/web/context/SecurityContextPe
122122

123123
image::{figures}/securitycontextpersistencefilter.png[]
124124

125-
<1> Before running the rest of the application, `SecurityContextPersistenceFilter` loads the `SecurityContext` from the `SecurityContextRepository` and sets it on the `SecurityContextHolder`.
126-
<2> Next, the application is ran.
127-
<3> Finally, if the `SecurityContext` has changed, we save the `SecurityContext` using the `SecurityContextPersistenceRepository`.
125+
image:{icondir}/number_1.png[] Before running the rest of the application, `SecurityContextPersistenceFilter` loads the `SecurityContext` from the `SecurityContextRepository` and sets it on the `SecurityContextHolder`.
126+
127+
image:{icondir}/number_2.png[] Next, the application is ran.
128+
129+
image:{icondir}/number_3.png[] Finally, if the `SecurityContext` has changed, we save the `SecurityContext` using the `SecurityContextPersistenceRepository`.
128130
This means that when using `SecurityContextPersistenceFilter`, just setting the `SecurityContextHolder` will ensure that the `SecurityContext` is persisted using `SecurityContextRepository`.
129131

130132
In some cases a response is committed and written to the client before the `SecurityContextPersisteneFilter` method completes.
@@ -141,8 +143,9 @@ The {security-api-url}org/springframework/security/web/context/SecurityContextHo
141143

142144
image::{figures}/securitycontextholderfilter.png[]
143145

144-
<1> Before running the rest of the application, `SecurityContextHolderFilter` loads the `SecurityContext` from the `SecurityContextRepository` and sets it on the `SecurityContextHolder`.
145-
<2> Next, the application is ran.
146+
image:{icondir}/number_1.png[] Before running the rest of the application, `SecurityContextHolderFilter` loads the `SecurityContext` from the `SecurityContextRepository` and sets it on the `SecurityContextHolder`.
147+
148+
image:{icondir}/number_2.png[] Next, the application is ran.
146149

147150
Unlike, xref:servlet/authentication/persistence.adoc#securitycontextpersistencefilter[`SecurityContextPersisteneFilter`], `SecurityContextHolderFilter` only loads the `SecurityContext` it does not save the `SecurityContext`.
148151
This means that when using `SecurityContextHolderFilter`, it is required that the `SecurityContext` is explicitly saved.
@@ -169,4 +172,4 @@ public SecurityFilterChain filterChain(HttpSecurity http) {
169172
<!-- ... -->
170173
</http>
171174
----
172-
====
175+
====

docs/modules/ROOT/pages/servlet/oauth2/login/advanced.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -958,5 +958,5 @@ class OAuth2LoginSecurityConfig {
958958
----
959959
====
960960

961-
NOTE: `OidcClientInitiatedLogoutSuccessHandler` supports the `{baseUrl}` placeholder.
961+
NOTE: `OidcClientInitiatedLogoutSuccessHandler` supports the `+{baseUrl}+` placeholder.
962962
If used, the application's base URL, like `https://app.example.org`, will replace it at request time.

0 commit comments

Comments
 (0)