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

Class WebSecurity.IgnoredRequestConfigurer

java.lang.Object

org.springframework.security.config.annotation.web.AbstractRequestMatcherRegistry<WebSecurity.IgnoredRequestConfigurer>

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

Direct Known Subclasses:

WebSecurity.MvcMatchersIgnoredRequestConfigurer

Enclosing class:

WebSecurity

public class WebSecurity.IgnoredRequestConfigurer
extends AbstractRequestMatcherRegistry<WebSecurity.IgnoredRequestConfigurer>

Allows registering RequestMatcher instances that should be ignored by Spring Security.

Since:

3.2

Method Summary

Modifier and Type	Method	Description
WebSecurity	and()	Returns the WebSecurity to be returned for chaining.
protected WebSecurity.IgnoredRequestConfigurer	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.
WebSecurity.MvcMatchersIgnoredRequestConfigurer	mvcMatchers(java.lang.String... mvcPatterns)	Maps an MvcRequestMatcher that does not care which HttpMethod is used.
WebSecurity.MvcMatchersIgnoredRequestConfigurer	mvcMatchers(org.springframework.http.HttpMethod method, java.lang.String... mvcPatterns)	Maps an MvcRequestMatcher that also specifies a specific HttpMethod to match on.

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

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

Methods inherited from class java.lang.Object

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

Method Detail

mvcMatchers

public WebSecurity.MvcMatchersIgnoredRequestConfigurer 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<WebSecurity.IgnoredRequestConfigurer>

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 WebSecurity.MvcMatchersIgnoredRequestConfigurer mvcMatchers(java.lang.String... mvcPatterns)

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<WebSecurity.IgnoredRequestConfigurer>

Parameters:

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.

chainRequestMatchers

protected WebSecurity.IgnoredRequestConfigurer 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<WebSecurity.IgnoredRequestConfigurer>

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 WebSecurity and()

Returns the WebSecurity to be returned for chaining.