Package biz.netcentric.cq.tools.actool.api

Interface AcInstallationService

  • @ProviderType
public interface AcInstallationService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      InstallationLog apply()
      Applies the full configuration as stored at the path configured at PID biz.netcentric.cq.tools.actool.impl.AcInstallationServiceImpl to the repository.
      InstallationLog apply​(String configurationRootPath)
      Applies the configuration as stored at the given configurationRootPath to the repository.
      InstallationLog apply​(String[] restrictedToPaths)
      Applies parts of the configuration (based on given paths)
      InstallationLog apply​(String configurationRootPath, String[] restrictedToPaths)
      Applies the configuration as stored at the given configurationRootPath to the repository, but only apply ACEs to given restrictedToPaths.
      InstallationLog apply​(String configurationRootPath, String[] restrictedToPaths, boolean skipIfConfigUnchanged)
      Applies the configuration as stored at the given configurationRootPath to the repository, but only apply ACEs to given restrictedToPaths.
      String purgeACL​(String path)
      purges all acls of the node specified by path (no deletion of acls of subnodes)
      String purgeACLs​(String path)
      Purges all acls of the node specified by path and all acls of all subnodes
      String purgeAuthorizables​(String[] authorizableIds)
      Purges authorizable(s) and all respective aces from the system

    • Method Detail

      • apply

        InstallationLog apply()
        Applies the full configuration as stored at the path configured at PID biz.netcentric.cq.tools.actool.impl.AcInstallationServiceImpl to the repository.
        Returns:
        the installation log

      • apply

        InstallationLog apply​(String configurationRootPath)
        Applies the configuration as stored at the given configurationRootPath to the repository.
        Parameters:
        configurationRootPath - the root path for configuration files
        Returns:
        the installation log

      • apply

        InstallationLog apply​(String[] restrictedToPaths)
        Applies parts of the configuration (based on given paths)
        Parameters:
        restrictedToPaths - only apply ACLs to root paths as given
        Returns:
        the installation log

      • apply

        InstallationLog apply​(String configurationRootPath,
                      String[] restrictedToPaths)
        Applies the configuration as stored at the given configurationRootPath to the repository, but only apply ACEs to given restrictedToPaths.
        Parameters:
        restrictedToPaths - only apply ACLs to root paths as given
        configurationRootPath - the root path for configuration files
        Returns:
        the installation log

      • apply

        InstallationLog apply​(String configurationRootPath,
                      String[] restrictedToPaths,
                      boolean skipIfConfigUnchanged)
        Applies the configuration as stored at the given configurationRootPath to the repository, but only apply ACEs to given restrictedToPaths.
        Parameters:
        restrictedToPaths - only apply ACLs to root paths as given
        configurationRootPath - the root path for configuration files
        skipIfConfigUnchanged - will check if the config is unchanged compared to last execution with same parameters
        Returns:
        the installation log

      • purgeACL

        String purgeACL​(String path)
        purges all acls of the node specified by path (no deletion of acls of subnodes)
        Parameters:
        path - the path from which to purge the ACL
        Returns:
        status message

      • purgeACLs

        String purgeACLs​(String path)
        Purges all acls of the node specified by path and all acls of all subnodes
        Parameters:
        path - the path from which to purge the ACL (including those of all subnodes)
        Returns:
        status message

      • purgeAuthorizables

        String purgeAuthorizables​(String[] authorizableIds)
        Purges authorizable(s) and all respective aces from the system
        Parameters:
        authorizableIds - Array of authorizableIds to purge
        Returns:
        status message