#503 Using own interface AuthInstallerUserManager to avoid future

problems for in case oak UserManager interface gets extended

Author: ghenzler

accesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/authorizableinstaller/impl/AuthInstallerUserManager.java

@@ -0,0 +1,37 @@
+package biz.netcentric.cq.tools.actool.authorizableinstaller.impl;
+
+import java.security.Principal;
+import java.util.Set;
+
+import javax.jcr.RepositoryException;
+
+import org.apache.jackrabbit.api.security.user.Authorizable;
+import org.apache.jackrabbit.api.security.user.Group;
+import org.apache.jackrabbit.api.security.user.User;
+import org.apache.jackrabbit.api.security.user.UserManager;
+
+/** Replicates the methods from {@link UserManager} but does not extend this interface because {@link UserManager} is a provider type that
+ * may receive additional methods in the future (and hence it would break this code). See {@link AuthInstallerUserManagerPrefetchingImpl}
+ * for the motivation to use this special user manager (performance). */
+interface AuthInstallerUserManager {
+
+    // -- AC Tool special methods
+    Set<String> getDeclaredIsMemberOf(String id) throws RepositoryException;
+
+    Set<String> getDeclaredMembersWithoutRegularUsers(String id);
+
+    UserManager getOakUserManager();
+
+    // -- methods from oak UserManager that the AC tool uses (delegated, only the relevant methods are listed here)
+
+    Authorizable getAuthorizable(String id) throws RepositoryException;
+
+    User createUser(String userID, String password, Principal principal, String intermediatePath) throws RepositoryException;
+
+    User createSystemUser(String userID, String intermediatePath) throws RepositoryException;
+
+    Group createGroup(Principal principal) throws RepositoryException;
+
+    Group createGroup(Principal principal, String intermediatePath) throws RepositoryException;
+
+}

…staller/impl/PrefetchingUserManager.java …InstallerUserManagerPrefetchingImpl.javaaccesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/authorizableinstaller/impl/PrefetchingUserManager.java renamed to accesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/authorizableinstaller/impl/AuthInstallerUserManagerPrefetchingImpl.java accesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/authorizableinstaller/impl/PrefetchingUserManager.java renamed to accesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/authorizableinstaller/impl/AuthInstallerUserManagerPrefetchingImpl.java

@@ -45,22 +45,22 @@
  * to groups).
  * </p>
  */
-class PrefetchingUserManager implements UserManager {
+class AuthInstallerUserManagerPrefetchingImpl implements AuthInstallerUserManager {
 
-    private static final Logger LOG = LoggerFactory.getLogger(PrefetchingUserManager.class);
+    private static final Logger LOG = LoggerFactory.getLogger(AuthInstallerUserManagerPrefetchingImpl.class);
 
     private final UserManager delegate;
     private final Map<String, Authorizable> authorizableCache = new HashMap<>();
 
     private final Map<String, Set<String>> nonRegularUserMembersByAuthorizableId = new HashMap<>();
     private final Map<String, Set<String>> isMemberOfByAuthorizableId = new HashMap<>();
 
-    public PrefetchingUserManager(UserManager delegate, final ValueFactory valueFactory, InstallationLogger installLog)
+    public AuthInstallerUserManagerPrefetchingImpl(UserManager delegate, final ValueFactory valueFactory, InstallationLogger installLog)
             throws RepositoryException {
         this.delegate = delegate;
 
         long startPrefetch = System.currentTimeMillis();
-        Iterator<Authorizable> allGroupsAndSystemUsersAndAnonymous = delegate.findAuthorizables(new Query() {
+        Iterator<Authorizable> authorizablesToPrefetchIt = delegate.findAuthorizables(new Query() {
             public <T> void build(QueryBuilder<T> builder) {
                 builder.setCondition(
                         builder.or( //
@@ -69,8 +69,8 @@ public <T> void build(QueryBuilder<T> builder) {
                 );
             }
         });
-        while (allGroupsAndSystemUsersAndAnonymous.hasNext()) {
-            Authorizable auth = allGroupsAndSystemUsersAndAnonymous.next();
+        while (authorizablesToPrefetchIt.hasNext()) {
+            Authorizable auth = authorizablesToPrefetchIt.next();
             String authId = auth.getID();
             authorizableCache.put(authId, auth);
 
@@ -100,7 +100,6 @@ public <T> void build(QueryBuilder<T> builder) {
                 + msHumanReadable(System.currentTimeMillis() - startPrefetchMemberships));
     }
 
-    @Override
     public Authorizable getAuthorizable(String id) throws RepositoryException {
         Authorizable authorizable = authorizableCache.get(id);
         if (authorizable == null) {
@@ -137,28 +136,8 @@ public int getCacheSize() {
 
     // --- delegated methods
 
-    public Authorizable getAuthorizable(Principal principal) throws RepositoryException {
-        return delegate.getAuthorizable(principal);
-    }
-
-    public Authorizable getAuthorizableByPath(String path) throws RepositoryException {
-        return delegate.getAuthorizableByPath(path);
-    }
-
-    public Iterator<Authorizable> findAuthorizables(String relPath, String value) throws RepositoryException {
-        return delegate.findAuthorizables(relPath, value);
-    }
-
-    public Iterator<Authorizable> findAuthorizables(String relPath, String value, int searchType) throws RepositoryException {
-        return delegate.findAuthorizables(relPath, value, searchType);
-    }
-
-    public Iterator<Authorizable> findAuthorizables(Query query) throws RepositoryException {
-        return delegate.findAuthorizables(query);
-    }
-
-    public User createUser(String userID, String password) throws RepositoryException {
-        return delegate.createUser(userID, password);
+    public UserManager getOakUserManager() {
+        return delegate;
     }
 
     public User createUser(String userID, String password, Principal principal, String intermediatePath) throws RepositoryException {
@@ -169,28 +148,12 @@ public User createSystemUser(String userID, String intermediatePath) throws Repo
         return delegate.createSystemUser(userID, intermediatePath);
     }
 
-    public Group createGroup(String groupID) throws RepositoryException {
-        return delegate.createGroup(groupID);
-    }
-
     public Group createGroup(Principal principal) throws RepositoryException {
         return delegate.createGroup(principal);
     }
-
+    
     public Group createGroup(Principal principal, String intermediatePath) throws RepositoryException {
         return delegate.createGroup(principal, intermediatePath);
     }
 
-    public Group createGroup(String groupID, Principal principal, String intermediatePath) throws RepositoryException {
-        return delegate.createGroup(groupID, principal, intermediatePath);
-    }
-
-    public boolean isAutoSave() {
-        return delegate.isAutoSave();
-    }
-
-    public void autoSave(boolean enable) throws RepositoryException {
-        delegate.autoSave(enable);
-    }
-
 }

accesscontroltool-bundle/src/main/java/biz/netcentric/cq/tools/actool/authorizableinstaller/impl/AuthorizableInstallerServiceImpl.java

@@ -111,7 +111,7 @@ public void installAuthorizables(
             final Session session, InstallationLogger installLog)
             throws RepositoryException, AuthorizableCreatorException, LoginException, IOException, GeneralSecurityException {
 
-        PrefetchingUserManager userManager = new PrefetchingUserManager(AccessControlUtils.getUserManagerAutoSaveDisabled(session), session.getValueFactory(), installLog);
+        AuthInstallerUserManager userManager = new AuthInstallerUserManagerPrefetchingImpl(AccessControlUtils.getUserManagerAutoSaveDisabled(session), session.getValueFactory(), installLog);
 
         Set<String> authorizablesFromConfigurations = authorizablesConfigBeans.getAuthorizableIds();
         for (AuthorizableConfigBean authorizableConfigBean : authorizablesConfigBeans) {
@@ -125,7 +125,7 @@ public void installAuthorizables(
     }
 
     private void installAuthorizableConfigurationBean(final Session session,
-            PrefetchingUserManager userManager,
+            AuthInstallerUserManager userManager,
             AcConfiguration acConfiguration,
             AuthorizableConfigBean authorizableConfigBean,
             InstallationLogger installLog, Set<String> authorizablesFromConfigurations)
@@ -269,7 +269,7 @@ private String getPassword(final AuthorizableConfigBean authorizableConfigBean)
      * regular relationships between groups contained in config are kept in isMemberOf */
     @SuppressWarnings("unchecked")
     void applyGroupMembershipConfigMembers(AcConfiguration acConfiguration, AuthorizableConfigBean authorizableConfigBean, InstallationLogger installLog,
-            String authorizableId, PrefetchingUserManager userManager, Set<String> authorizablesFromConfigurations) throws RepositoryException {
+            String authorizableId, AuthInstallerUserManager userManager, Set<String> authorizablesFromConfigurations) throws RepositoryException {
         if (authorizableConfigBean.isGroup()) {
 
             String[] membersInConfigArr = authorizableConfigBean.getMembers();
@@ -351,7 +351,7 @@ private Set<String> removeExternalMembersUnmanagedByConfiguration(AcConfiguratio
     }
 
 
-    private void migrateFromOldGroup(AuthorizableConfigBean authorizableConfigBean, UserManager userManager,
+    private void migrateFromOldGroup(AuthorizableConfigBean authorizableConfigBean, AuthInstallerUserManager userManager,
             InstallationLogger installLog) throws RepositoryException {
         Authorizable groupForMigration = userManager.getAuthorizable(authorizableConfigBean.getMigrateFrom());
 
@@ -399,7 +399,7 @@ private void handleRecreationOfAuthorizableIfNecessary(final Session session,
             AcConfiguration acConfiguration, 
             AuthorizableConfigBean principalConfigBean,
             InstallationLogger installLog,
-            UserManager userManager) throws RepositoryException, AuthorizableCreatorException {
+            AuthInstallerUserManager userManager) throws RepositoryException, AuthorizableCreatorException {
 
         String authorizableId = principalConfigBean.getAuthorizableId();
 
@@ -504,7 +504,7 @@ private void deleteOldIntermediatePath(final Session session,
 
     private void applyGroupMembershipConfigIsMemberOf(InstallationLogger installLog,
             AcConfiguration acConfiguration,
-            AuthorizableConfigBean authorizableConfigBean, PrefetchingUserManager userManager, Session session,
+            AuthorizableConfigBean authorizableConfigBean, AuthInstallerUserManager userManager, Session session,
             Set<String> authorizablesFromConfigurations) throws RepositoryException, AuthorizableCreatorException {
 
         String authId = authorizableConfigBean.getAuthorizableId();
@@ -520,7 +520,7 @@ private Authorizable createNewAuthorizable(
             AcConfiguration acConfiguration, 
             AuthorizableConfigBean principalConfigBean,
             InstallationLogger installLog,
-            UserManager userManager, Session session)
+            AuthInstallerUserManager userManager, Session session)
             throws AuthorizableExistsException, RepositoryException,
             AuthorizableCreatorException {
 
@@ -561,7 +561,7 @@ private Set<String> getMembershipGroupsFromConfig(String[] memberOf) {
     @SuppressWarnings("unchecked")
     void applyGroupMembershipConfigIsMemberOf(AuthorizableConfigBean authorizableConfigBean,
             AcConfiguration acConfiguration,
-            InstallationLogger installLog, UserManager userManager, Session session,
+            InstallationLogger installLog, AuthInstallerUserManager userManager, Session session,
             Set<String> membershipGroupsFromConfig,
             Set<String> membershipGroupsFromRepository, Set<String> authorizablesFromConfigurations)
             throws RepositoryException, AuthorizableExistsException,
@@ -637,7 +637,7 @@ void applyGroupMembershipConfigIsMemberOf(AuthorizableConfigBean authorizableCon
     }
 
     private Authorizable createNewGroup(
-            final UserManager userManager,
+            final AuthInstallerUserManager userManager,
             AuthorizablesConfig authorizablesConfig, 
             AuthorizableConfigBean principalConfigBean,
             InstallationLogger installLog, Session session)
@@ -657,7 +657,7 @@ private Authorizable createNewGroup(
                     throw new IllegalStateException("External IDs are not available for your AEM version ("
                             + principalConfigBean.getAuthorizableId() + " is using '" + principalConfigBean.getExternalId() + "')");
                 }
-                newGroup = (Group) externalGroupCreatorService.createGroupWithExternalId(userManager, principalConfigBean, installLog, session);
+                newGroup = (Group) externalGroupCreatorService.createGroupWithExternalId(userManager.getOakUserManager(), principalConfigBean, installLog, session);
                 LOG.info("Successfully created new external group: {}", groupID);
             } else {
 
@@ -776,7 +776,7 @@ void setAuthorizableProperties(Authorizable authorizable, AuthorizableConfigBean
     }
 
     private Authorizable createNewUser(
-            final UserManager userManager,
+            final AuthInstallerUserManager userManager,
             AuthorizablesConfig authorizablesConfig, 
             AuthorizableConfigBean principalConfigBean,
             InstallationLogger installLog,
@@ -807,7 +807,7 @@ private Authorizable createNewUser(
     }
 
     private void addMembersToReferencingAuthorizables(Authorizable authorizable, AuthorizablesConfig authorizablesConfig, AuthorizableConfigBean principalConfigBean,
-            final UserManager userManager, Session session, InstallationLogger installLog)
+            final AuthInstallerUserManager userManager, Session session, InstallationLogger installLog)
             throws RepositoryException, AuthorizableCreatorException {
         String authorizableId = principalConfigBean.getAuthorizableId();
         String[] memberOf = principalConfigBean.getIsMemberOf();
@@ -839,7 +839,7 @@ private void addMembersToReferencingAuthorizables(Authorizable authorizable, Aut
      * @throws RepositoryException
      * @throws AuthorizableCreatorException if one of the authorizables contained in membersOf array is a user */
     Set<String> validateAssignedGroups(
-            final UserManager userManager, AuthorizablesConfig authorizablesConfig, Session session, final String authorizablelId,
+            final AuthInstallerUserManager userManager, AuthorizablesConfig authorizablesConfig, Session session, final String authorizablelId,
             final Set<String> isMemberOf, InstallationLogger installLog) throws RepositoryException,
             AuthorizableCreatorException {
 

…ler/impl/PrefetchingUserManagerTest.java …allerUserManagerPrefetchingImplTest.javaaccesscontroltool-bundle/src/test/java/biz/netcentric/cq/tools/actool/authorizableinstaller/impl/PrefetchingUserManagerTest.java renamed to accesscontroltool-bundle/src/test/java/biz/netcentric/cq/tools/actool/authorizableinstaller/impl/AuthInstallerUserManagerPrefetchingImplTest.java accesscontroltool-bundle/src/test/java/biz/netcentric/cq/tools/actool/authorizableinstaller/impl/PrefetchingUserManagerTest.java renamed to accesscontroltool-bundle/src/test/java/biz/netcentric/cq/tools/actool/authorizableinstaller/impl/AuthInstallerUserManagerPrefetchingImplTest.java

@@ -29,7 +29,7 @@
 import biz.netcentric.cq.tools.actool.history.InstallationLogger;
 
 @RunWith(MockitoJUnitRunner.class)
-public class PrefetchingUserManagerTest {
+public class AuthInstallerUserManagerPrefetchingImplTest {
 
     @Mock
     UserManager userManager;
@@ -58,7 +58,7 @@ public class PrefetchingUserManagerTest {
     @Mock
     User userNonCached;
 
-    PrefetchingUserManager prefetchingUserManager;
+    AuthInstallerUserManagerPrefetchingImpl prefetchingUserManager;
 
     @Before
     public void before() throws RepositoryException {
@@ -80,7 +80,7 @@ private void setupAuthorizable(Authorizable auth, String id, List<Group> memberO
 
     @Test
     public void testPrefetchedAuthorizablesUserManager() throws RepositoryException {
-        prefetchingUserManager = new PrefetchingUserManager(userManager, valueFactory, installationLogger);
+        prefetchingUserManager = new AuthInstallerUserManagerPrefetchingImpl(userManager, valueFactory, installationLogger);
 
         assertEquals(5, prefetchingUserManager.getCacheSize());
         assertEquals(group1, prefetchingUserManager.getAuthorizable("group1"));
@@ -92,59 +92,27 @@ public void testPrefetchedAuthorizablesUserManager() throws RepositoryException
 
     @Test
     public void testDelegation() throws RepositoryException {
-        prefetchingUserManager = new PrefetchingUserManager(userManager, valueFactory, installationLogger);
+        prefetchingUserManager = new AuthInstallerUserManagerPrefetchingImpl(userManager, valueFactory, installationLogger);
 
         String testuser = "test";
         PrincipalImpl testPrincipal = new PrincipalImpl(testuser);
-        prefetchingUserManager.getAuthorizable(testPrincipal);
-        verify(userManager, times(1)).getAuthorizable(testPrincipal);
 
         String userPath = "/home/users/path";
-        prefetchingUserManager.getAuthorizableByPath(userPath);
-        verify(userManager, times(1)).getAuthorizableByPath(userPath);
-
-        String relPath = "profile/test";
-        String testVal = "testval";
-        prefetchingUserManager.findAuthorizables(relPath, testVal);
-        verify(userManager, times(1)).findAuthorizables(relPath, testVal);
-        prefetchingUserManager.findAuthorizables(relPath, testVal, UserManager.SEARCH_TYPE_AUTHORIZABLE);
-        verify(userManager, times(1)).findAuthorizables(relPath, testVal, UserManager.SEARCH_TYPE_AUTHORIZABLE);
-
-        Query testQuery = new Query() {
-            public <T> void build(QueryBuilder<T> builder) {
-                // fetch all authorizables
-            }
-        };
-        prefetchingUserManager.findAuthorizables(testQuery);
-        verify(userManager, times(1)).findAuthorizables(testQuery);
-
         String testpw = "pw";
-        prefetchingUserManager.createUser(testuser, testpw);
-        verify(userManager, times(1)).createUser(testuser, testpw);
-
         prefetchingUserManager.createUser(testuser, testpw, testPrincipal, userPath);
         verify(userManager, times(1)).createUser(testuser, testpw, testPrincipal, userPath);
 
         prefetchingUserManager.createSystemUser(testuser, userPath);
         verify(userManager, times(1)).createSystemUser(testuser, userPath);
 
-        prefetchingUserManager.createGroup(testuser);
-        verify(userManager, times(1)).createGroup(testuser);
 
         prefetchingUserManager.createGroup(testPrincipal);
         verify(userManager, times(1)).createGroup(testPrincipal);
 
         prefetchingUserManager.createGroup(testPrincipal, userPath);
         verify(userManager, times(1)).createGroup(testPrincipal, userPath);
 
-        prefetchingUserManager.createGroup(testuser, testPrincipal, userPath);
-        verify(userManager, times(1)).createGroup(testuser, testPrincipal, userPath);
-
-        prefetchingUserManager.autoSave(true);
-        verify(userManager, times(1)).autoSave(true);
 
-        prefetchingUserManager.isAutoSave();
-        verify(userManager, times(1)).isAutoSave();
     }
 
 }