progress

Author: Jeff Bornemann

src/main/groovy/com/twcable/grabbit/client/jcr/AuthorizableProtoNodeDecorator.groovy renamed to src/main/groovy/com/twcable/grabbit/jcr/AuthorizableProtoNodeDecorator.groovy

@@ -1,11 +1,9 @@
-package com.twcable.grabbit.client.jcr
+package com.twcable.grabbit.jcr
 
-import com.twcable.grabbit.jcr.JcrNodeDecorator
-import com.twcable.grabbit.jcr.ProtoNodeDecorator
+import com.twcable.grabbit.proto.NodeProtos.Node as ProtoNode
 import com.twcable.grabbit.security.AuthorizablePrincipal
 import com.twcable.grabbit.security.InsufficientGrabbitPrivilegeException
 import groovy.transform.CompileStatic
-import groovy.transform.InheritConstructors
 import groovy.util.logging.Slf4j
 import org.apache.jackrabbit.api.security.user.Authorizable
 import org.apache.jackrabbit.api.security.user.User
@@ -40,10 +38,16 @@ import java.lang.reflect.ReflectPermission
  * trees, and can not be written directly by a client.
  */
 @CompileStatic
-@InheritConstructors
 @Slf4j
 class AuthorizableProtoNodeDecorator extends ProtoNodeDecorator {
 
+
+    protected AuthorizableProtoNodeDecorator(@Nonnull ProtoNode node, @Nonnull Collection<ProtoPropertyDecorator> protoProperties) {
+        this.innerProtoNode = node
+        this.protoProperties = protoProperties
+    }
+
+
     @Override
     JcrNodeDecorator writeToJcr(@Nonnull Session session) {
         if(!checkSecurityPermissions()) {
@@ -61,13 +65,14 @@ class AuthorizableProtoNodeDecorator extends ProtoNodeDecorator {
         return new JcrNodeDecorator(session.getNode(authorizable.getPath()))
     }
 
+
     /**
      * @return a new authorizable from this serialized node
      */
     private Authorizable createNewAuthorizable(final Session session) {
-        final UserManager userManager = AccessControlUtil.getUserManager(session)
+        final UserManager userManager = getUserManager(session)
         if(isUserType()) {
-            //When set a temporary password for now, and then set the real password later in setPasswordForUser(). See the method for why.
+            //We set a temporary password for now, and then set the real password later in setPasswordForUser(). See the method for why.
             final newUser = userManager.createUser(authorizableID, 'temp', new AuthorizablePrincipal(authorizableID), getIntermediateAuthorizablePath())
             //This is a special protected property for disabling user access
             if(hasProperty('rep:disabled')) {
@@ -84,6 +89,7 @@ class AuthorizableProtoNodeDecorator extends ProtoNodeDecorator {
         return userManager.createGroup(authorizableID, new AuthorizablePrincipal(authorizableID), getIntermediateAuthorizablePath())
     }
 
+
     /**
      * From a client API perspective, there is really no way to truely update an existing authorizable node. All of the properties are protected, and there is no
      * known way to update them. What we do here is essentially remove the existing authorizable as denoted by the authorizableID, and recreate it.
@@ -96,7 +102,7 @@ class AuthorizableProtoNodeDecorator extends ProtoNodeDecorator {
 
 
     private Authorizable findAuthorizable(final Session session) {
-        final UserManager userManager = AccessControlUtil.getUserManager(session)
+        final UserManager userManager = getUserManager(session)
         return userManager.getAuthorizable(getAuthorizableID())
     }
 
@@ -107,7 +113,10 @@ class AuthorizableProtoNodeDecorator extends ProtoNodeDecorator {
 
 
     private String getIntermediateAuthorizablePath() {
-        return getName() - "/${getName().tokenize('/').last()}"
+        final pathTokens = getName().tokenize('/')
+        //remove last index, as this is the Authorizable node name
+        pathTokens.remove(pathTokens.size() - 1)
+        return "/${pathTokens.join('/')}"
     }
 
 
@@ -122,7 +131,7 @@ class AuthorizableProtoNodeDecorator extends ProtoNodeDecorator {
      * @return true if we can sync this Authorizable
      */
     private boolean checkSecurityPermissions() {
-        final SecurityManager securityManager = System.getSecurityManager()
+        final SecurityManager securityManager = getSecurityManager()
         //If no security manager is present, then we are in the clear; otherwise, we need to check certain permissions
         if(!securityManager){
             log.debug "No SecurityManager found on this JVM. Sync of Users/Groups can continue"
@@ -166,6 +175,18 @@ class AuthorizableProtoNodeDecorator extends ProtoNodeDecorator {
         }
     }
 
+    /**
+     * @return the system's security manager, or null if one is not present
+     */
+    SecurityManager getSecurityManager() {
+        return System.getSecurityManager()
+    }
+
+
+    UserManager getUserManager(final Session session) {
+        return AccessControlUtil.getUserManager(session)
+    }
+
 
     /**
      * Normally we would call org.apache.jackrabbit.oak.jcr.delegate.UserDelegator.changePassword(String password) to change a password (this is what is publicly available through the Jackrabbit API)
@@ -178,10 +199,10 @@ class AuthorizableProtoNodeDecorator extends ProtoNodeDecorator {
      *
      * @throws IllegalStateException if security permissions required to run this are not there. @{code checkSecurityPermissions()} should be called before calling this method
      **/
-    private void setPasswordForUser(final User user, final Session session) {
+     void setPasswordForUser(final User user, final Session session) {
         if(!checkSecurityPermissions()) throw new IllegalStateException("Security check failed for Grabbit. Can not set user passwords")
         //As a consumer we have access to org.apache.jackrabbit.oak.jcr.delegate.UserManagerDelegator below
-        final userManager = AccessControlUtil.getUserManager(session)
+        final userManager = getUserManager(session)
         Class userManagerDelegatorClass = userManager.getClass()
         //Reach into the class of this delegator, and grab the core Jackrabbit object we delegate to
         Field userManagerDelegateField = userManagerDelegatorClass.getDeclaredField('userManagerDelegate')

src/main/groovy/com/twcable/grabbit/jcr/DefaultProtoNodeDecorator.groovy

@@ -0,0 +1,95 @@
+/*
+ * Copyright 2015 Time Warner Cable, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.twcable.grabbit.jcr
+
+import com.twcable.grabbit.proto.NodeProtos.Node as ProtoNode
+import com.twcable.grabbit.proto.NodeProtos.Value as ProtoValue
+import groovy.transform.CompileStatic
+import groovy.util.logging.Slf4j
+import org.apache.jackrabbit.commons.JcrUtils
+
+import javax.annotation.Nonnull
+import javax.jcr.Node as JCRNode
+import javax.jcr.Session
+
+import static org.apache.jackrabbit.JcrConstants.JCR_MIXINTYPES
+import static org.apache.jackrabbit.JcrConstants.JCR_PRIMARYTYPE
+
+@CompileStatic
+@Slf4j
+class DefaultProtoNodeDecorator extends ProtoNodeDecorator {
+
+
+    protected DefaultProtoNodeDecorator(@Nonnull ProtoNode node, @Nonnull Collection<ProtoPropertyDecorator> protoProperties) {
+        this.innerProtoNode = node
+        this.protoProperties = protoProperties
+    }
+
+
+    @Override
+    JcrNodeDecorator writeToJcr(@Nonnull Session session) {
+        final jcrNode = getOrCreateNode(session)
+        //Write mixin types first to avoid InvalidConstraintExceptions
+        final mixinProperty = getMixinProperty()
+        if(mixinProperty) {
+            addMixins(mixinProperty, jcrNode)
+        }
+        //Then add other properties
+        writableProperties.each { it.writeToNode(jcrNode) }
+
+        return new JcrNodeDecorator(jcrNode)
+    }
+
+
+    private ProtoPropertyDecorator getMixinProperty() {
+        protoProperties.find { it.isMixinType() }
+    }
+
+
+    private Collection<ProtoPropertyDecorator> getWritableProperties() {
+        protoProperties.findAll { !(it.name in [JCR_PRIMARYTYPE, JCR_MIXINTYPES]) }
+    }
+
+
+    /**
+     * This method is rather succinct, but helps isolate this JcrUtils static method call
+     * so that we can get better test coverage.
+     * @param session to create or get the node path for
+     * @return the newly created, or found node
+     */
+    JCRNode getOrCreateNode(Session session) {
+        JcrUtils.getOrCreateByPath(innerProtoNode.name, primaryType.getStringValue(), session)
+    }
+
+
+    /**
+     * If a property can be added as a mixin, adds it to the given node
+     * @param property
+     * @param node
+     */
+    private static void addMixins(ProtoPropertyDecorator property, JCRNode node) {
+        property.valuesList.each { ProtoValue value ->
+            if (node.canAddMixin(value.stringValue)) {
+                node.addMixin(value.stringValue)
+                log.debug "Added mixin ${value.stringValue} for : ${node.name}."
+            }
+            else {
+                log.warn "Encountered invalid mixin type while unmarshalling for Proto value : ${value}"
+            }
+        }
+    }
+
+}

src/main/groovy/com/twcable/grabbit/jcr/JCRNodeDecorator.groovy

@@ -146,7 +146,7 @@ class JcrNodeDecorator {
         if (hasProperty(JCR_LASTMODIFIED)) {
             return getProperty(JCR_LASTMODIFIED).date.time
         }
-        else if (hasProperty("cq:lastModified")) {
+        else if (hasProperty(CQ_LAST_MODIFIED)) {
             return getProperty(CQ_LAST_MODIFIED).date.time
         }
         else if (hasProperty(JCR_CREATED)) {

src/main/groovy/com/twcable/grabbit/jcr/ProtoNodeDecorator.groovy

@@ -1,3 +1,11 @@
+package com.twcable.grabbit.jcr
+
+import com.twcable.grabbit.proto.NodeProtos.Node as ProtoNode
+import groovy.transform.CompileStatic
+
+import javax.annotation.Nonnull
+import javax.jcr.Session
+
 /*
  * Copyright 2015 Time Warner Cable, Inc.
  *
@@ -13,113 +21,38 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.twcable.grabbit.jcr
-
-import com.twcable.grabbit.client.jcr.AuthorizableProtoNodeDecorator
-import com.twcable.grabbit.proto.NodeProtos.Node as ProtoNode
-import com.twcable.grabbit.proto.NodeProtos.Value as ProtoValue
-import groovy.transform.CompileStatic
-import groovy.util.logging.Slf4j
-import org.apache.jackrabbit.commons.JcrUtils
-
-import javax.annotation.Nonnull
-import javax.jcr.Node as JCRNode
-import javax.jcr.Session
-
-import static org.apache.jackrabbit.JcrConstants.JCR_MIXINTYPES
-import static org.apache.jackrabbit.JcrConstants.JCR_PRIMARYTYPE
 
 @CompileStatic
-@Slf4j
-class ProtoNodeDecorator {
+abstract class ProtoNodeDecorator {
 
     @Delegate
-    ProtoNode innerProtoNode
+    protected ProtoNode innerProtoNode
 
-    Collection<ProtoPropertyDecorator> protoProperties
+    protected Collection<ProtoPropertyDecorator> protoProperties
 
+    abstract JcrNodeDecorator writeToJcr(@Nonnull Session session)
 
     static ProtoNodeDecorator createFrom(@Nonnull ProtoNode node) {
         if(!node) throw new IllegalArgumentException("node must not be null!")
         final protoProperties = node.propertiesList.collect { new ProtoPropertyDecorator(it) }
-        if(protoProperties.any { it.userType || it.groupType }) {
+        final primaryType = protoProperties.find { it.primaryType }
+        if(primaryType.isUserType() || primaryType.isGroupType()) {
             return new AuthorizableProtoNodeDecorator(node, protoProperties)
         }
-        return new ProtoNodeDecorator(node, protoProperties)
+        return new DefaultProtoNodeDecorator(node, protoProperties)
     }
 
-
-    protected ProtoNodeDecorator(@Nonnull ProtoNode node, @Nonnull Collection<ProtoPropertyDecorator> protoProperties) {
-        this.innerProtoNode = node
-        this.protoProperties = protoProperties
-    }
-
-
     boolean hasProperty(String propertyName) {
         propertiesList.any{ it.name == propertyName }
     }
 
 
-    protected String getStringValueFrom(String propertyName) {
-        protoProperties.find { it.name == propertyName }.stringValue
+    protected ProtoPropertyDecorator getPrimaryType() {
+        protoProperties.find { it.isPrimaryType() }
     }
 
 
-    private String getPrimaryType() {
-        protoProperties.find { it.isPrimaryType() }.stringValue
-    }
-
-
-    private ProtoPropertyDecorator getMixinProperty() {
-        protoProperties.find { it.isMixinType() }
-    }
-
-
-    private Collection<ProtoPropertyDecorator> getWritableProperties() {
-        protoProperties.findAll { !(it.name in [JCR_PRIMARYTYPE, JCR_MIXINTYPES]) }
-    }
-
-
-    JcrNodeDecorator writeToJcr(@Nonnull Session session) {
-        final jcrNode = getOrCreateNode(session)
-        //Write mixin types first to avoid InvalidConstraintExceptions
-        final mixinProperty = getMixinProperty()
-        if(mixinProperty) {
-            addMixins(mixinProperty, jcrNode)
-        }
-        //Then add other properties
-        writableProperties.each { it.writeToNode(jcrNode) }
-
-        return new JcrNodeDecorator(jcrNode)
-    }
-
-
-    /**
-     * This method is rather succinct, but helps isolate this JcrUtils static method call
-     * so that we can get better test coverage.
-     * @param session to create or get the node path for
-     * @return the newly created, or found node
-     */
-    private JCRNode getOrCreateNode(Session session) {
-        JcrUtils.getOrCreateByPath(innerProtoNode.name, primaryType, session)
-    }
-
-
-    /**
-     * If a property can be added as a mixin, adds it to the given node
-     * @param property
-     * @param node
-     */
-    private static void addMixins(ProtoPropertyDecorator property, JCRNode node) {
-        property.valuesList.each { ProtoValue value ->
-            if (node.canAddMixin(value.stringValue)) {
-                node.addMixin(value.stringValue)
-                log.debug "Added mixin ${value.stringValue} for : ${node.name}."
-            }
-            else {
-                log.warn "Encountered invalid mixin type while unmarshalling for Proto value : ${value}"
-            }
-        }
+    protected String getStringValueFrom(String propertyName) {
+        protoProperties.find { it.name == propertyName }.stringValue
     }
-
 }

src/main/groovy/com/twcable/grabbit/jcr/ProtoPropertyDecorator.groovy

@@ -85,12 +85,12 @@ class ProtoPropertyDecorator {
 
 
     boolean isUserType() {
-        innerProtoProperty.name == 'rep:User'
+        getStringValue() == 'rep:User'
     }
 
 
     boolean isGroupType() {
-        innerProtoProperty.name == 'rep:Group'
+        getStringValue() == 'rep:Group'
     }