org.springframework.security.config.annotation.web.messaging

Class MessageSecurityMetadataSourceRegistry

java.lang.Object

org.springframework.security.config.annotation.web.messaging.MessageSecurityMetadataSourceRegistry

public class MessageSecurityMetadataSourceRegistry
extends Object

Allows mapping security constraints using MessageMatcher to the security expressions.

Since:

4.0

Author:

Rob Winch

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
MessageSecurityMetadataSourceRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
MessageSecurityMetadataSourceRegistry.Constraint	antMatchers(org.springframework.messaging.simp.SimpMessageType type, String... patterns) Maps a List of SimpDestinationMessageMatcher instances.
MessageSecurityMetadataSourceRegistry.Constraint	antMatchers(String... patterns) Maps a List of SimpDestinationMessageMatcher instances without regard to the SimpMessageType.
MessageSecurityMetadataSourceRegistry.Constraint	anyMessage() Maps any Message to a security expression.
protected boolean	containsMapping() Allows determining if a mapping was added.
protected org.springframework.security.messaging.access.intercept.MessageSecurityMetadataSource	createMetadataSource() Allows subclasses to create creating a MessageSecurityMetadataSource.
MessageSecurityMetadataSourceRegistry.Constraint	matchers(org.springframework.security.messaging.util.matcher.MessageMatcher<?>... matchers) Maps a List of MessageMatcher instances to a security expression.
MessageSecurityMetadataSourceRegistry	pathMatcher(PathMatcher pathMatcher) The PathMatcher to be used with the antMatchers(String...).
MessageSecurityMetadataSourceRegistry.Constraint	typeMatchers(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 Detail

MessageSecurityMetadataSourceRegistry

public MessageSecurityMetadataSourceRegistry()

Method Detail

anyMessage

public MessageSecurityMetadataSourceRegistry.Constraint anyMessage()

Maps any Message to a security expression.

Returns:

the Expression to associate

typeMatchers

public MessageSecurityMetadataSourceRegistry.Constraint typeMatchers(org.springframework.messaging.simp.SimpMessageType... typesToMatch)

Maps a List of SimpDestinationMessageMatcher instances.

Parameters:

typesToMatch - the SimpMessageType instance to match on

Returns:

the MessageSecurityMetadataSourceRegistry.Constraint associated to the matchers.

antMatchers

public MessageSecurityMetadataSourceRegistry.Constraint antMatchers(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. Uses pathMatcher(PathMatcher) .

Returns:

the MessageSecurityMetadataSourceRegistry.Constraint that is associated to the MessageMatcher

See Also:

MessageSecurityMetadataSourceRegistry#pathMatcher(PathMatcher)}

antMatchers

public MessageSecurityMetadataSourceRegistry.Constraint antMatchers(org.springframework.messaging.simp.SimpMessageType type,
                                                           String... patterns)

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

Parameters:

type - the SimpMessageType to match on. If null, the SimpMessageType is not considered for matching.

patterns - the patterns to create SimpDestinationMessageMatcher from. Uses pathMatcher(PathMatcher).

Returns:

the MessageSecurityMetadataSourceRegistry.Constraint that is associated to the MessageMatcher

See Also:

MessageSecurityMetadataSourceRegistry#pathMatcher(PathMatcher)}

pathMatcher

public MessageSecurityMetadataSourceRegistry pathMatcher(PathMatcher pathMatcher)

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

Parameters:

pathMatcher - the PathMatcher to use. Cannot be null.

Returns:

the MessageSecurityMetadataSourceRegistry for further customization.

matchers

public MessageSecurityMetadataSourceRegistry.Constraint matchers(org.springframework.security.messaging.util.matcher.MessageMatcher<?>... matchers)

Maps a List of MessageMatcher instances to a security expression.

Parameters:

matchers - the MessageMatcher instances to map.

Returns:

The MessageSecurityMetadataSourceRegistry.Constraint that is associated to the MessageMatcher instances

createMetadataSource

protected org.springframework.security.messaging.access.intercept.MessageSecurityMetadataSource createMetadataSource()

Allows subclasses to create creating a MessageSecurityMetadataSource.

This is not exposed so as not to confuse users of the API, which should never invoke this method.

Returns:

the MessageSecurityMetadataSource to use

containsMapping

protected boolean containsMapping()

Allows determining if a mapping was added.

This is not exposed so as not to confuse users of the API, which should never need to invoke this method.

Returns:

true if a mapping was added, else false