Package org.apache.sling.caconfig.management.multiplexer

Interface ConfigurationOverrideMultiplexer

@ProviderType
public interface ConfigurationOverrideMultiplexer

Detects all ConfigurationOverrideProvider implementations in the container and consolidates their result based on service ranking.

Method Summary

Modifier and Type	Method	Description
boolean	isAllOverridden(@NotNull java.lang.String contextPath, @NotNull java.lang.String configName)	Checks if the whole configuration for the given context path and name is overridden.
@Nullable java.util.Map<java.lang.String,java.lang.Object>	overrideProperties(@NotNull java.lang.String contextPath, @NotNull java.lang.String configName, @NotNull java.util.Map<java.lang.String,java.lang.Object> properties)	Override properties for given context path and configuration name.
@Nullable Resource	overrideProperties(@NotNull java.lang.String contextPath, @NotNull java.lang.String configName, @Nullable Resource configResource)	Deprecated. Please use overrideProperties(String, String, Resource, ResourceResolver) instead.
@Nullable Resource	overrideProperties(@NotNull java.lang.String contextPath, @NotNull java.lang.String configName, @Nullable Resource configResource, @NotNull ResourceResolver resourceResolver)	Override properties in given configuration resource (if any overrides are defined).

Method Detail

isAllOverridden

boolean isAllOverridden(@NotNull
                        @NotNull java.lang.String contextPath,
                        @NotNull
                        @NotNull java.lang.String configName)

Checks if the whole configuration for the given context path and name is overridden.

Parameters:

contextPath - Context path

configName - Config name

Returns:

true if the whole configuration is overridden.

overrideProperties

@Nullable
@Nullable java.util.Map<java.lang.String,java.lang.Object> overrideProperties(@NotNull
                                                                                    @NotNull java.lang.String contextPath,
                                                                                    @NotNull
                                                                                    @NotNull java.lang.String configName,
                                                                                    @NotNull
                                                                                    @NotNull java.util.Map<java.lang.String,java.lang.Object> properties)

Override properties for given context path and configuration name.

Parameters:

contextPath - Path of context resource for which configuration was resolved

configName - Configuration name

properties - Resolved configuration properties

Returns:

Overwritten or replaced properties - or null if no override took place

overrideProperties

@Deprecated
@Nullable
@Nullable Resource overrideProperties(@NotNull
                                      @NotNull java.lang.String contextPath,
                                      @NotNull
                                      @NotNull java.lang.String configName,
                                      @Nullable
                                      @Nullable Resource configResource)

Deprecated.

Please use overrideProperties(String, String, Resource, ResourceResolver) instead.

Override properties in given configuration resource (if any overrides are defined).

Parameters:

contextPath - Context path

configName - Configuration name

configResource - Resolved configuration resource

Returns:

Resource with overwritten configuration properties - or original configuration resource if no override took place

overrideProperties

@Nullable
@Nullable Resource overrideProperties(@NotNull
                                      @NotNull java.lang.String contextPath,
                                      @NotNull
                                      @NotNull java.lang.String configName,
                                      @Nullable
                                      @Nullable Resource configResource,
                                      @NotNull
                                      @NotNull ResourceResolver resourceResolver)

Override properties in given configuration resource (if any overrides are defined).

Parameters:

contextPath - Context path

configName - Configuration name

configResource - Resolved configuration resource

resourceResolver - Resource resolver

Returns:

Resource with overwritten configuration properties - or original configuration resource if no override took place