org.springframework.boot.autoconfigure.security.servlet

Class StaticResourceRequest

java.lang.Object

org.springframework.boot.autoconfigure.security.servlet.StaticResourceRequest

public final class StaticResourceRequest
extends Object

Used to create a RequestMatcher for static resources in commonly used locations. Returned by PathRequest.toStaticResources().

Since:

2.0.0

Author:

Madhura Bhave, Phillip Webb

See Also:

PathRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StaticResourceRequest.StaticResourceRequestMatcher The request matcher used to match against resource Locations.

Method Summary

Modifier and Type	Method and Description
StaticResourceRequest.StaticResourceRequestMatcher	at(Set<StaticResourceLocation> locations) Returns a matcher that includes the specified Locations.
StaticResourceRequest.StaticResourceRequestMatcher	at(StaticResourceLocation first, StaticResourceLocation... rest) Returns a matcher that includes the specified Locations.
StaticResourceRequest.StaticResourceRequestMatcher	atCommonLocations() Returns a matcher that includes all commonly used Locations.

Methods inherited from class java.lang.Object

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

Method Detail

atCommonLocations

public StaticResourceRequest.StaticResourceRequestMatcher atCommonLocations()

Returns a matcher that includes all commonly used Locations. The excluding method can be used to remove specific locations if required. For example:

 PathRequest.toStaticResources().atCommonLocations().excluding(StaticResourceLocation.CSS)
 

Returns:

the configured RequestMatcher

at

public StaticResourceRequest.StaticResourceRequestMatcher at(StaticResourceLocation first,
                                                             StaticResourceLocation... rest)

Returns a matcher that includes the specified Locations. For example:

 PathRequest.toStaticResources().at(StaticResourceLocation.CSS, StaticResourceLocation.JAVA_SCRIPT)
 

Parameters:

first - the first location to include

rest - additional locations to include

Returns:

the configured RequestMatcher

at

public StaticResourceRequest.StaticResourceRequestMatcher at(Set<StaticResourceLocation> locations)

Returns a matcher that includes the specified Locations. For example:

 PathRequest.toStaticResources().at(locations)
 

Parameters:

locations - the locations to include

Returns:

the configured RequestMatcher