[MNT-24127] Added Endpoint To Calculate Folder Size

.secrets.baseline

@@ -731,7 +731,7 @@
         "filename": "remote-api/src/test/java/org/alfresco/rest/api/tests/AbstractBaseApiTest.java",
         "hashed_secret": "d033e22ae348aeb5660fc2140aec35850c4da997",
         "is_verified": false,
-        "line_number": 120,
+        "line_number": 111,
         "is_secret": false
       }
     ],
@@ -1888,5 +1888,5 @@
       }
     ]
   },
-  "generated_at": "2024-10-02T10:18:47Z"
-}
+  "generated_at": "2024-10-09T09:32:52Z"
+}

remote-api/src/main/java/org/alfresco/rest/api/SizeDetails.java

@@ -0,0 +1,36 @@
+/*
+ * #%L
+ * Alfresco Remote API
+ * %%
+ * Copyright (C) 2005 - 2024 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;
+
+import org.alfresco.repo.node.sizedetails.NodeSizeDetailsServiceImpl.NodeSizeDetails;
+
+public interface SizeDetails
+{
+    NodeSizeDetails generateNodeSizeDetailsRequest(String nodeId);
+
+    NodeSizeDetails getNodeSizeDetails(String nodeId, String jobId);
+
+}

remote-api/src/main/java/org/alfresco/rest/api/impl/SizeDetailsImpl.java

@@ -0,0 +1,119 @@
+/*
+ * #%L
+ * Alfresco Remote API
+ * %%
+ * Copyright (C) 2005 - 2024 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.impl;
+
+import java.util.Optional;
+
+import org.springframework.beans.factory.InitializingBean;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.repo.node.sizedetails.NodeSizeDetailsService;
+import org.alfresco.repo.node.sizedetails.NodeSizeDetailsServiceImpl.NodeSizeDetails;
+import org.alfresco.repo.node.sizedetails.NodeSizeDetailsServiceImpl.NodeSizeDetails.STATUS;
+import org.alfresco.rest.api.Nodes;
+import org.alfresco.rest.api.SizeDetails;
+import org.alfresco.rest.framework.core.exceptions.InvalidNodeTypeException;
+import org.alfresco.rest.framework.core.exceptions.NotFoundException;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.util.GUID;
+import org.alfresco.util.ParameterCheck;
+
+public class SizeDetailsImpl implements SizeDetails, InitializingBean
+{
+    private final Nodes nodes;
+    private final NodeSizeDetailsService nodeSizeDetailsService;
+
+    public SizeDetailsImpl(Nodes nodes, NodeSizeDetailsService nodeSizeDetailsService)
+    {
+        this.nodes = nodes;
+        this.nodeSizeDetailsService = nodeSizeDetailsService;
+    }
+
+    /**
+     * generateNodeSizeDetailsRequest : providing HTTP STATUS 202 with jobId.
+     */
+    @Override
+    public NodeSizeDetails generateNodeSizeDetailsRequest(String nodeId)
+    {
+        NodeRef nodeRef = nodes.validateOrLookupNode(nodeId);
+        validateType(nodeRef);
+
+        Optional<NodeSizeDetails> nodeSizeDetails = nodeSizeDetailsService.getSizeDetails(nodeId);
+        String actionId = nodeSizeDetails.map(NodeSizeDetails::getJobId)
+                .orElseGet(() -> executeSizeDetails(nodeRef));
+
+        return new NodeSizeDetails(actionId);
+    }
+
+    /**
+     * getNodeSizeDetails : providing HTTP STATUS 200 with NodeSizeDetails data from cache.
+     */
+    @Override
+    public NodeSizeDetails getNodeSizeDetails(final String nodeId, final String jobId)
+    {
+        NodeRef nodeRef = nodes.validateOrLookupNode(nodeId);
+        validateType(nodeRef);
+
+        Optional<NodeSizeDetails> optionalDetails = nodeSizeDetailsService.getSizeDetails(nodeId);
+        return optionalDetails.map(details -> {
+            String cachedJobId = details.getJobId();
+            if (cachedJobId != null && !jobId.equalsIgnoreCase(cachedJobId))
+            {
+                throw new NotFoundException("jobId does not exist");
+            }
+            return details;
+        })
+                .orElseGet(() -> new NodeSizeDetails(nodeId, STATUS.NOT_INITIATED));
+    }
+
+    /**
+     * Executing Asynchronously.
+     */
+    private String executeSizeDetails(NodeRef nodeRef)
+    {
+        String jobId = GUID.generate();
+        NodeSizeDetails nodeSizeDetails = new NodeSizeDetails(nodeRef.getId(), jobId, STATUS.PENDING);
+        nodeSizeDetailsService.putSizeDetails(nodeRef.getId(), nodeSizeDetails);
+        nodeSizeDetailsService.invokeSizeDetailsExecutor(nodeRef, jobId);
+        return jobId;
+    }
+
+    private void validateType(NodeRef nodeRef) throws InvalidNodeTypeException
+    {
+        if (!nodes.isSubClass(nodeRef, ContentModel.TYPE_FOLDER, false))
+        {
+            throw new InvalidNodeTypeException("Node id " + nodeRef.getId() + " does not represent a folder.");
+        }
+    }
+
+    @Override
+    public void afterPropertiesSet() throws Exception
+    {
+        ParameterCheck.mandatory("nodes", this.nodes);
+        ParameterCheck.mandatory("nodeSizeDetailsServiceImpl", this.nodeSizeDetailsService);
+    }
+
+}

remote-api/src/main/java/org/alfresco/rest/api/nodes/NodeSizeDetailsRelation.java

@@ -0,0 +1,84 @@
+/*
+ * #%L
+ * Alfresco Remote API
+ * %%
+ * Copyright (C) 2005 - 2024 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.nodes;
+
+import java.util.List;
+
+import org.springframework.beans.factory.InitializingBean;
+import org.springframework.extensions.webscripts.Status;
+
+import org.alfresco.repo.node.sizedetails.NodeSizeDetailsServiceImpl.NodeSizeDetails;
+import org.alfresco.rest.api.SizeDetails;
+import org.alfresco.rest.framework.WebApiDescription;
+import org.alfresco.rest.framework.WebApiParam;
+import org.alfresco.rest.framework.WebApiParameters;
+import org.alfresco.rest.framework.core.ResourceParameter;
+import org.alfresco.rest.framework.core.exceptions.RelationshipResourceNotFoundException;
+import org.alfresco.rest.framework.resource.RelationshipResource;
+import org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction;
+import org.alfresco.rest.framework.resource.parameters.Parameters;
+import org.alfresco.util.ParameterCheck;
+
+@RelationshipResource(name = "size-details", entityResource = NodesEntityResource.class, title = "Node Size Details")
+public class NodeSizeDetailsRelation implements RelationshipResourceAction.ReadById<NodeSizeDetails>,
+        RelationshipResourceAction.Create<NodeSizeDetails>, InitializingBean
+{
+
+    private SizeDetails sizeDetails;
+
+    public void setSizeDetails(SizeDetails sizeDetails)
+    {
+        this.sizeDetails = sizeDetails;
+    }
+
+    @Override
+    public void afterPropertiesSet()
+    {
+        ParameterCheck.mandatory("sizeDetails", this.sizeDetails);
+    }
+
+    @WebApiDescription(title = "Create node-size details request", successStatus = Status.STATUS_ACCEPTED)
+    @WebApiParam(name = "nodeSizeEntity", title = "Node Size Details Request",
+            description = "Request for processing Node Size.", kind = ResourceParameter.KIND.HTTP_BODY_OBJECT,
+            allowMultiple = false)
+    @Override
+    public List<NodeSizeDetails> create(String nodeId, List<NodeSizeDetails> nodeSizeEntity, Parameters parameters)
+    {
+        return List.of(sizeDetails.generateNodeSizeDetailsRequest(nodeId));
+    }
+
+    @WebApiDescription(title = "Get Node Size Details", description = "Get the Node Size Details")
+    @WebApiParameters({@WebApiParam(name = "nodeId", title = "The unique id of the Node being addressed",
+            description = "A single Node id"),
+            @WebApiParam(name = "jobId", title = "Job Id to get the NodeSizeDetails", description = "JobId")})
+    @Override
+    public NodeSizeDetails readById(String nodeId, String jobId, Parameters parameters)
+            throws RelationshipResourceNotFoundException
+    {
+        return sizeDetails.getNodeSizeDetails(nodeId, jobId);
+    }
+}

remote-api/src/main/resources/alfresco/public-rest-context.xml

@@ -996,6 +996,25 @@
         </property>
     </bean>
 
+    <bean id="sizeDetailsImpl" class="org.alfresco.rest.api.impl.SizeDetailsImpl">
+        <constructor-arg name="nodes" ref="nodes" />
+        <constructor-arg name="nodeSizeDetailsService" ref="NodeSizeDetailsService" />
+    </bean>
+
+    <bean id="sizeDetails" class="org.springframework.aop.framework.ProxyFactoryBean">
+        <property name="proxyInterfaces">
+            <value>org.alfresco.rest.api.SizeDetails</value>
+        </property>
+        <property name="target">
+            <ref bean="sizeDetailsImpl" />
+        </property>
+        <property name="interceptorNames">
+            <list>
+                <idref bean="legacyExceptionInterceptor" />
+            </list>
+        </property>
+    </bean>
+
     <bean class="org.alfresco.rest.api.rules.NodeRuleSettingsRelation">
         <property name="ruleSettings" ref="RuleSettings" />
     </bean>
@@ -1770,4 +1789,8 @@
             </list>
         </property>
     </bean>
+
+    <bean class="org.alfresco.rest.api.nodes.NodeSizeDetailsRelation">
+        <property name="sizeDetails" ref="sizeDetails" />
+    </bean>
 </beans>