Merged 5.2.N (5.2.1) to HEAD (5.2)

129716 amorarasu: REPO-340 / REPO-1136 - V1 REST API: Unlock Node


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@130220 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/rest/api/Nodes.java

@@ -36,6 +36,7 @@ import org.alfresco.rest.api.model.Document;
 import org.alfresco.rest.api.model.Folder;
 import org.alfresco.rest.api.model.LockInfo;
 import org.alfresco.rest.api.model.Node;
+import org.alfresco.rest.api.model.UnlockInfo;
 import org.alfresco.rest.api.model.UserInfo;
 import org.alfresco.rest.framework.resource.content.BasicContentInfo;
 import org.alfresco.rest.framework.resource.content.BinaryResource;
@@ -254,6 +255,15 @@ public interface Nodes
      * @return
      */
     Node lock(String nodeId, LockInfo lockInfo, Parameters parameters);
+    
+    /**
+     * Unlock a node
+     * @param nodeId
+     * @param unlockInfo
+     * @param parameters
+     * @return
+     */
+    Node unlock(String nodeId, UnlockInfo unlockInfo, Parameters parameters);
 
     /**
      * API Constants - query parameters, etc

source/java/org/alfresco/rest/api/impl/NodesImpl.java

@@ -87,6 +87,7 @@ import org.alfresco.rest.api.model.Node;
 import org.alfresco.rest.api.model.PathInfo;
 import org.alfresco.rest.api.model.PathInfo.ElementInfo;
 import org.alfresco.rest.api.model.QuickShareLink;
+import org.alfresco.rest.api.model.UnlockInfo;
 import org.alfresco.rest.api.model.UserInfo;
 import org.alfresco.rest.api.nodes.NodeAssocService;
 import org.alfresco.rest.framework.core.exceptions.ApiException;
@@ -2970,6 +2971,40 @@ public class NodesImpl implements Nodes
         return lockInfo;
     }
 
+    @Override
+    public Node unlock(String nodeId, UnlockInfo unlockInfo, Parameters parameters)
+    {
+        NodeRef nodeRef = validateOrLookupNode(nodeId, null);
+
+        if (isSpecialNode(nodeRef, getNodeType(nodeRef)))
+        {
+            throw new PermissionDeniedException("Current user doesn't have permission to unlock node " + nodeId);
+        }
+
+        if (unlockInfo.getIncludeChildren() == null)
+        {
+            unlockInfo.setIncludeChildren(false);
+        }
+        if (unlockInfo.getAllowCheckedOut() == null)
+        {
+            unlockInfo.setAllowCheckedOut(false);
+        }
+        
+        // If there is no lock placed on the node skip the operation.
+        if (lockService.getLockStatus(nodeRef) != LockStatus.NO_LOCK)
+        {
+            if (permissionService.hasPermission(nodeRef, PermissionService.UNLOCK).equals(AccessStatus.ALLOWED))
+            {
+                lockService.unlock(nodeRef, unlockInfo.getIncludeChildren(), unlockInfo.getAllowCheckedOut());
+            }
+            else
+            {
+                throw new PermissionDeniedException("Current user doesn't have permission to unlock node " + nodeId);
+            }
+        }
+        return getFolderOrDocument(nodeId, parameters);
+    }
+
     /**
      * @author Jamal Kaabi-Mofrad
      */

source/java/org/alfresco/rest/api/model/UnlockInfo.java

@@ -0,0 +1,60 @@
+/*
+ * #%L
+ * Alfresco Remote API
+ * %%
+ * Copyright (C) 2005 - 2016 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software. 
+ * If the software was purchased under a paid Alfresco license, the terms of 
+ * the paid license agreement will prevail.  Otherwise, the software is 
+ * provided under the following open source license terms:
+ * 
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.rest.api.model;
+
+/**
+ * Representation of a unlock info
+ *
+ * @author Ancuta Morarasu
+ */
+
+public class UnlockInfo
+{
+    private Boolean includeChildren;
+    private Boolean allowCheckedOut;
+    
+    public UnlockInfo() {}
+
+    public Boolean getIncludeChildren()
+    {
+        return includeChildren;
+    }
+
+    public void setIncludeChildren(Boolean includeChildren)
+    {
+        this.includeChildren = includeChildren;
+    }
+
+    public Boolean getAllowCheckedOut()
+    {
+        return allowCheckedOut;
+    }
+
+    public void setAllowCheckedOut(Boolean allowCheckedOut)
+    {
+        this.allowCheckedOut = allowCheckedOut;
+    }
+}

source/java/org/alfresco/rest/api/nodes/NodesEntityResource.java

@@ -33,6 +33,7 @@ import org.alfresco.rest.api.Nodes;
 import org.alfresco.rest.api.model.LockInfo;
 import org.alfresco.rest.api.model.Node;
 import org.alfresco.rest.api.model.NodeTarget;
+import org.alfresco.rest.api.model.UnlockInfo;
 import org.alfresco.rest.framework.BinaryProperties;
 import org.alfresco.rest.framework.Operation;
 import org.alfresco.rest.framework.WebApiDescription;
@@ -179,6 +180,15 @@ public class NodesEntityResource implements
     {
         return nodes.lock(nodeId, lockInfo, parameters);
     }
+    
+    @Operation("unlock")
+    @WebApiDescription(title = "Unlock Node",
+            description="Removes a lock on a node.",
+            successStatus = HttpServletResponse.SC_OK)
+    public Node unlock(String nodeId, UnlockInfo unlockInfo, Parameters parameters, WithResponse withResponse)
+    {
+        return nodes.unlock(nodeId, unlockInfo, parameters);
+    }
 
 }