org.springframework.security.messaging.util.matcher

Class SimpDestinationMessageMatcher

java.lang.Object

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

All Implemented Interfaces:

MessageMatcher<Object>

public final class SimpDestinationMessageMatcher
extends Object
implements MessageMatcher<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 inherited from interface org.springframework.security.messaging.util.matcher.MessageMatcher

ANY_MESSAGE

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	matches(org.springframework.messaging.Message<? extends Object> message) Returns true if the Message matches, else false

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpDestinationMessageMatcher

public SimpDestinationMessageMatcher(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(String pattern,
                             org.springframework.messaging.simp.SimpMessageType type)

Creates a new instance with the specified pattern and a AntPathMatcher created from the default constructor.

Parameters:

pattern - the pattern to use

type - the SimpMessageType to match on or null if any SimpMessageType should be matched.

pathMatcher - the PathMatcher to use.

SimpDestinationMessageMatcher

public SimpDestinationMessageMatcher(String pattern,
                             org.springframework.messaging.simp.SimpMessageType type,
                             PathMatcher pathMatcher)

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

Parameters:

pattern - the pattern to use

type - the SimpMessageType to match on or null if any SimpMessageType should be matched.

pathMatcher - the PathMatcher to use.

Method Detail

matches

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

Description copied from interface: MessageMatcher

Returns true if the Message matches, else false

Specified by:

matches in interface MessageMatcher<Object>

Parameters:

message - the Message to match on

Returns:

true if the Message matches, else false