org.apache.sling.caconfig.management

Interface ConfigurationManager

@ProviderType
public interface ConfigurationManager

Manages reading and writing configurations e.g. for Editor GUIs. It manages only configurations handled by ConfigurationResolver, no low-level configuration resources managed by ConfigurationResourceResolver.

Method Summary

Modifier and Type	Method and Description
void	deleteConfiguration(Resource resource, java.lang.String configName) Delete configuration or configuration collection data from repository using the inner-most context path as reference.
ConfigurationData	getConfiguration(Resource resource, java.lang.String configName) Get configuration data for the given context resource and configuration name.
ConfigurationCollectionData	getConfigurationCollection(Resource resource, java.lang.String configName) Get configuration data collection for the given context resource and configuration name.
ConfigurationMetadata	getConfigurationMetadata(java.lang.String configName) Get configuration metadata from any configuration metadata provider.
java.util.SortedSet<java.lang.String>	getConfigurationNames() Get all configuration names.
java.lang.String	getPersistenceResourcePath(java.lang.String configResourcePath) Deprecated. Please use ConfigurationPersistenceStrategyMultiplexer instead.
ConfigurationData	newCollectionItem(Resource resource, java.lang.String configName) Creates a new empty configuration data item for a configuration data collection for the given configuration name.
void	persistConfiguration(Resource resource, java.lang.String configName, ConfigurationPersistData data) Write configuration data to repository using the inner-most context path as reference.
void	persistConfigurationCollection(Resource resource, java.lang.String configName, ConfigurationCollectionPersistData data) Write configuration data collection using the inner-most context path as reference.

Method Detail

getConfiguration

@CheckForNull
ConfigurationData getConfiguration(@Nonnull
                                                 Resource resource,
                                                 @Nonnull
                                                 java.lang.String configName)

Get configuration data for the given context resource and configuration name.

Parameters:

resource - Context resource

configName - Configuration name

Returns:

Configuration data. Is null when no configuration resource found and no configuration metadata exists.

getConfigurationCollection

@Nonnull
ConfigurationCollectionData getConfigurationCollection(@Nonnull
                                                                Resource resource,
                                                                @Nonnull
                                                                java.lang.String configName)

Get configuration data collection for the given context resource and configuration name.

Parameters:

resource - Context resource

configName - Configuration name

Returns:

Configuration data collection. Is empty when no configuration resources found.

persistConfiguration

void persistConfiguration(@Nonnull
                          Resource resource,
                          @Nonnull
                          java.lang.String configName,
                          @Nonnull
                          ConfigurationPersistData data)

Write configuration data to repository using the inner-most context path as reference.

Parameters:

resource - Context resource

configName - Configuration name

data - Configuration data to be stored. All existing properties are erased and replaced with the new ones.

persistConfigurationCollection

void persistConfigurationCollection(@Nonnull
                                    Resource resource,
                                    @Nonnull
                                    java.lang.String configName,
                                    @Nonnull
                                    ConfigurationCollectionPersistData data)

Write configuration data collection using the inner-most context path as reference.

Parameters:

resource - Context resource

configName - Configuration name

data - Configuration collection data to be stored. All existing collection entries on this context path level are erased and replaced with the new ones.

newCollectionItem

@CheckForNull
ConfigurationData newCollectionItem(@Nonnull
                                                  Resource resource,
                                                  @Nonnull
                                                  java.lang.String configName)

Creates a new empty configuration data item for a configuration data collection for the given configuration name.

Parameters:

resource - Context resource

configName - Configuration name

Returns:

Configuration data. Is null when no configuration metadata exists.

deleteConfiguration

void deleteConfiguration(@Nonnull
                         Resource resource,
                         @Nonnull
                         java.lang.String configName)

Delete configuration or configuration collection data from repository using the inner-most context path as reference.

Parameters:

resource - Context resource

configName - Configuration name

getConfigurationNames

@Nonnull
java.util.SortedSet<java.lang.String> getConfigurationNames()

Get all configuration names. The results of all configuration metadata provider implementations are merged.

Returns:

Configuration names

getConfigurationMetadata

@CheckForNull
ConfigurationMetadata getConfigurationMetadata(@Nonnull
                                                             java.lang.String configName)

Get configuration metadata from any configuration metadata provider.

Parameters:

configName - Configuration name

Returns:

Configuration metadata or null if none exists for the given name.

getPersistenceResourcePath

@Deprecated
 @CheckForNull
java.lang.String getPersistenceResourcePath(@Nonnull
                                                                       java.lang.String configResourcePath)

Deprecated. Please use ConfigurationPersistenceStrategyMultiplexer instead.

Rewrite given resource path or configuration name according to current persistence strategies.

Parameters:

configResourcePath - Resource path or config name

Returns:

Rewritten resource path or config name