Package org.springframework.boot.io

Class ApplicationResourceLoader

java.lang.Object

org.springframework.core.io.DefaultResourceLoader

org.springframework.boot.io.ApplicationResourceLoader

All Implemented Interfaces:

ResourceLoader

public class ApplicationResourceLoader
extends DefaultResourceLoader

Class can be used to obtain ResourceLoaders supporting additional ProtocolResolvers registered in spring.factories.

When not delegating to an existing resource loader, plain paths without a qualifier will resolve to file system resources. This is different from DefaultResourceLoader, which resolves unqualified paths to classpath resources.

Since:

3.3.0

Author:

Scott Frederick, Moritz Halbritter, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ApplicationResourceLoader.FilePathResolver	Strategy interface registered in spring.factories and used by ApplicationResourceLoader to determine the file path of loaded resource when it can also be represented as a FileSystemResource.

Nested classes/interfaces inherited from class org.springframework.core.io.DefaultResourceLoader

DefaultResourceLoader.ClassPathContextResource

Field Summary

Fields inherited from interface org.springframework.core.io.ResourceLoader

CLASSPATH_URL_PREFIX

Constructor Summary

Constructors

Constructor	Description
ApplicationResourceLoader()	Deprecated, for removal: This API element is subject to removal in a future version. since 3.4.0 for removal in 4.0.0 in favor of get()
ApplicationResourceLoader(ClassLoader classLoader)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.4.0 for removal in 4.0.0 in favor of get(ClassLoader)

Method Summary

Modifier and Type	Method	Description
static ResourceLoader	get()	Return a ResourceLoader supporting additional ProtocolResolvers registered in spring.factories.
static ResourceLoader	get(ClassLoader classLoader)	Return a ResourceLoader supporting additional ProtocolResolvers registered in spring.factories.
static ResourceLoader	get(ClassLoader classLoader, SpringFactoriesLoader springFactoriesLoader)	Return a ResourceLoader supporting additional ProtocolResolvers registered in spring.factories.
static ResourceLoader	get(ClassLoader classLoader, SpringFactoriesLoader springFactoriesLoader, Path workingDirectory)	Return a ResourceLoader supporting additional ProtocolResolvers registered in spring.factories.
static ResourceLoader	get(ResourceLoader resourceLoader)	Return a ResourceLoader delegating to the given resource loader and supporting additional ProtocolResolvers registered in spring.factories.
static ResourceLoader	get(ResourceLoader resourceLoader, boolean preferFileResolution)	Return a ResourceLoader delegating to the given resource loader and supporting additional ProtocolResolvers registered in spring.factories.
static ResourceLoader	get(ResourceLoader resourceLoader, SpringFactoriesLoader springFactoriesLoader)	Return a ResourceLoader delegating to the given resource loader and supporting additional ProtocolResolvers registered in spring.factories.
protected Resource	getResourceByPath(String path)

Methods inherited from class org.springframework.core.io.DefaultResourceLoader

addProtocolResolver, clearResourceCaches, getClassLoader, getProtocolResolvers, getResource, getResourceCache, setClassLoader

Methods inherited from class java.lang.Object

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

Constructor Details

ApplicationResourceLoader

@Deprecated(since="3.4.0",
            forRemoval=true)
public ApplicationResourceLoader()

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.4.0 for removal in 4.0.0 in favor of get()

Create a new ApplicationResourceLoader.

ApplicationResourceLoader

@Deprecated(since="3.4.0",
            forRemoval=true)
public ApplicationResourceLoader(ClassLoader classLoader)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.4.0 for removal in 4.0.0 in favor of get(ClassLoader)

Create a new ApplicationResourceLoader.

Parameters:

classLoader - the ClassLoader to load class path resources with, or null for using the thread context class loader at the time of actual resource access

Method Details

getResourceByPath

protected Resource getResourceByPath(String path)

Overrides:

getResourceByPath in class DefaultResourceLoader

get

public static ResourceLoader get()

Return a ResourceLoader supporting additional ProtocolResolvers registered in spring.factories. The factories file will be resolved using the default class loader at the time this call is made. Resources will be resolved using the default class loader at the time they are resolved.

Returns:

a ResourceLoader instance

Since:

3.4.0

get

public static ResourceLoader get(ClassLoader classLoader)

Return a ResourceLoader supporting additional ProtocolResolvers registered in spring.factories. The factories files and resources will be resolved using the specified class loader.

Parameters:

classLoader - the class loader to use or null to use the default class loader

Returns:

a ResourceLoader instance

Since:

3.4.0

get

public static ResourceLoader get(ClassLoader classLoader,
 SpringFactoriesLoader springFactoriesLoader)

Return a ResourceLoader supporting additional ProtocolResolvers registered in spring.factories.

Parameters:

classLoader - the class loader to use or null to use the default class loader

springFactoriesLoader - the SpringFactoriesLoader used to load ProtocolResolvers

Returns:

a ResourceLoader instance

Since:

3.4.0

get

public static ResourceLoader get(ClassLoader classLoader,
 SpringFactoriesLoader springFactoriesLoader,
 Path workingDirectory)

Return a ResourceLoader supporting additional ProtocolResolvers registered in spring.factories.

Parameters:

classLoader - the class loader to use or null to use the default class loader

springFactoriesLoader - the SpringFactoriesLoader used to load ProtocolResolvers

workingDirectory - the working directory

Returns:

a ResourceLoader instance

Since:

3.5.0

get

public static ResourceLoader get(ResourceLoader resourceLoader)

Return a ResourceLoader delegating to the given resource loader and supporting additional ProtocolResolvers registered in spring.factories. The factories file will be resolved using the default class loader at the time this call is made.

Parameters:

resourceLoader - the delegate resource loader

Returns:

a ResourceLoader instance

Since:

3.4.0

get

public static ResourceLoader get(ResourceLoader resourceLoader,
 boolean preferFileResolution)

Return a ResourceLoader delegating to the given resource loader and supporting additional ProtocolResolvers registered in spring.factories. The factories file will be resolved using the default class loader at the time this call is made.

Parameters:

resourceLoader - the delegate resource loader

preferFileResolution - if file based resolution is preferred when a suitable ApplicationResourceLoader.FilePathResolver support the resource

Returns:

a ResourceLoader instance

Since:

3.4.1

get

public static ResourceLoader get(ResourceLoader resourceLoader,
 SpringFactoriesLoader springFactoriesLoader)

Return a ResourceLoader delegating to the given resource loader and supporting additional ProtocolResolvers registered in spring.factories.

Parameters:

resourceLoader - the delegate resource loader

springFactoriesLoader - the SpringFactoriesLoader used to load ProtocolResolvers

Returns:

a ResourceLoader instance

Since:

3.4.0