Package org.springframework.security.messaging.access.intercept

Class MessageMatcherDelegatingAuthorizationManager.Builder

java.lang.Object

org.springframework.security.messaging.access.intercept.MessageMatcherDelegatingAuthorizationManager.Builder

Enclosing class:

MessageMatcherDelegatingAuthorizationManager

public static final class MessageMatcherDelegatingAuthorizationManager.Builder
extends Object

A builder for MessageMatcherDelegatingAuthorizationManager.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	MessageMatcherDelegatingAuthorizationManager.Builder.Constraint	Represents the security constraint to be applied to the MessageMatcher instances.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MessageMatcherDelegatingAuthorizationManager.Builder.Constraint	anyMessage()	Maps any Message to a security expression.
AuthorizationManager<org.springframework.messaging.Message<?>>	build()
MessageMatcherDelegatingAuthorizationManager.Builder.Constraint	matchers(MessageMatcher<?>... matchers)	Maps a List of MessageMatcher instances to a security expression.
MessageMatcherDelegatingAuthorizationManager.Builder.Constraint	nullDestMatcher()	Maps any Message that has a null SimpMessageHeaderAccessor destination header (i.e.
MessageMatcherDelegatingAuthorizationManager.Builder.Constraint	simpDestMatchers(String... patterns)	Maps a List of SimpDestinationMessageMatcher instances without regard to the SimpMessageType.
MessageMatcherDelegatingAuthorizationManager.Builder	simpDestPathMatcher(Supplier<org.springframework.util.PathMatcher> pathMatcher)	The PathMatcher to be used with the simpDestMatchers(String...).
MessageMatcherDelegatingAuthorizationManager.Builder	simpDestPathMatcher(org.springframework.util.PathMatcher pathMatcher)	The PathMatcher to be used with the simpDestMatchers(String...).
MessageMatcherDelegatingAuthorizationManager.Builder.Constraint	simpMessageDestMatchers(String... patterns)	Maps a List of SimpDestinationMessageMatcher instances that match on SimpMessageType.MESSAGE.
MessageMatcherDelegatingAuthorizationManager.Builder.Constraint	simpSubscribeDestMatchers(String... patterns)	Maps a List of SimpDestinationMessageMatcher instances that match on SimpMessageType.SUBSCRIBE.
MessageMatcherDelegatingAuthorizationManager.Builder.Constraint	simpTypeMatchers(org.springframework.messaging.simp.SimpMessageType... typesToMatch)	Maps a List of SimpDestinationMessageMatcher instances.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

anyMessage

public MessageMatcherDelegatingAuthorizationManager.Builder.Constraint anyMessage()

Maps any Message to a security expression.

Returns:

the Expression to associate

nullDestMatcher

public MessageMatcherDelegatingAuthorizationManager.Builder.Constraint nullDestMatcher()

Maps any Message that has a null SimpMessageHeaderAccessor destination header (i.e. CONNECT, CONNECT_ACK, HEARTBEAT, UNSUBSCRIBE, DISCONNECT, DISCONNECT_ACK, OTHER)

Returns:

the Expression to associate

simpTypeMatchers

public MessageMatcherDelegatingAuthorizationManager.Builder.Constraint simpTypeMatchers(org.springframework.messaging.simp.SimpMessageType... typesToMatch)

Maps a List of SimpDestinationMessageMatcher instances.

Parameters:

typesToMatch - the SimpMessageType instance to match on

Returns:

the MessageMatcherDelegatingAuthorizationManager.Builder.Constraint associated to the matchers.

simpDestMatchers

public MessageMatcherDelegatingAuthorizationManager.Builder.Constraint simpDestMatchers(String... patterns)

Maps a List of SimpDestinationMessageMatcher instances without regard to the SimpMessageType. If no destination is found on the Message, then the Matcher returns false.

Parameters:

patterns - the patterns to create SimpDestinationMessageMatcher from.

simpMessageDestMatchers

public MessageMatcherDelegatingAuthorizationManager.Builder.Constraint simpMessageDestMatchers(String... patterns)

Maps a List of SimpDestinationMessageMatcher instances that match on SimpMessageType.MESSAGE. If no destination is found on the Message, then the Matcher returns false.

Parameters:

patterns - the patterns to create SimpDestinationMessageMatcher from.

simpSubscribeDestMatchers

public MessageMatcherDelegatingAuthorizationManager.Builder.Constraint simpSubscribeDestMatchers(String... patterns)

Maps a List of SimpDestinationMessageMatcher instances that match on SimpMessageType.SUBSCRIBE. If no destination is found on the Message, then the Matcher returns false.

Parameters:

patterns - the patterns to create SimpDestinationMessageMatcher from.

simpDestPathMatcher

public MessageMatcherDelegatingAuthorizationManager.Builder simpDestPathMatcher(org.springframework.util.PathMatcher pathMatcher)

The PathMatcher to be used with the simpDestMatchers(String...). The default is to use the default constructor of AntPathMatcher.

Parameters:

pathMatcher - the PathMatcher to use. Cannot be null.

Returns:

the MessageMatcherDelegatingAuthorizationManager.Builder for further customization.

simpDestPathMatcher

public MessageMatcherDelegatingAuthorizationManager.Builder simpDestPathMatcher(Supplier<org.springframework.util.PathMatcher> pathMatcher)

The PathMatcher to be used with the simpDestMatchers(String...). Use this method to delay the computation or lookup of the PathMatcher.

Parameters:

pathMatcher - the PathMatcher to use. Cannot be null.

Returns:

the MessageMatcherDelegatingAuthorizationManager.Builder for further customization.

matchers

public MessageMatcherDelegatingAuthorizationManager.Builder.Constraint matchers(MessageMatcher<?>... matchers)

Maps a List of MessageMatcher instances to a security expression.

Parameters:

matchers - the MessageMatcher instances to map.

Returns:

The MessageMatcherDelegatingAuthorizationManager.Builder.Constraint that is associated to the MessageMatcher instances

build

public AuthorizationManager<org.springframework.messaging.Message<?>> build()