Package org.springframework.security.messaging.util.matcher

Class SimpDestinationMessageMatcher

java.lang.Object

org.springframework.security.messaging.util.matcher.SimpDestinationMessageMatcher

All Implemented Interfaces:

MessageMatcher<java.lang.Object>

public final class SimpDestinationMessageMatcher
extends java.lang.Object
implements MessageMatcher<java.lang.Object>

MessageMatcher which compares a pre-defined pattern against the destination of a Message. There is also support for optionally matching on a specified SimpMessageType.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
static MessageMatcher<java.lang.Object>	NULL_DESTINATION_MATCHER

Fields inherited from interface org.springframework.security.messaging.util.matcher.MessageMatcher

ANY_MESSAGE

Constructor Summary

Constructors

Constructor	Description
SimpDestinationMessageMatcher(java.lang.String pattern)	Creates a new instance with the specified pattern, null SimpMessageType (matches any type), and a AntPathMatcher created from the default constructor.
SimpDestinationMessageMatcher(java.lang.String pattern, org.springframework.util.PathMatcher pathMatcher)	Creates a new instance with the specified pattern and PathMatcher.

Method Summary

Modifier and Type	Method	Description
static SimpDestinationMessageMatcher	createMessageMatcher(java.lang.String pattern, org.springframework.util.PathMatcher matcher)	Creates a new instance with the specified pattern, SimpMessageType.MESSAGE, and PathMatcher.
static SimpDestinationMessageMatcher	createSubscribeMatcher(java.lang.String pattern, org.springframework.util.PathMatcher matcher)	Creates a new instance with the specified pattern, SimpMessageType.SUBSCRIBE, and PathMatcher.
java.util.Map<java.lang.String,java.lang.String>	extractPathVariables(org.springframework.messaging.Message<?> message)
MessageMatcher<java.lang.Object>	getMessageTypeMatcher()
boolean	matches(org.springframework.messaging.Message<?> message)	Returns true if the Message matches, else false
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NULL_DESTINATION_MATCHER

public static final MessageMatcher<java.lang.Object> NULL_DESTINATION_MATCHER

Constructor Detail

SimpDestinationMessageMatcher

public SimpDestinationMessageMatcher(java.lang.String pattern)

Creates a new instance with the specified pattern, null SimpMessageType (matches any type), and a AntPathMatcher created from the default constructor.

The mapping matches destinations despite the using the following rules:

• ? matches one character
• * matches zero or more characters
• ** matches zero or more 'directories' in a path

Some examples:

• com/t?st.jsp - matches com/test but also com/tast or com/txst
• com/*suffix - matches all files ending in suffix in the com directory
• com/**/test - matches all destinations ending with test underneath the com path

Parameters:

pattern - the pattern to use

SimpDestinationMessageMatcher

public SimpDestinationMessageMatcher(java.lang.String pattern,
                                     org.springframework.util.PathMatcher pathMatcher)

Creates a new instance with the specified pattern and PathMatcher.

Parameters:

pattern - the pattern to use

pathMatcher - the PathMatcher to use.

Method Detail

matches

public boolean matches(org.springframework.messaging.Message<?> message)

Description copied from interface: MessageMatcher

Returns true if the Message matches, else false

Specified by:

matches in interface MessageMatcher<java.lang.Object>

Parameters:

message - the Message to match on

Returns:

true if the Message matches, else false

extractPathVariables

public java.util.Map<java.lang.String,java.lang.String> extractPathVariables(org.springframework.messaging.Message<?> message)

getMessageTypeMatcher

public MessageMatcher<java.lang.Object> getMessageTypeMatcher()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createSubscribeMatcher

public static SimpDestinationMessageMatcher createSubscribeMatcher(java.lang.String pattern,
                                                                   org.springframework.util.PathMatcher matcher)

Creates a new instance with the specified pattern, SimpMessageType.SUBSCRIBE, and PathMatcher.

Parameters:

pattern - the pattern to use

matcher - the PathMatcher to use.

createMessageMatcher

public static SimpDestinationMessageMatcher createMessageMatcher(java.lang.String pattern,
                                                                 org.springframework.util.PathMatcher matcher)

Creates a new instance with the specified pattern, SimpMessageType.MESSAGE, and PathMatcher.

Parameters:

pattern - the pattern to use

matcher - the PathMatcher to use.