org.springframework.boot.autoconfigure.security

Class StaticResourceRequest

java.lang.Object

org.springframework.boot.autoconfigure.security.StaticResourceRequest

public final class StaticResourceRequest
extends Object

Factory that can be used to create a RequestMatcher for static resources in commonly used locations.

Since:

2.0.0

Author:

Madhura Bhave, Phillip Webb

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static StaticResourceRequest.StaticResourceRequestMatcher	to(Set<StaticResourceRequest.Location> locations) Returns a matcher that includes the specified Locations.
static StaticResourceRequest.StaticResourceRequestMatcher	to(StaticResourceRequest.Location first, StaticResourceRequest.Location... rest) Returns a matcher that includes the specified Locations.
static StaticResourceRequest.StaticResourceRequestMatcher	toCommonLocations() 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

toCommonLocations

public static StaticResourceRequest.StaticResourceRequestMatcher toCommonLocations()

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

 StaticResourceRequest.toCommonLocations().excluding(Location.CSS)
 

Returns:

the configured RequestMatcher

to

public static StaticResourceRequest.StaticResourceRequestMatcher to(StaticResourceRequest.Location first,
                                                                    StaticResourceRequest.Location... rest)

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

 StaticResourceRequest.to(Location.CSS, Location.JAVA_SCRIPT)
 

Parameters:

first - the first location to include

rest - additional locations to include

Returns:

the configured RequestMatcher

to

public static StaticResourceRequest.StaticResourceRequestMatcher to(Set<StaticResourceRequest.Location> locations)

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

 StaticResourceRequest.to(locations)
 

Parameters:

locations - the locations to include

Returns:

the configured RequestMatcher