Class DefaultResourceLoader
- All Implemented Interfaces:
ResourceLoader
- Direct Known Subclasses:
AbstractApplicationContext
,ClassRelativeResourceLoader
,FileSystemResourceLoader
,ServletContextResourceLoader
ResourceLoader
interface.
Used by ResourceEditor
, and serves as base class for
AbstractApplicationContext
.
Can also be used standalone.
Will return a UrlResource
if the location value is a URL,
and a ClassPathResource
if it is a non-URL path or a
"classpath:" pseudo-URL.
- Since:
- 10.03.2004
- Author:
- Juergen Hoeller
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected static class
ClassPathResource that explicitly expresses a context-relative path through implementing the ContextResource interface. -
Field Summary
Fields inherited from interface org.springframework.core.io.ResourceLoader
CLASSPATH_URL_PREFIX
-
Constructor Summary
ConstructorDescriptionCreate a new DefaultResourceLoader.DefaultResourceLoader
(ClassLoader classLoader) Create a new DefaultResourceLoader. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addProtocolResolver
(ProtocolResolver resolver) Register the given resolver with this resource loader, allowing for additional protocols to be handled.void
Clear all resource caches in this resource loader.Return the ClassLoader to load class path resources with.Return the collection of currently registered protocol resolvers, allowing for introspection as well as modification.getResource
(String location) Return aResource
handle for the specified resource location.protected Resource
getResourceByPath
(String path) Return a Resource handle for the resource at the given path.getResourceCache
(Class<T> valueType) Obtain a cache for the given value type, keyed byResource
.void
setClassLoader
(ClassLoader classLoader) Specify the ClassLoader to load class path resources with, ornull
for using the thread context class loader at the time of actual resource access.
-
Constructor Details
-
DefaultResourceLoader
public DefaultResourceLoader()Create a new DefaultResourceLoader.ClassLoader access will happen using the thread context class loader at the time of actual resource access (since 5.3). For more control, pass a specific ClassLoader to
DefaultResourceLoader(ClassLoader)
.- See Also:
-
DefaultResourceLoader
Create a new DefaultResourceLoader.- Parameters:
classLoader
- the ClassLoader to load class path resources with, ornull
for using the thread context class loader at the time of actual resource access
-
-
Method Details
-
setClassLoader
Specify the ClassLoader to load class path resources with, ornull
for using the thread context class loader at the time of actual resource access.The default is that ClassLoader access will happen using the thread context class loader at the time of actual resource access (since 5.3).
-
getClassLoader
Return the ClassLoader to load class path resources with.Will get passed to ClassPathResource's constructor for all ClassPathResource objects created by this resource loader.
- Specified by:
getClassLoader
in interfaceResourceLoader
- Returns:
- the
ClassLoader
(onlynull
if even the systemClassLoader
isn't accessible) - See Also:
-
addProtocolResolver
Register the given resolver with this resource loader, allowing for additional protocols to be handled.Any such resolver will be invoked ahead of this loader's standard resolution rules. It may therefore also override any default rules.
- Since:
- 4.3
- See Also:
-
getProtocolResolvers
Return the collection of currently registered protocol resolvers, allowing for introspection as well as modification.- Since:
- 4.3
- See Also:
-
getResourceCache
Obtain a cache for the given value type, keyed byResource
.- Parameters:
valueType
- the value type, for example, an ASMMetadataReader
- Returns:
- the cache
Map
, shared at theResourceLoader
level - Since:
- 5.0
-
clearResourceCaches
public void clearResourceCaches()Clear all resource caches in this resource loader.- Since:
- 5.0
- See Also:
-
getResource
Description copied from interface:ResourceLoader
Return aResource
handle for the specified resource location.The handle should always be a reusable resource descriptor, allowing for multiple
InputStreamSource.getInputStream()
calls.- Must support fully qualified URLs, for example, "file:C:/test.dat".
- Must support classpath pseudo-URLs, for example, "classpath:test.dat".
- Should support relative file paths, for example, "WEB-INF/test.dat". (This will be implementation-specific, typically provided by an ApplicationContext implementation.)
Note that a
Resource
handle does not imply an existing resource; you need to invokeResource.exists()
to check for existence.- Specified by:
getResource
in interfaceResourceLoader
- Parameters:
location
- the resource location- Returns:
- a corresponding
Resource
handle (nevernull
) - See Also:
-
getResourceByPath
Return a Resource handle for the resource at the given path.The default implementation supports class path locations. This should be appropriate for standalone implementations but can be overridden, for example, for implementations targeted at a Servlet container.
- Parameters:
path
- the path to the resource- Returns:
- the corresponding Resource handle
- See Also:
-