org.springframework.security.config.annotation.web.builders

Class HttpSecurity.RequestMatcherConfigurer

java.lang.Object

org.springframework.security.config.annotation.web.AbstractRequestMatcherRegistry<HttpSecurity.RequestMatcherConfigurer>

org.springframework.security.config.annotation.web.builders.HttpSecurity.RequestMatcherConfigurer

Direct Known Subclasses:

HttpSecurity.MvcMatchersRequestMatcherConfigurer

Enclosing class:

HttpSecurity

public class HttpSecurity.RequestMatcherConfigurer
extends AbstractRequestMatcherRegistry<HttpSecurity.RequestMatcherConfigurer>

Allows mapping HTTP requests that this HttpSecurity will be used for

Since:

3.2

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<RequestMatcher>	matchers

Method Summary

Modifier and Type	Method and Description
HttpSecurity	and() Return the HttpSecurity for further customizations
protected HttpSecurity.RequestMatcherConfigurer	chainRequestMatchers(java.util.List<RequestMatcher> requestMatchers) Subclasses should implement this method for returning the object that is chained to the creation of the RequestMatcher instances.
HttpSecurity.MvcMatchersRequestMatcherConfigurer	mvcMatchers(org.springframework.http.HttpMethod method, java.lang.String... mvcPatterns) Maps an MvcRequestMatcher that also specifies a specific HttpMethod to match on.
HttpSecurity.MvcMatchersRequestMatcherConfigurer	mvcMatchers(java.lang.String... patterns) Maps an MvcRequestMatcher that does not care which HttpMethod is used.

Methods inherited from class org.springframework.security.config.annotation.web.AbstractRequestMatcherRegistry

antMatchers, antMatchers, antMatchers, anyRequest, createMvcMatchers, getApplicationContext, regexMatchers, regexMatchers, requestMatchers, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

matchers

protected java.util.List<RequestMatcher> matchers

Method Detail

mvcMatchers

public HttpSecurity.MvcMatchersRequestMatcherConfigurer mvcMatchers(org.springframework.http.HttpMethod method,
                                                                    java.lang.String... mvcPatterns)

Description copied from class: AbstractRequestMatcherRegistry

Maps an MvcRequestMatcher that also specifies a specific HttpMethod to match on. This matcher will use the same rules that Spring MVC uses for matching. For example, often times a mapping of the path "/path" will match on "/path", "/path/", "/path.html", etc.

If the current request will not be processed by Spring MVC, a reasonable default using the pattern as a ant pattern will be used.

Specified by:

mvcMatchers in class AbstractRequestMatcherRegistry<HttpSecurity.RequestMatcherConfigurer>

Parameters:

method - the HTTP method to match on

mvcPatterns - the patterns to match on. The rules for matching are defined by Spring MVC

Returns:

the object that is chained after creating the RequestMatcher.

mvcMatchers

public HttpSecurity.MvcMatchersRequestMatcherConfigurer mvcMatchers(java.lang.String... patterns)

Description copied from class: AbstractRequestMatcherRegistry

Maps an MvcRequestMatcher that does not care which HttpMethod is used. This matcher will use the same rules that Spring MVC uses for matching. For example, often times a mapping of the path "/path" will match on "/path", "/path/", "/path.html", etc.

If the current request will not be processed by Spring MVC, a reasonable default using the pattern as a ant pattern will be used.

Specified by:

mvcMatchers in class AbstractRequestMatcherRegistry<HttpSecurity.RequestMatcherConfigurer>

Parameters:

patterns - the patterns to match on. The rules for matching are defined by Spring MVC

Returns:

the object that is chained after creating the RequestMatcher.

chainRequestMatchers

protected HttpSecurity.RequestMatcherConfigurer chainRequestMatchers(java.util.List<RequestMatcher> requestMatchers)

Description copied from class: AbstractRequestMatcherRegistry

Subclasses should implement this method for returning the object that is chained to the creation of the RequestMatcher instances.

Specified by:

chainRequestMatchers in class AbstractRequestMatcherRegistry<HttpSecurity.RequestMatcherConfigurer>

Parameters:

requestMatchers - the RequestMatcher instances that were created

Returns:

the chained Object for the subclass which allows association of something else to the RequestMatcher

and

public HttpSecurity and()

Return the HttpSecurity for further customizations

Returns:

the HttpSecurity for further customizations