Interface InstallationOptions


  • @ProviderType
    public interface InstallationOptions
    Options to be used when applying the configuration. Create an instance using InstallationOptionsBuilder.
    Since:
    3.6.0
    • Method Detail

      • getConfigurationRootPath

        Optional<String> getConfigurationRootPath()
        Returns:
        the root path of the configuration files. If not set the one configured in AcInstallationServiceImpl is used.
      • getRestrictedToPaths

        List<String> getRestrictedToPaths()
        Returns:
        the list of root path entry below which ACLs should be modified. Note this does not restrict the installation of authorizables (users/groups) only the ACEs.
      • shouldSkipIfConfigUnchanged

        boolean shouldSkipIfConfigUnchanged()
        Returns:
        true if the installation should be skipped if the configuration is unchanged compared to last execution with same parameters
      • shouldUpdateExistingExternalGroups

        boolean shouldUpdateExistingExternalGroups()
        Returns:
        true if the installation should also update existing external groups. By default only new ones are created but existing ones not touched.
      • getPersistableProperties

        Map<String,​Object> getPersistableProperties()
        For asynchronous installations the options need to be persisted in the repository. As regular Java serialization cannot be used with Sling Jobs (SLING-12745) one has to rely on types compliant with default JCR.
        Returns:
        a new map with properties of types which are natively supported by the JCR resource provider
        See Also:
        InstallationOptionsBuilder