@ConsumerType
public interface ConfigurationResourceResolvingStrategy
CollectionInheritanceDecider
SPI interface. If such services are available,
they should be called in order of there service ranking, starting with the highest
ranking. The first decider service providing a non null return value is used
for the decision.Modifier and Type | Method and Description |
---|---|
@Nullable Resource |
getResource(@NotNull Resource resource,
@NotNull java.util.Collection<java.lang.String> bucketNames,
@NotNull java.lang.String configName)
Get a context-aware singleton configuration resource defined by the given configuration name.
|
@Nullable java.util.Collection<Resource> |
getResourceCollection(@NotNull Resource resource,
@NotNull java.util.Collection<java.lang.String> bucketNames,
@NotNull java.lang.String configName)
Get a collection of context-aware configuration resources defined by the given configuration name.
|
@Nullable java.util.Collection<java.util.Iterator<Resource>> |
getResourceCollectionInheritanceChain(@NotNull Resource resource,
@NotNull java.util.Collection<java.lang.String> bucketNames,
@NotNull java.lang.String configName)
Get a collection of context-aware configuration resource inheritance chains defined by the given configuration name.
|
@Nullable java.lang.String |
getResourceCollectionParentPath(@NotNull Resource resource,
@NotNull java.lang.String bucketName,
@NotNull java.lang.String configName)
Get the configuration resource collection parent path for storing configuration data for the given context resource and configuration name.
|
@Nullable java.util.Iterator<Resource> |
getResourceInheritanceChain(@NotNull Resource resource,
@NotNull java.util.Collection<java.lang.String> bucketNames,
@NotNull java.lang.String configName)
Get a context-aware singleton configuration resource inheritance chain defined by the given configuration name.
|
@Nullable java.lang.String |
getResourcePath(@NotNull Resource resource,
@NotNull java.lang.String bucketName,
@NotNull java.lang.String configName)
Get the configuration resource path for storing configuration data for the given context resource and configuration name.
|
@Nullable @Nullable Resource getResource(@NotNull @NotNull Resource resource, @NotNull @NotNull java.util.Collection<java.lang.String> bucketNames, @NotNull @NotNull java.lang.String configName)
resource
- Context resource to fetch configuration forbucketNames
- Configuration "bucket" names. For each inheritance level all bucket names are tried, and the first
one that has a result is included.configName
- Configuration name or relative path.null
if this strategy did not found matching resources.@Nullable @Nullable java.util.Collection<Resource> getResourceCollection(@NotNull @NotNull Resource resource, @NotNull @NotNull java.util.Collection<java.lang.String> bucketNames, @NotNull @NotNull java.lang.String configName)
resource
- Context resource to fetch configuration forbucketNames
- Configuration "bucket" names. For each inheritance level all bucket names are tried, and the first
one that has a result is included.configName
- Configuration name or relative path.null
if this strategy did not found matching resources.@Nullable @Nullable java.util.Iterator<Resource> getResourceInheritanceChain(@NotNull @NotNull Resource resource, @NotNull @NotNull java.util.Collection<java.lang.String> bucketNames, @NotNull @NotNull java.lang.String configName)
getResource(Resource, Collection, String)
.resource
- Context resource to fetch configuration forbucketNames
- Configuration "bucket" names. For each inheritance level all bucket names are tried, and the first
one that has a result is included.configName
- Configuration name or relative path.null
if this strategy did not found matching resources.@Nullable @Nullable java.util.Collection<java.util.Iterator<Resource>> getResourceCollectionInheritanceChain(@NotNull @NotNull Resource resource, @NotNull @NotNull java.util.Collection<java.lang.String> bucketNames, @NotNull @NotNull java.lang.String configName)
getResourceCollection(Resource, Collection, String)
.resource
- Context resource to fetch configuration forbucketNames
- Configuration "bucket" names. For each inheritance level all bucket names are tried, and the first
one that has a result is included.configName
- Configuration name or relative path.null
if this strategy did not found matching resources.@Nullable @Nullable java.lang.String getResourcePath(@NotNull @NotNull Resource resource, @NotNull @NotNull java.lang.String bucketName, @NotNull @NotNull java.lang.String configName)
resource
- Context resource to fetch configuration forbucketName
- Configuration "bucket" name. Each high-level configuration resolver should store
it's configuration data grouped in a child resource of the configuration resource. This is what
we call a "bucket", and the resource name is specified with this parameter.configName
- Configuration name or relative path.@Nullable @Nullable java.lang.String getResourceCollectionParentPath(@NotNull @NotNull Resource resource, @NotNull @NotNull java.lang.String bucketName, @NotNull @NotNull java.lang.String configName)
resource
- Context resource to fetch configuration forbucketName
- Configuration "bucket" name. Each high-level configuration resolver should store
it's configuration data grouped in a child resource of the configuration resource. This is what
we call a "bucket", and the resource name is specified with this parameter.configName
- Configuration name or relative path.Copyright © 2022 The Apache Software Foundation. All rights reserved.