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

Polish migration doc

Browse Source 
Issue gh-12023
This commit is contained in:
Steve Riesenberg 2022-11-14 10:27:19 -06:00
parent 2a6123a456
commit 03b407a49a
No known key found for this signature in database
GPG Key ID: 5F311AB48A55D521
1 changed files with 7 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/modules/ROOT/pages/migration.adoc
View File

@ -373,23 +373,15 @@ With the addition of xref:servlet/authentication/persistence.adoc#delegatingsecu
In Spring Security 6, the deprecated method was removed. In Spring Security 6, the deprecated method was removed.
If you have implemented `SecurityContextRepository` yourself and added an implementation of the `loadContext(request)` method, you can prepare for Spring Security 6 by removing the implementation of that method and implementing the new method instead. If you have implemented `SecurityContextRepository` yourself and added an implementation of the `loadContext(request)` method, you can prepare for Spring Security 6 by removing the implementation of that method and implementing the new method instead.
To get started implementing the new method, use the following example that adapts a `Supplier<SecurityContext>` to provide a `DeferredSecurityContext`: To get started implementing the new method, use the following example to provide a `DeferredSecurityContext`:
[NOTE] .Provide `DeferredSecurityContext`
====
The adapted `Supplier` should return `null` when no `SecurityContext` is available, which was not the case with the `Supplier` returned from `loadContext(request)`.
====
.Adapt `Supplier<SecurityContext>` to `DeferredSecurityContext`
==== ====
.Java .Java
[source,java,role="primary"] [source,java,role="primary"]
---- ----
@Override @Override
public DeferredSecurityContext loadDeferredContext(HttpServletRequest request) { public DeferredSecurityContext loadDeferredContext(HttpServletRequest request) {
// Adapt a supplier that returns null when the context is not available
Supplier<SecurityContext> supplier = () -> getContextOrNull(request);
SecurityContextHolderStrategy strategy = SecurityContextHolder.getContextHolderStrategy();
return new DeferredSecurityContext() { return new DeferredSecurityContext() {
private SecurityContext securityContext; private SecurityContext securityContext;
private boolean isGenerated; private boolean isGenerated;
@ -397,8 +389,9 @@ public DeferredSecurityContext loadDeferredContext(HttpServletRequest request) {
@Override @Override
public SecurityContext get() { public SecurityContext get() {
if (this.securityContext == null) { if (this.securityContext == null) {
this.securityContext = supplier.get(); this.securityContext = getContextOrNull(request);
if (this.securityContext == null) { if (this.securityContext == null) {
SecurityContextHolderStrategy strategy = SecurityContextHolder.getContextHolderStrategy();
this.securityContext = strategy.createEmptyContext(); this.securityContext = strategy.createEmptyContext();
this.isGenerated = true; this.isGenerated = true;
} }
@ -419,19 +412,15 @@ public DeferredSecurityContext loadDeferredContext(HttpServletRequest request) {
[source,kotlin,role="secondary"] [source,kotlin,role="secondary"]
---- ----
override fun loadDeferredContext(request: HttpServletRequest): DeferredSecurityContext { override fun loadDeferredContext(request: HttpServletRequest): DeferredSecurityContext {
// Adapt a supplier that returns null when the context is not available
val supplier: Supplier<SecurityContext?> = SingletonSupplier.of {
getContextOrNull(request)
}
val strategy = SecurityContextHolder.getContextHolderStrategy()
return object : DeferredSecurityContext { return object : DeferredSecurityContext {
private var securityContext: SecurityContext? = null private var securityContext: SecurityContext? = null
private var isGenerated = false private var isGenerated = false
override fun get(): SecurityContext { override fun get(): SecurityContext {
if (securityContext == null) { if (securityContext == null) {
securityContext = supplier.get() securityContext = getContextOrNull(request)
?: strategy.createEmptyContext().also { isGenerated = true } ?: SecurityContextHolder.getContextHolderStrategy().createEmptyContext()
.also { isGenerated = true }
} }
return securityContext!! return securityContext!!
} }