org.apache.sling.caconfig.spi

Interface ConfigurationPersistenceStrategy2

All Known Subinterfaces:

ConfigurationPersistenceStrategyMultiplexer

@ConsumerType
public interface ConfigurationPersistenceStrategy2

Defines how configuration data is stored in the configuration resource. This SPI allows application to define their own content structure and node types to be used for configuration data storage.

Method Summary

Modifier and Type	Method and Description
boolean	deleteConfiguration(ResourceResolver resourceResolver, String configResourcePath) Delete configuration or configuration collection data from repository using the inner-most context path as reference.
String	getCollectionItemConfigName(String configName, String relatedConfigPath) Allows the strategy to transform the given configuration name for nested configurations according to it's persistent strategies, e.g.
Resource	getCollectionItemResource(Resource resource) Allows the strategy to transform the given configuration resource according to it's persistent strategies, e.g.
String	getCollectionItemResourcePath(String resourcePath) Allows the strategy to transform the given configuration resource path according to it's persistent strategies, e.g.
String	getCollectionParentConfigName(String configName, String relatedConfigPath) Allows the strategy to transform the given configuration name for nested configurations according to it's persistent strategies, e.g.
Resource	getCollectionParentResource(Resource resource) Allows the strategy to transform the given configuration resource according to it's persistent strategies, e.g.
String	getCollectionParentResourcePath(String resourcePath) Allows the strategy to transform the given configuration resource path according to it's persistent strategies, e.g.
String	getConfigName(String configName, String relatedConfigPath) Allows the strategy to transform the given configuration name for nested configurations according to it's persistent strategies, e.g.
Resource	getResource(Resource resource) Allows the strategy to transform the given configuration resource according to it's persistent strategies, e.g.
String	getResourcePath(String resourcePath) Allows the strategy to transform the given configuration resource path according to it's persistent strategies, e.g.
boolean	persistConfiguration(ResourceResolver resourceResolver, String configResourcePath, ConfigurationPersistData data) Stores configuration data for a singleton configuration resource.
boolean	persistConfigurationCollection(ResourceResolver resourceResolver, String configResourceCollectionParentPath, ConfigurationCollectionPersistData data) Stores configuration data for a configuration resource collection.

Method Detail

getResource

@CheckForNull
Resource getResource(@Nonnull
                                   Resource resource)

Allows the strategy to transform the given configuration resource according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.

Parameters:

resource - Singleton configuration resource

Returns:

Transformed configuration resource. If null is returned this strategy does not support the given configuration resource.

getCollectionParentResource

@CheckForNull
Resource getCollectionParentResource(@Nonnull
                                                   Resource resource)

Allows the strategy to transform the given configuration resource according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.

Parameters:

resource - Configuration collection parent resource

Returns:

Transformed configuration resource. If null is returned this strategy does not support the given configuration resource.

getCollectionItemResource

@CheckForNull
Resource getCollectionItemResource(@Nonnull
                                                 Resource resource)

Allows the strategy to transform the given configuration resource according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.

Parameters:

resource - Configuration collection item resource

Returns:

Transformed configuration resource. If null is returned this strategy does not support the given configuration resource.

getResourcePath

@CheckForNull
String getResourcePath(@Nonnull
                                     String resourcePath)

Allows the strategy to transform the given configuration resource path according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.

Parameters:

resourcePath - Configuration resource path (full path)

Returns:

Transformed configuration resource path. If null is returned this strategy does not support the given configuration resource path.

getCollectionParentResourcePath

@CheckForNull
String getCollectionParentResourcePath(@Nonnull
                                                     String resourcePath)

Allows the strategy to transform the given configuration resource path according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.

Parameters:

resourcePath - Configuration collection parent resource path (full path)

Returns:

Transformed configuration resource path. If null is returned this strategy does not support the given configuration resource path.

getCollectionItemResourcePath

@CheckForNull
String getCollectionItemResourcePath(@Nonnull
                                                   String resourcePath)

Allows the strategy to transform the given configuration resource path according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.

Parameters:

resourcePath - Configuration collection item resource path (full path)

Returns:

Transformed configuration resource path. If null is returned this strategy does not support the given configuration resource path.

getConfigName

@CheckForNull
String getConfigName(@Nonnull
                                   String configName,
                                   @CheckForNull
                                   String relatedConfigPath)

Allows the strategy to transform the given configuration name for nested configurations according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.

Parameters:

configName - Configuration name

relatedConfigPath - Path of a configuration resource that was resolved in context of this configuration name. This can be used to detect if the persistence strategy supports the configuration location. If null it should be assumed that it matches.

Returns:

Transformed configuration name. If null is returned this strategy does not support the given configuration resource path.

getCollectionParentConfigName

@CheckForNull
String getCollectionParentConfigName(@Nonnull
                                                   String configName,
                                                   @CheckForNull
                                                   String relatedConfigPath)

Allows the strategy to transform the given configuration name for nested configurations according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.

Parameters:

configName - Configuration name

relatedConfigPath - Path of a configuration resource that was resolved in context of this configuration name. This can be used to detect if the persistence strategy supports the configuration location. If null it should be assumed that it matches.

Returns:

Transformed configuration name. If null is returned this strategy does not support the given configuration resource path.

getCollectionItemConfigName

@CheckForNull
String getCollectionItemConfigName(@Nonnull
                                                 String configName,
                                                 @CheckForNull
                                                 String relatedConfigPath)

Allows the strategy to transform the given configuration name for nested configurations according to it's persistent strategies, e.g. fetching the data from a child resource instead of the given resource.

Parameters:

configName - Configuration name

relatedConfigPath - Path of a configuration resource that was resolved in context of this configuration name. This can be used to detect if the persistence strategy supports the configuration location. If null it should be assumed that it matches.

Returns:

Transformed configuration name. If null is returned this strategy does not support the given configuration resource path.

persistConfiguration

boolean persistConfiguration(@Nonnull
                             ResourceResolver resourceResolver,
                             @Nonnull
                             String configResourcePath,
                             @Nonnull
                             ConfigurationPersistData data)

Stores configuration data for a singleton configuration resource. The changes are written using the given resource resolver. They are not committed, this is left to the caller.

Parameters:

resourceResolver - Resource resolver

configResourcePath - Path to store configuration data to. The resource (and it's parents) may not exist and may have to be created.

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

Returns:

true if the data was persisted. false if persisting the data was not accepted by this persistence strategy (in case of error throw an exception).

persistConfigurationCollection

boolean persistConfigurationCollection(@Nonnull
                                       ResourceResolver resourceResolver,
                                       @Nonnull
                                       String configResourceCollectionParentPath,
                                       @Nonnull
                                       ConfigurationCollectionPersistData data)

Stores configuration data for a configuration resource collection. The changes are written using the given resource resolver. They are not committed, this is left to the caller.

Parameters:

resourceResolver - Resource resolver

configResourceCollectionParentPath - Parent path to store configuration collection data to. The resource (and it's parents) may not exist and may have to be created.

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

Returns:

true if the data was persisted. false if persisting the data was not accepted by this persistence strategy (in case of error throw an exception).

deleteConfiguration

boolean deleteConfiguration(@Nonnull
                            ResourceResolver resourceResolver,
                            @Nonnull
                            String configResourcePath)

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

Parameters:

resourceResolver - Resource resolver

configResourcePath - Path to store configuration data to. The resource (and it's parents) may not exist and may have to be created.

Returns:

true if the data was delete. false if deleting the data was not accepted by this persistence strategy (in case of error throw an exception).