Class ResourceHandlerRegistry
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.
- Since:
- 3.1
- Author:
- Rossen Stoyanchev
- See Also:
-
Constructor Summary
ConstructorDescriptionResourceHandlerRegistry
(ApplicationContext applicationContext, ServletContext servletContext) Create a new resource handler registry for the given application context.ResourceHandlerRegistry
(ApplicationContext applicationContext, ServletContext servletContext, ContentNegotiationManager contentNegotiationManager) Create a new resource handler registry for the given application context.ResourceHandlerRegistry
(ApplicationContext applicationContext, ServletContext servletContext, ContentNegotiationManager contentNegotiationManager, UrlPathHelper pathHelper) A variant ofResourceHandlerRegistry(ApplicationContext, ServletContext, ContentNegotiationManager)
that also accepts theUrlPathHelper
used for mapping requests to static resources. -
Method Summary
Modifier and TypeMethodDescriptionaddResourceHandler
(String... pathPatterns) Add a resource handler to serve static resources.protected AbstractHandlerMapping
Return a handler mapping with the mapped resource handlers; ornull
in case of no registrations.boolean
hasMappingForPattern
(String pathPattern) Whether a resource handler has already been registered for the given path pattern.setOrder
(int order) Specify the order to use for resource handling relative to otherHandlerMappings
configured in the Spring MVC application context.
-
Constructor Details
-
ResourceHandlerRegistry
public ResourceHandlerRegistry(ApplicationContext applicationContext, ServletContext servletContext) Create a new resource handler registry for the given application context.- Parameters:
applicationContext
- the Spring application contextservletContext
- the corresponding Servlet context
-
ResourceHandlerRegistry
public ResourceHandlerRegistry(ApplicationContext applicationContext, ServletContext servletContext, @Nullable ContentNegotiationManager contentNegotiationManager) Create a new resource handler registry for the given application context.- Parameters:
applicationContext
- the Spring application contextservletContext
- the corresponding Servlet contextcontentNegotiationManager
- the content negotiation manager to use- Since:
- 4.3
-
ResourceHandlerRegistry
public ResourceHandlerRegistry(ApplicationContext applicationContext, ServletContext servletContext, @Nullable ContentNegotiationManager contentNegotiationManager, @Nullable UrlPathHelper pathHelper) A variant ofResourceHandlerRegistry(ApplicationContext, ServletContext, ContentNegotiationManager)
that also accepts theUrlPathHelper
used for mapping requests to static resources.- Since:
- 4.3.13
-
-
Method Details
-
addResourceHandler
Add a resource handler to serve static resources. The handler is invoked for requests that match one of the specified URL path patterns.Patterns such as
"/static/**"
or"/css/{filename:\\w+\\.css}"
are supported.For pattern syntax see
PathPattern
when parsed patterns areenabled
orAntPathMatcher
otherwise. The syntax is largely the same withPathPattern
more tailored for web usage and more efficient. -
hasMappingForPattern
Whether a resource handler has already been registered for the given path pattern. -
setOrder
Specify the order to use for resource handling relative to otherHandlerMappings
configured in the Spring MVC application context.The default value used is
Integer.MAX_VALUE-1
. -
getHandlerMapping
Return a handler mapping with the mapped resource handlers; ornull
in case of no registrations.
-