Package org.springframework.security.concurrent

Class DelegatingSecurityContextCallable<V>

java.lang.Object

org.springframework.security.concurrent.DelegatingSecurityContextCallable<V>

All Implemented Interfaces:

java.util.concurrent.Callable<V>

public final class DelegatingSecurityContextCallable<V>
extends java.lang.Object
implements java.util.concurrent.Callable<V>

Wraps a delegate Callable with logic for setting up a SecurityContext before invoking the delegate Callable and then removing the SecurityContext after the delegate has completed.

If there is a SecurityContext that already exists, it will be restored after the call() method is invoked.

Since:

3.2

Constructor Summary

Constructors

Constructor	Description
DelegatingSecurityContextCallable(java.util.concurrent.Callable<V> delegate)	Creates a new DelegatingSecurityContextCallable with the SecurityContext from the SecurityContextHolder.
DelegatingSecurityContextCallable(java.util.concurrent.Callable<V> delegate, SecurityContext securityContext)	Creates a new DelegatingSecurityContextCallable with a specific SecurityContext.

Method Summary

Modifier and Type	Method	Description
V	call()
static <V> java.util.concurrent.Callable<V>	create(java.util.concurrent.Callable<V> delegate, SecurityContext securityContext)	Creates a DelegatingSecurityContextCallable and with the given Callable and SecurityContext, but if the securityContext is null will defaults to the current SecurityContext on the SecurityContextHolder
void	setSecurityContextHolderStrategy(SecurityContextHolderStrategy securityContextHolderStrategy)	Sets the SecurityContextHolderStrategy to use.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DelegatingSecurityContextCallable

public DelegatingSecurityContextCallable(java.util.concurrent.Callable<V> delegate,
                                         SecurityContext securityContext)

Creates a new DelegatingSecurityContextCallable with a specific SecurityContext.

Parameters:

delegate - the delegate DelegatingSecurityContextCallable to run with the specified SecurityContext. Cannot be null.

securityContext - the SecurityContext to establish for the delegate Callable. Cannot be null.

DelegatingSecurityContextCallable

public DelegatingSecurityContextCallable(java.util.concurrent.Callable<V> delegate)

Creates a new DelegatingSecurityContextCallable with the SecurityContext from the SecurityContextHolder.

Parameters:

delegate - the delegate Callable to run under the current SecurityContext. Cannot be null.

Method Detail

call

public V call()
       throws java.lang.Exception

Specified by:

call in interface java.util.concurrent.Callable<V>

Throws:

java.lang.Exception

setSecurityContextHolderStrategy

public void setSecurityContextHolderStrategy(SecurityContextHolderStrategy securityContextHolderStrategy)

Sets the SecurityContextHolderStrategy to use. The default action is to use the SecurityContextHolderStrategy stored in SecurityContextHolder.

Since:

5.8

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

create

public static <V> java.util.concurrent.Callable<V> create(java.util.concurrent.Callable<V> delegate,
                                                          SecurityContext securityContext)

Creates a DelegatingSecurityContextCallable and with the given Callable and SecurityContext, but if the securityContext is null will defaults to the current SecurityContext on the SecurityContextHolder

Parameters:

delegate - the delegate DelegatingSecurityContextCallable to run with the specified SecurityContext. Cannot be null.

securityContext - the SecurityContext to establish for the delegate Callable. If null, defaults to SecurityContextHolder.getContext()

Returns: