Class MessageExpressionAuthorizationManager

java.lang.Object

org.springframework.security.messaging.access.expression.MessageExpressionAuthorizationManager

All Implemented Interfaces:

AuthorizationManager<MessageAuthorizationContext<?>>

public final class MessageExpressionAuthorizationManager
extends Object
implements AuthorizationManager<MessageAuthorizationContext<?>>

An expression-based AuthorizationManager that determines the access by evaluating the provided expression.

Since:

7.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MessageExpressionAuthorizationManager.Builder	A MessageExpressionAuthorizationManager.Builder for constructing MessageExpressionAuthorizationManager instances.

Constructor Summary

Constructors

Constructor	Description
MessageExpressionAuthorizationManager(String expressionString)	Creates an instance.

Method Summary

Modifier and Type	Method	Description
AuthorizationResult	authorize(Supplier<? extends @Nullable Authentication> authentication, MessageAuthorizationContext<?> context)	Determines the access by evaluating the provided expression.
String	toString()
static MessageExpressionAuthorizationManager.Builder	withDefaults()	Use a MessageAuthorizationContextSecurityExpressionHandler to create MessageExpressionAuthorizationManager instances.
static MessageExpressionAuthorizationManager.Builder	withSecurityExpressionHandler(SecurityExpressionHandler<MessageAuthorizationContext<?>> expressionHandler)	Use this SecurityExpressionHandler to create MessageExpressionAuthorizationManager instances.

Methods inherited from class Object

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

Methods inherited from interface AuthorizationManager

verify

Constructor Details

MessageExpressionAuthorizationManager

public MessageExpressionAuthorizationManager(String expressionString)

Creates an instance.

Parameters:

expressionString - the raw expression string to parse

Method Details

withDefaults

public static MessageExpressionAuthorizationManager.Builder withDefaults()

Use a MessageAuthorizationContextSecurityExpressionHandler to create MessageExpressionAuthorizationManager instances.

Returns:

a MessageExpressionAuthorizationManager.Builder for constructing MessageExpressionAuthorizationManager instances

Since:

7.1

withSecurityExpressionHandler

public static MessageExpressionAuthorizationManager.Builder withSecurityExpressionHandler(SecurityExpressionHandler<MessageAuthorizationContext<?>> expressionHandler)

Use this SecurityExpressionHandler to create MessageExpressionAuthorizationManager instances.

Parameters:

expressionHandler - the expression handler to use

Returns:

a MessageExpressionAuthorizationManager.Builder for constructing MessageExpressionAuthorizationManager instances

Since:

7.1

authorize

public AuthorizationResult authorize(Supplier<? extends @Nullable Authentication> authentication,
 MessageAuthorizationContext<?> context)

Determines the access by evaluating the provided expression.

Specified by:

authorize in interface AuthorizationManager<MessageAuthorizationContext<?>>

Parameters:

authentication - the Supplier of the Authentication to check

context - the MessageAuthorizationContext to check

Returns:

an ExpressionAuthorizationDecision based on the evaluated expression

toString

public String toString()

Overrides:

toString in class Object