ch.rasc.wampspring.security

Class WampMessageSecurityMetadataSourceRegistry

java.lang.Object

ch.rasc.wampspring.security.WampMessageSecurityMetadataSourceRegistry

public class WampMessageSecurityMetadataSourceRegistry
extends Object

Allows mapping security constraints using MessageMatcher to the security expressions.

Author:

Rob Winch, Ralph Schaer

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
WampMessageSecurityMetadataSourceRegistry()

Method Summary

Modifier and Type	Method and Description
WampMessageSecurityMetadataSourceRegistry.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.
WampMessageSecurityMetadataSourceRegistry.Constraint	matchers(org.springframework.security.messaging.util.matcher.MessageMatcher<?>... matchers) Maps a List of MessageMatcher instances to a security expression.
WampMessageSecurityMetadataSourceRegistry.Constraint	nullDestMatcher() Maps any Message that has a null destination header
WampMessageSecurityMetadataSourceRegistry.Constraint	wampCallDestMatchers(String... patterns) Maps a List of WampDestinationMessageMatcher instances that match on WampMessageType.CALL.
WampMessageSecurityMetadataSourceRegistry.Constraint	wampDestMatchers(String... patterns) Maps a List of WampDestinationMessageMatcher instances without regard to the WampMessageType.
WampMessageSecurityMetadataSourceRegistry	wampDestPathMatcher(org.springframework.util.PathMatcher matcher) The PathMatcher to be used with the MessageSecurityMetadataSourceRegistry#wampDestMatchers(String...).
WampMessageSecurityMetadataSourceRegistry.Constraint	wampPublishDestMatchers(String... patterns) Maps a List of WampDestinationMessageMatcher instances that match on WampMessageType.PUBLISH.
WampMessageSecurityMetadataSourceRegistry.Constraint	wampSubscribeDestMatchers(String... patterns) Maps a List of WampDestinationMessageMatcher instances that match on WampMessageType.SUBSCRIBE.
WampMessageSecurityMetadataSourceRegistry.Constraint	wampTypeMatchers(ch.rasc.wampspring.message.WampMessageType... typesToMatch) Maps a List of WampDestinationMessageMatcher instances.
WampMessageSecurityMetadataSourceRegistry.Constraint	wampUnsubscribeDestMatchers(String... patterns) Maps a List of WampDestinationMessageMatcher instances that match on WampMessageType.UNSUBSCRIBE.

Methods inherited from class java.lang.Object

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

Constructor Detail

WampMessageSecurityMetadataSourceRegistry

public WampMessageSecurityMetadataSourceRegistry()

Method Detail

anyMessage

public WampMessageSecurityMetadataSourceRegistry.Constraint anyMessage()

Maps any Message to a security expression.

Returns:

the Expression to associate

nullDestMatcher

public WampMessageSecurityMetadataSourceRegistry.Constraint nullDestMatcher()

Maps any Message that has a null destination header

Returns:

the Expression to associate

wampTypeMatchers

public WampMessageSecurityMetadataSourceRegistry.Constraint wampTypeMatchers(ch.rasc.wampspring.message.WampMessageType... typesToMatch)

Maps a List of WampDestinationMessageMatcher instances.

Parameters:

typesToMatch - the WampMessageType instance to match on

Returns:

the WampMessageSecurityMetadataSourceRegistry.Constraint associated to the matchers.

wampDestMatchers

public WampMessageSecurityMetadataSourceRegistry.Constraint wampDestMatchers(String... patterns)

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

Parameters:

patterns - the patterns to create WampDestinationMessageMatcher from. Uses MessageSecurityMetadataSourceRegistry#wampDestPathMatcher(PathMatcher) .

Returns:

the WampMessageSecurityMetadataSourceRegistry.Constraint that is associated to the MessageMatcher

See Also:

MessageSecurityMetadataSourceRegistry#wampDestPathMatcher(PathMatcher)}

wampCallDestMatchers

public WampMessageSecurityMetadataSourceRegistry.Constraint wampCallDestMatchers(String... patterns)

Maps a List of WampDestinationMessageMatcher instances that match on WampMessageType.CALL. If no destination is found on the Message, then the Matcher returns false.

Parameters:

patterns - the patterns to create WampDestinationMessageMatcher from. Uses MessageSecurityMetadataSourceRegistry#wampDestPathMatcher(PathMatcher) .

Returns:

the WampMessageSecurityMetadataSourceRegistry.Constraint that is associated to the MessageMatcher

See Also:

MessageSecurityMetadataSourceRegistry#wampDestPathMatcher(PathMatcher)}

wampPublishDestMatchers

public WampMessageSecurityMetadataSourceRegistry.Constraint wampPublishDestMatchers(String... patterns)

Maps a List of WampDestinationMessageMatcher instances that match on WampMessageType.PUBLISH. If no destination is found on the Message, then the Matcher returns false.

Parameters:

patterns - the patterns to create WampDestinationMessageMatcher from. Uses MessageSecurityMetadataSourceRegistry#wampDestPathMatcher(PathMatcher) .

Returns:

the WampMessageSecurityMetadataSourceRegistry.Constraint that is associated to the MessageMatcher

See Also:

MessageSecurityMetadataSourceRegistry#wampDestPathMatcher(PathMatcher)}

wampSubscribeDestMatchers

public WampMessageSecurityMetadataSourceRegistry.Constraint wampSubscribeDestMatchers(String... patterns)

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

Parameters:

patterns - the patterns to create WampDestinationMessageMatcher from. Uses MessageSecurityMetadataSourceRegistry#wampDestPathMatcher(PathMatcher) .

Returns:

the WampMessageSecurityMetadataSourceRegistry.Constraint that is associated to the MessageMatcher

See Also:

MessageSecurityMetadataSourceRegistry#wampDestPathMatcher(PathMatcher)}

wampUnsubscribeDestMatchers

public WampMessageSecurityMetadataSourceRegistry.Constraint wampUnsubscribeDestMatchers(String... patterns)

Maps a List of WampDestinationMessageMatcher instances that match on WampMessageType.UNSUBSCRIBE. If no destination is found on the Message, then the Matcher returns false.

Parameters:

patterns - the patterns to create WampDestinationMessageMatcher from. Uses MessageSecurityMetadataSourceRegistry#wampDestPathMatcher(PathMatcher) .

Returns:

the WampMessageSecurityMetadataSourceRegistry.Constraint that is associated to the MessageMatcher

See Also:

MessageSecurityMetadataSourceRegistry#wampDestPathMatcher(PathMatcher)}

wampDestPathMatcher

public WampMessageSecurityMetadataSourceRegistry wampDestPathMatcher(org.springframework.util.PathMatcher matcher)

The PathMatcher to be used with the MessageSecurityMetadataSourceRegistry#wampDestMatchers(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 WampMessageSecurityMetadataSourceRegistry.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 WampMessageSecurityMetadataSourceRegistry.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