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

Class PathPatternMessageMatcher

java.lang.Object

org.springframework.security.messaging.util.matcher.PathPatternMessageMatcher

All Implemented Interfaces:

MessageMatcher<Object>

public final class PathPatternMessageMatcher
extends Object
implements MessageMatcher<Object>

Match Messages based on the message destination pattern using a PathPattern. There is also support for optionally matching on a specified SimpMessageType.

Since:

6.5

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PathPatternMessageMatcher.Builder	A builder for specifying various elements of a message for the purpose of creating a PathPatternMessageMatcher.

Nested classes/interfaces inherited from interface org.springframework.security.messaging.util.matcher.MessageMatcher

MessageMatcher.MatchResult

Field Summary

Fields

Modifier and Type	Field	Description
static final MessageMatcher<Object>	NULL_DESTINATION_MATCHER

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

ANY_MESSAGE

Method Summary

Modifier and Type	Method	Description
MessageMatcher.MatchResult	matcher(org.springframework.messaging.Message<?> message)	Extract the path variables from the Message destination if the path is a match, otherwise the MessageMatcher.MatchResult.getVariables() returns a Collections.emptyMap()
boolean	matches(org.springframework.messaging.Message<?> message)	Returns true if the Message matches, else false
static PathPatternMessageMatcher.Builder	withDefaults()	Initialize this builder with the PathPatternParser.defaultInstance that is configured with the PathContainer.Options.HTTP_PATH separator
static PathPatternMessageMatcher.Builder	withPathPatternParser(org.springframework.web.util.pattern.PathPatternParser parser)	Initialize this builder with the provided PathPatternParser

Methods inherited from class java.lang.Object

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

Field Details

NULL_DESTINATION_MATCHER

public static final MessageMatcher<Object> NULL_DESTINATION_MATCHER

Method Details

withDefaults

public static PathPatternMessageMatcher.Builder withDefaults()

Initialize this builder with the PathPatternParser.defaultInstance that is configured with the PathContainer.Options.HTTP_PATH separator

withPathPatternParser

public static PathPatternMessageMatcher.Builder withPathPatternParser(org.springframework.web.util.pattern.PathPatternParser parser)

Initialize this builder with the provided PathPatternParser

matches

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

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

matcher

public MessageMatcher.MatchResult matcher(org.springframework.messaging.Message<?> message)

Extract the path variables from the Message destination if the path is a match, otherwise the MessageMatcher.MatchResult.getVariables() returns a Collections.emptyMap()

Specified by:

matcher in interface MessageMatcher<Object>

Parameters:

message - the message whose path variables to extract.

Returns:

a MatchResult of the path variables and values.