Package 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

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

    • Method Detail

      • getResource

        @Nullable
@Nullable Resource getResource​(@NotNull
                               @NotNull 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

        @Nullable
@Nullable Resource getCollectionParentResource​(@NotNull
                                               @NotNull 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

        @Nullable
@Nullable Resource getCollectionItemResource​(@NotNull
                                             @NotNull 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

        @Nullable
@Nullable java.lang.String getResourcePath​(@NotNull
                                           @NotNull java.lang.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

        @Nullable
@Nullable java.lang.String getCollectionParentResourcePath​(@NotNull
                                                           @NotNull java.lang.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

        @Nullable
@Nullable java.lang.String getCollectionItemResourcePath​(@NotNull
                                                         @NotNull java.lang.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

        @Nullable
@Nullable java.lang.String getConfigName​(@NotNull
                                         @NotNull java.lang.String configName,
                                         @Nullable
                                         @Nullable java.lang.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

        @Nullable
@Nullable java.lang.String getCollectionParentConfigName​(@NotNull
                                                         @NotNull java.lang.String configName,
                                                         @Nullable
                                                         @Nullable java.lang.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

        @Nullable
@Nullable java.lang.String getCollectionItemConfigName​(@NotNull
                                                       @NotNull java.lang.String configName,
                                                       @Nullable
                                                       @Nullable java.lang.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​(@NotNull
                             @NotNull ResourceResolver resourceResolver,
                             @NotNull
                             @NotNull java.lang.String configResourcePath,
                             @NotNull
                             @NotNull 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​(@NotNull
                                       @NotNull ResourceResolver resourceResolver,
                                       @NotNull
                                       @NotNull java.lang.String configResourceCollectionParentPath,
                                       @NotNull
                                       @NotNull 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​(@NotNull
                            @NotNull ResourceResolver resourceResolver,
                            @NotNull
                            @NotNull java.lang.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).