org.apache.sling.caconfig.management

Interface ConfigurationData

@ProviderType
public interface ConfigurationData

Provides access to the configuration data and metadata for a given context path.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCollectionItemName() In case of configuration resource collection, this returns the collection item resource name.
java.lang.String	getConfigName() Get configuration name.
ValueMap	getEffectiveValues() Configuration values stored for the given context path merged with inherited values and default values.
java.util.Set<java.lang.String>	getPropertyNames() List of effective property names defined in configuration metadata or values are defined for.
java.lang.String	getResourcePath()
ValueInfo<?>	getValueInfo(java.lang.String propertyName) Get detailed metadata information about the property value.
ValueMap	getValues() Configuration values stored for the given context path.
boolean	isInherited()
boolean	isOverridden()

Method Detail

getConfigName

@Nonnull
java.lang.String getConfigName()

Get configuration name.

Returns:

Configuration name

getCollectionItemName

@CheckForNull
java.lang.String getCollectionItemName()

In case of configuration resource collection, this returns the collection item resource name.

Returns:

Item resource name or null if it is a singleton resource.

getResourcePath

@CheckForNull
java.lang.String getResourcePath()

Returns:

Path of the configuration resource or null if it cannot be determined.

getPropertyNames

@Nonnull
java.util.Set<java.lang.String> getPropertyNames()

List of effective property names defined in configuration metadata or values are defined for.

Returns:

Property names

getValues

@Nonnull
ValueMap getValues()

Configuration values stored for the given context path. No inherited values. No default values. The properties of the resource identified by getResourcePath() are returned. If this resources does not exist, the map is empty.

Returns:

Values

getEffectiveValues

@Nonnull
ValueMap getEffectiveValues()

Configuration values stored for the given context path merged with inherited values and default values.

Returns:

Values

getValueInfo

@CheckForNull
ValueInfo<?> getValueInfo(java.lang.String propertyName)

Get detailed metadata information about the property value.

Parameters:

propertyName - Property name

Returns:

Value information. Null if neither property metadata nor an existing value exists.

isInherited

boolean isInherited()

Returns:

true if the whole configuration is inherited.

isOverridden

boolean isOverridden()

Returns:

true if the whole configuration is overridden by an configuration override provider.