org.springframework.web.servlet.handler

Interface MatchableHandlerMapping

All Superinterfaces:

HandlerMapping

All Known Implementing Classes:

AbstractDetectingUrlHandlerMapping, AbstractUrlHandlerMapping, BeanNameUrlHandlerMapping, RequestMappingHandlerMapping, SimpleUrlHandlerMapping, WebSocketHandlerMapping

public interface MatchableHandlerMapping
extends HandlerMapping

Additional interface that a HandlerMapping can implement to expose a request matching API aligned with its internal request matching configuration and implementation.

Since:

4.3.1

Author:

Rossen Stoyanchev

See Also:

HandlerMappingIntrospector

Field Summary

Fields inherited from interface org.springframework.web.servlet.HandlerMapping

BEST_MATCHING_HANDLER_ATTRIBUTE, BEST_MATCHING_PATTERN_ATTRIBUTE, INTROSPECT_TYPE_LEVEL_MAPPING, LOOKUP_PATH, MATRIX_VARIABLES_ATTRIBUTE, PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, URI_TEMPLATE_VARIABLES_ATTRIBUTE

Method Summary

Modifier and Type	Method and Description
default PathPatternParser	getPatternParser() Return the parser of this HandlerMapping, if configured in which case pre-parsed patterns are used.
RequestMatchResult	match(HttpServletRequest request, String pattern) Determine whether the request matches the given pattern.

Methods inherited from interface org.springframework.web.servlet.HandlerMapping

getHandler, usesPathPatterns

Method Detail

getPatternParser

@Nullable
default PathPatternParser getPatternParser()

Return the parser of this HandlerMapping, if configured in which case pre-parsed patterns are used.

Since:

5.3

match

@Nullable
RequestMatchResult match(HttpServletRequest request,
                                   String pattern)

Determine whether the request matches the given pattern. Use this method when getPatternParser() returns null which means that the HandlerMapping is uses String pattern matching.

Parameters:

request - the current request

pattern - the pattern to match

Returns:

the result from request matching, or null if none