org.springframework.web.reactive.config

Class PathMatchConfigurer

java.lang.Object

org.springframework.web.reactive.config.PathMatchConfigurer

public class PathMatchConfigurer
extends java.lang.Object

Assist with configuring HandlerMapping's with path matching options.

Since:

5.0

Author:

Rossen Stoyanchev, Brian Clozel

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Boolean	caseSensitiveMatch
private java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>>	pathPrefixes
private java.lang.Boolean	trailingSlashMatch

Constructor Summary

Constructors

Constructor and Description
PathMatchConfigurer()

Method Summary

Modifier and Type	Method and Description
PathMatchConfigurer	addPathPrefix(java.lang.String prefix, java.util.function.Predicate<java.lang.Class<?>> predicate) Configure a path prefix to apply to matching controller methods.
protected java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>>	getPathPrefixes()
protected java.lang.Boolean	isUseCaseSensitiveMatch()
protected java.lang.Boolean	isUseTrailingSlashMatch()
PathMatchConfigurer	setUseCaseSensitiveMatch(java.lang.Boolean caseSensitiveMatch) Whether to match to URLs irrespective of their case.
PathMatchConfigurer	setUseTrailingSlashMatch(java.lang.Boolean trailingSlashMatch) Whether to match to URLs irrespective of the presence of a trailing slash.

Methods inherited from class java.lang.Object

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

Field Detail

trailingSlashMatch

@Nullable
private java.lang.Boolean trailingSlashMatch

caseSensitiveMatch

@Nullable
private java.lang.Boolean caseSensitiveMatch

pathPrefixes

@Nullable
private java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>> pathPrefixes

Constructor Detail

PathMatchConfigurer

public PathMatchConfigurer()

Method Detail

setUseCaseSensitiveMatch

public PathMatchConfigurer setUseCaseSensitiveMatch(java.lang.Boolean caseSensitiveMatch)

Whether to match to URLs irrespective of their case. If enabled a method mapped to "/users" won't match to "/Users/".

The default value is false.

setUseTrailingSlashMatch

public PathMatchConfigurer setUseTrailingSlashMatch(java.lang.Boolean trailingSlashMatch)

Whether to match to URLs irrespective of the presence of a trailing slash. If enabled a method mapped to "/users" also matches to "/users/".

The default value is true.

addPathPrefix

public PathMatchConfigurer addPathPrefix(java.lang.String prefix,
                                         java.util.function.Predicate<java.lang.Class<?>> predicate)

Configure a path prefix to apply to matching controller methods.

Prefixes are used to enrich the mappings of every @RequestMapping method whose controller type is matched by the corresponding Predicate. The prefix for the first matching predicate is used.

Consider using HandlerTypePredicate to group controllers.

Parameters:

prefix - the path prefix to apply

predicate - a predicate for matching controller types

Since:

5.1

isUseTrailingSlashMatch

@Nullable
protected java.lang.Boolean isUseTrailingSlashMatch()

isUseCaseSensitiveMatch

@Nullable
protected java.lang.Boolean isUseCaseSensitiveMatch()

getPathPrefixes

@Nullable
protected java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>> getPathPrefixes()