CM-690 virtualization

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@117474 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-10-08 14:51:49 +00:00 · 2015-11-12 19:08:08 +00:00
parent c0f5336745
commit 4ed133e259
130 changed files with 17687 additions and 0 deletions
--- a/source/java/org/alfresco/repo/virtual/template/ApplyTemplateMethod.java
+++ b/source/java/org/alfresco/repo/virtual/template/ApplyTemplateMethod.java
@@ -0,0 +1,146 @@
+/* 
+ * Copyright (C) 2005-2015 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * 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/.
+ */
+
+package org.alfresco.repo.virtual.template;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+
+import org.alfresco.repo.virtual.ActualEnvironment;
+import org.alfresco.repo.virtual.VirtualContext;
+import org.alfresco.repo.virtual.ref.AbstractProtocolMethod;
+import org.alfresco.repo.virtual.ref.GetActualNodeRefMethod;
+import org.alfresco.repo.virtual.ref.GetTemplatePathMethod;
+import org.alfresco.repo.virtual.ref.GetVanillaScriptInputStreamMethod;
+import org.alfresco.repo.virtual.ref.NodeProtocol;
+import org.alfresco.repo.virtual.ref.ProtocolMethodException;
+import org.alfresco.repo.virtual.ref.Reference;
+import org.alfresco.repo.virtual.ref.Resource;
+import org.alfresco.repo.virtual.ref.ResourceProcessingError;
+import org.alfresco.repo.virtual.ref.VanillaProtocol;
+import org.alfresco.repo.virtual.ref.VirtualProtocol;
+import org.apache.commons.io.IOUtils;
+
+/**
+ * Creates a {@link VirtualFolderDefinition} by executing the template indicated
+ * by a virtualized entity reference.
+ * 
+ * @author Bogdan Horje
+ */
+public class ApplyTemplateMethod extends AbstractProtocolMethod<VirtualFolderDefinition>
+{
+    public static final String VANILLA_JSON_PARAM_NAME = "vanillaJSON";
+
+    private ActualEnvironment environment;
+
+    public ApplyTemplateMethod(ActualEnvironment environment)
+    {
+        super();
+        this.environment = environment;
+    }
+
+    public VirtualFolderDefinition execute(VirtualProtocol virtualProtocol, Reference reference)
+                throws ProtocolMethodException
+    {
+        VirtualContext context = createVirtualContext(reference);
+        return execute(virtualProtocol,
+                       reference,
+                       context);
+    }
+
+    private VirtualContext createVirtualContext(Reference reference) throws ProtocolMethodException
+    {
+        return new VirtualContext(environment,
+                                  reference.execute(new GetActualNodeRefMethod(environment)));
+    }
+
+    public VirtualFolderDefinition execute(VirtualProtocol virtualProtocol, Reference reference, VirtualContext context)
+                throws ProtocolMethodException
+    {
+        Resource resource = reference.getResource();
+
+        try
+        {
+            VirtualFolderDefinition theStructure = resource.processWith(new TemplateResourceProcessor(context));
+            String path = reference.execute(new GetTemplatePathMethod());
+
+            if (!path.isEmpty())
+            {
+                String[] pathElements = path.split(PATH_SEPARATOR);
+                int startIndex = path.startsWith(PATH_SEPARATOR) ? 1 : 0;
+                for (int i = startIndex; i < pathElements.length; i++)
+                {
+                    theStructure = theStructure.findChildById(pathElements[i]);
+                    if (theStructure == null)
+                    {
+
+                        throw new ProtocolMethodException("Invalid template path in " + reference.toString());
+
+                    }
+                }
+            }
+
+            return theStructure;
+        }
+        catch (ResourceProcessingError e)
+        {
+            throw new ProtocolMethodException(e);
+        }
+    }
+
+    @Override
+    public VirtualFolderDefinition execute(VanillaProtocol vanillaProtocol, Reference reference)
+                throws ProtocolMethodException
+    {
+        InputStream vanillaIS = reference.execute(new GetVanillaScriptInputStreamMethod(environment));
+        try
+        {
+            String vanillaJSON = IOUtils.toString(vanillaIS,
+                                                  StandardCharsets.UTF_8);
+            VirtualContext context = createVirtualContext(reference);
+            context.setParameter(VANILLA_JSON_PARAM_NAME,
+                                 vanillaJSON);
+            return execute(vanillaProtocol,
+                           reference,
+                           context);
+
+        }
+        catch (IOException e)
+        {
+            throw new ProtocolMethodException(e);
+        }
+    }
+
+    /**
+     * Creates an empty {@link VirtualFolderDefinition} parameterized with a
+     * {@link NullFilingRule} as this method is called for non-virtual nodes.
+     * 
+     * @param protocol 
+     * @param reference
+     * @return The empty {@link VirtualFolderDefinition}.
+     */
+    @Override
+    public VirtualFolderDefinition execute(NodeProtocol protocol, Reference reference) throws ProtocolMethodException
+    {
+        VirtualFolderDefinition virtualStructure = new VirtualFolderDefinition();
+        virtualStructure.setFilingRule(new NodeFilingRule(environment));
+        return virtualStructure;
+    }
+}