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

Class MessageMatcher.MatchResult

java.lang.Object

org.springframework.security.messaging.util.matcher.MessageMatcher.MatchResult

Enclosing interface:

MessageMatcher<T>

public static class MessageMatcher.MatchResult
extends Object

The result of matching against a Message contains the status, true or false, of the match and if present, any variables extracted from the match

Since:

6.5

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getVariables()	Returns the extracted variable values where the key is the variable name and the value is the variable value
boolean	isMatch()	Return whether the comparison against the Message produced a successful match
static MessageMatcher.MatchResult	match()	Creates an instance of MessageMatcher.MatchResult that is a match with no variables
static MessageMatcher.MatchResult	match(Map<String,String> variables)	Creates an instance of MessageMatcher.MatchResult that is a match with the specified variables
static MessageMatcher.MatchResult	notMatch()	Creates an instance of MessageMatcher.MatchResult that is not a match.

Methods inherited from class java.lang.Object

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

Method Details

isMatch

public boolean isMatch()

Return whether the comparison against the Message produced a successful match

getVariables

public Map<String,String> getVariables()

Returns the extracted variable values where the key is the variable name and the value is the variable value

Returns:

a map containing key-value pairs representing extracted variable names and variable values

match

public static MessageMatcher.MatchResult match()

Creates an instance of MessageMatcher.MatchResult that is a match with no variables

match

public static MessageMatcher.MatchResult match(Map<String,String> variables)

Creates an instance of MessageMatcher.MatchResult that is a match with the specified variables

notMatch

public static MessageMatcher.MatchResult notMatch()

Creates an instance of MessageMatcher.MatchResult that is not a match.

Returns:

a MatchResult with match set to false