Package 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 Detail

      • getConfiguration

        @Nullable
@Nullable ConfigurationData getConfiguration​(@NotNull
                                             @NotNull Resource resource,
                                             @NotNull
                                             @NotNull 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

        @NotNull
@NotNull ConfigurationCollectionData getConfigurationCollection​(@NotNull
                                                                @NotNull Resource resource,
                                                                @NotNull
                                                                @NotNull 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​(@NotNull
                          @NotNull Resource resource,
                          @NotNull
                          @NotNull java.lang.String configName,
                          @NotNull
                          @NotNull 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​(@NotNull
                                    @NotNull Resource resource,
                                    @NotNull
                                    @NotNull java.lang.String configName,
                                    @NotNull
                                    @NotNull 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

        @Nullable
@Nullable ConfigurationData newCollectionItem​(@NotNull
                                              @NotNull Resource resource,
                                              @NotNull
                                              @NotNull 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​(@NotNull
                         @NotNull Resource resource,
                         @NotNull
                         @NotNull 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

        @NotNull
@NotNull 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

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