public class ResourceHandlerRegistry
extends java.lang.Object
To create a resource handler, use addResourceHandler(String...)
providing the URL path patterns for which the handler should be invoked to
serve static resources (e.g. "/resources/**"
).
Then use additional methods on the returned
ResourceHandlerRegistration
to add one or more locations from which
to serve static content from (e.g. {"/"
,
"classpath:/META-INF/public-web-resources/"
}) or to specify a cache
period for served resources.
Modifier and Type | Field and Description |
---|---|
private ApplicationContext |
applicationContext |
private CompositeContentTypeResolver |
contentTypeResolver |
private int |
order |
private java.util.List<ResourceHandlerRegistration> |
registrations |
Constructor and Description |
---|
ResourceHandlerRegistry(ApplicationContext applicationContext)
Create a new resource handler registry for the given application context.
|
ResourceHandlerRegistry(ApplicationContext applicationContext,
CompositeContentTypeResolver contentTypeResolver)
Create a new resource handler registry for the given application context.
|
Modifier and Type | Method and Description |
---|---|
ResourceHandlerRegistration |
addResourceHandler(java.lang.String... patterns)
Add a resource handler for serving static resources based on the specified
URL path patterns.
|
protected AbstractHandlerMapping |
getHandlerMapping()
Return a handler mapping with the mapped resource handlers; or
null in case
of no registrations. |
boolean |
hasMappingForPattern(java.lang.String pathPattern)
Whether a resource handler has already been registered for the given path pattern.
|
ResourceHandlerRegistry |
setOrder(int order)
Specify the order to use for resource handling relative to other
HandlerMapping s configured in the Spring configuration. |
private final ApplicationContext applicationContext
private final CompositeContentTypeResolver contentTypeResolver
private final java.util.List<ResourceHandlerRegistration> registrations
private int order
public ResourceHandlerRegistry(ApplicationContext applicationContext)
applicationContext
- the Spring application contextpublic ResourceHandlerRegistry(ApplicationContext applicationContext, CompositeContentTypeResolver contentTypeResolver)
applicationContext
- the Spring application contextcontentTypeResolver
- the content type resolver to usepublic ResourceHandlerRegistration addResourceHandler(java.lang.String... patterns)
Patterns like "/static/**"
or "/css/{filename:\\w+\\.css}"
are allowed. See ParsingPathMatcher
for more
details on the syntax.
ResourceHandlerRegistration
to use to further
configure the registered resource handlerpublic boolean hasMappingForPattern(java.lang.String pathPattern)
public ResourceHandlerRegistry setOrder(int order)
HandlerMapping
s configured in the Spring configuration.
The default value used is Integer.MAX_VALUE-1
.
protected AbstractHandlerMapping getHandlerMapping()
null
in case
of no registrations.