org.springframework.boot.context.config

Interface ConfigDataLocationResolver<L extends ConfigDataLocation>

Type Parameters:

L - the location type

public interface ConfigDataLocationResolver<L extends ConfigDataLocation>

Strategy interface used to resolve locations from a String based location address. Implementations should be added as a spring.factories entries. The following constructor parameter types are supported:

• Log - if the resolver needs deferred logging
• Binder - if the resolver needs to obtain values from the initial Environment
• ResourceLoader - if the resolver needs a resource loader
• ConfigurableBootstrapContext - A bootstrap context that can be used to store objects that may be expensive to create, or need to be shared (BootstrapContext or BootstrapRegistry may also be used).

Resolvers may implement Ordered or use the @Order annotation. The first resolver that supports the given location will be used.

Since:

2.4.0

Author:

Phillip Webb, Madhura Bhave

Method Summary

Modifier and Type	Method and Description
boolean	isResolvable(ConfigDataLocationResolverContext context, String location) Returns if the specified location address can be resolved by this resolver.
List<L>	resolve(ConfigDataLocationResolverContext context, String location, boolean optional) Resolve a location string into one or more ConfigDataLocation instances.
default List<L>	resolveProfileSpecific(ConfigDataLocationResolverContext context, String location, boolean optional, Profiles profiles) Resolve a location string into one or more ConfigDataLocation instances based on available profiles.

Method Detail

isResolvable

boolean isResolvable(ConfigDataLocationResolverContext context,
                     String location)

Returns if the specified location address can be resolved by this resolver.

Parameters:

context - the location resolver context

location - the location to check.

Returns:

if the location is supported by this resolver

resolve

List<L> resolve(ConfigDataLocationResolverContext context,
                String location,
                boolean optional)
         throws ConfigDataLocationNotFoundException

Resolve a location string into one or more ConfigDataLocation instances.

Parameters:

context - the location resolver context

location - the location that should be resolved

optional - if the location is optional

Returns:

a list of resolved locations in ascending priority order. If the same key is contained in more than one of the location, then the later source will win.

Throws:

ConfigDataLocationNotFoundException - on a non-optional location that cannot be found

resolveProfileSpecific

default List<L> resolveProfileSpecific(ConfigDataLocationResolverContext context,
                                       String location,
                                       boolean optional,
                                       Profiles profiles)
                                throws ConfigDataLocationNotFoundException

Resolve a location string into one or more ConfigDataLocation instances based on available profiles. This method is called once profiles have been deduced from the contributed values. By default this method returns an empty list.

Parameters:

context - the location resolver context

location - the location that should be resolved

optional - if the location is optional

profiles - profile information

Returns:

a list of resolved locations in ascending priority order.If the same key is contained in more than one of the location, then the later source will win.

Throws:

ConfigDataLocationNotFoundException - on a non-optional location that cannot be found