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 and Description
boolean	isAllOverridden(java.lang.String contextPath, java.lang.String configName) Checks if the whole configuration for the given context path and name is overridden.
java.util.Map<java.lang.String,java.lang.Object>	overrideProperties(java.lang.String contextPath, java.lang.String configName, java.util.Map<java.lang.String,java.lang.Object> properties) Override properties for given context path and configuration name.
Resource	overrideProperties(java.lang.String contextPath, java.lang.String configName, Resource configResource) Deprecated. Please use overrideProperties(String, String, Resource, ResourceResolver) instead.
Resource	overrideProperties(java.lang.String contextPath, java.lang.String configName, Resource configResource, ResourceResolver resourceResolver) Override properties in given configuration resource (if any overrides are defined).

Method Detail

isAllOverridden

boolean isAllOverridden(@Nonnull
                        java.lang.String contextPath,
                        @Nonnull
                        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

@CheckForNull
java.util.Map<java.lang.String,java.lang.Object> overrideProperties(@Nonnull
                                                                                  java.lang.String contextPath,
                                                                                  @Nonnull
                                                                                  java.lang.String configName,
                                                                                  @Nonnull
                                                                                  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
 @CheckForNull
Resource overrideProperties(@Nonnull
                                                       java.lang.String contextPath,
                                                       @Nonnull
                                                       java.lang.String configName,
                                                       @CheckForNull
                                                       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

@CheckForNull
Resource overrideProperties(@Nonnull
                                          java.lang.String contextPath,
                                          @Nonnull
                                          java.lang.String configName,
                                          @CheckForNull
                                          Resource configResource,
                                          @Nonnull
                                          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