org.apache.sling.caconfig.spi

Interface ConfigurationPersistenceStrategy

public interface ConfigurationPersistenceStrategy

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.
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

Resource getResource(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 resource

Returns:

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

getResourcePath

String getResourcePath(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 or part of it (e.g. config name)

Returns:

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

persistConfiguration

boolean persistConfiguration(ResourceResolver resourceResolver,
                             String configResourcePath,
                             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 persistence data

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(ResourceResolver resourceResolver,
                                       String configResourceCollectionParentPath,
                                       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(ResourceResolver resourceResolver,
                            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).