Interface InstallationOptions
-
@ProviderType public interface InstallationOptionsOptions to be used when applying the configuration. Create an instance usingInstallationOptionsBuilder.- Since:
- 3.6.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Optional<String>getConfigurationRootPath()Map<String,Object>getPersistableProperties()For asynchronous installations the options need to be persisted in the repository.List<String>getRestrictedToPaths()booleanshouldSkipIfConfigUnchanged()booleanshouldUpdateExistingExternalGroups()
-
-
-
Method Detail
-
getConfigurationRootPath
Optional<String> getConfigurationRootPath()
- Returns:
- the root path of the configuration files. If not set the one configured in
AcInstallationServiceImplis 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:
trueif the installation should be skipped if the configuration is unchanged compared to last execution with same parameters
-
shouldUpdateExistingExternalGroups
boolean shouldUpdateExistingExternalGroups()
- Returns:
trueif 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
-
-