org.apache.sling.caconfig.management.impl

Class ConfigurationManagerImpl

java.lang.Object

org.apache.sling.caconfig.management.impl.ConfigurationManagerImpl

All Implemented Interfaces:

ConfigurationManager

public class ConfigurationManagerImpl
extends Object
implements ConfigurationManager

Constructor Summary

Constructors

Constructor and Description
ConfigurationManagerImpl()

Method Summary

Modifier and Type	Method and Description
void	deleteConfiguration(@NotNull org.apache.sling.api.resource.Resource resource, @NotNull String configName) Delete configuration or configuration collection data from repository using the inner-most context path as reference.
ConfigurationData	getConfiguration(@NotNull org.apache.sling.api.resource.Resource resource, @NotNull String configName) Get configuration data for the given context resource and configuration name.
@NotNull ConfigurationCollectionData	getConfigurationCollection(@NotNull org.apache.sling.api.resource.Resource resource, @NotNull String configName) Get configuration data collection for the given context resource and configuration name.
org.apache.sling.caconfig.spi.metadata.ConfigurationMetadata	getConfigurationMetadata(@NotNull String configName) Get configuration metadata from any configuration metadata provider.
@NotNull SortedSet<String>	getConfigurationNames() Get all configuration names.
String	getPersistenceResourcePath(@NotNull String configResourcePath) Rewrite given resource path or configuration name according to current persistence strategies.
ConfigurationData	newCollectionItem(@NotNull org.apache.sling.api.resource.Resource resource, @NotNull String configName) Creates a new empty configuration data item for a configuration data collection for the given configuration name.
void	persistConfiguration(@NotNull org.apache.sling.api.resource.Resource resource, @NotNull String configName, @NotNull org.apache.sling.caconfig.spi.ConfigurationPersistData data) Write configuration data to repository using the inner-most context path as reference.
void	persistConfigurationCollection(@NotNull org.apache.sling.api.resource.Resource resource, @NotNull String configName, @NotNull org.apache.sling.caconfig.spi.ConfigurationCollectionPersistData data) Write configuration data collection using the inner-most context path as reference.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigurationManagerImpl

public ConfigurationManagerImpl()

Method Detail

getConfiguration

public ConfigurationData getConfiguration(@NotNull
                                          @NotNull org.apache.sling.api.resource.Resource resource,
                                          @NotNull
                                          @NotNull String configName)

Description copied from interface: ConfigurationManager

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

Specified by:

getConfiguration in interface ConfigurationManager

Parameters:

resource - Context resource

configName - Configuration name

Returns:

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

getConfigurationCollection

@NotNull
public @NotNull ConfigurationCollectionData getConfigurationCollection(@NotNull
                                                                                 @NotNull org.apache.sling.api.resource.Resource resource,
                                                                                 @NotNull
                                                                                 @NotNull String configName)

Description copied from interface: ConfigurationManager

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

Specified by:

getConfigurationCollection in interface ConfigurationManager

Parameters:

resource - Context resource

configName - Configuration name

Returns:

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

persistConfiguration

public void persistConfiguration(@NotNull
                                 @NotNull org.apache.sling.api.resource.Resource resource,
                                 @NotNull
                                 @NotNull String configName,
                                 @NotNull
                                 @NotNull org.apache.sling.caconfig.spi.ConfigurationPersistData data)

Description copied from interface: ConfigurationManager

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

Specified by:

persistConfiguration in interface ConfigurationManager

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

public void persistConfigurationCollection(@NotNull
                                           @NotNull org.apache.sling.api.resource.Resource resource,
                                           @NotNull
                                           @NotNull String configName,
                                           @NotNull
                                           @NotNull org.apache.sling.caconfig.spi.ConfigurationCollectionPersistData data)

Description copied from interface: ConfigurationManager

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

Specified by:

persistConfigurationCollection in interface ConfigurationManager

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

public ConfigurationData newCollectionItem(@NotNull
                                           @NotNull org.apache.sling.api.resource.Resource resource,
                                           @NotNull
                                           @NotNull String configName)

Description copied from interface: ConfigurationManager

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

Specified by:

newCollectionItem in interface ConfigurationManager

Parameters:

resource - Context resource

configName - Configuration name

Returns:

Configuration data. Is null when no configuration metadata exists.

deleteConfiguration

public void deleteConfiguration(@NotNull
                                @NotNull org.apache.sling.api.resource.Resource resource,
                                @NotNull
                                @NotNull String configName)

Description copied from interface: ConfigurationManager

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

Specified by:

deleteConfiguration in interface ConfigurationManager

Parameters:

resource - Context resource

configName - Configuration name

getConfigurationNames

@NotNull
public @NotNull SortedSet<String> getConfigurationNames()

Description copied from interface: ConfigurationManager

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

Specified by:

getConfigurationNames in interface ConfigurationManager

Returns:

Configuration names

getConfigurationMetadata

public org.apache.sling.caconfig.spi.metadata.ConfigurationMetadata getConfigurationMetadata(@NotNull
                                                                                             @NotNull String configName)

Description copied from interface: ConfigurationManager

Get configuration metadata from any configuration metadata provider.

Specified by:

getConfigurationMetadata in interface ConfigurationManager

Parameters:

configName - Configuration name

Returns:

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

getPersistenceResourcePath

public String getPersistenceResourcePath(@NotNull
                                         @NotNull String configResourcePath)

Description copied from interface: ConfigurationManager

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

Specified by:

getPersistenceResourcePath in interface ConfigurationManager

Parameters:

configResourcePath - Resource path or config name

Returns:

Rewritten resource path or config name