Merged HEAD (5.1) to 5.1.N (5.1.1)

117474 bhorje: CM-690 virtualization


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.1.N/root@117559 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/repo/virtual/ref/VanillaProtocol.java

@@ -0,0 +1,109 @@
+/* 
+ * 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.ref;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+import org.alfresco.service.cmr.repository.NodeRef;
+
+/**
+ * A {@link VirtualProtocol} extension that uses a scripted processor virtual
+ * template in order to process a so-called vanilla JSON static template
+ * definition on template execution.<br>
+ * Vanilla references store have an extra {@link ResourceParameter} for the
+ * vanilla-JSON template.
+ * 
+ * @author Bogdan Horje
+ */
+public class VanillaProtocol extends VirtualProtocol
+{
+    /**
+     * 
+     */
+    private static final long serialVersionUID = -7192024582935232081L;
+
+    public static final int VANILLA_TEMPLATE_PARAM_INDEX = 2;
+
+    public VanillaProtocol()
+    {
+        super("vanilla");
+    }
+
+    @Override
+    public <R> R dispatch(ProtocolMethod<R> method, Reference reference) throws ProtocolMethodException
+    {
+        return method.execute(this,
+                              reference);
+    }
+
+    public Reference newReference(String vanillaProcessorClasspath, String templatePath, NodeRef actualNodeRef,
+                NodeRef templateRef)
+    {
+        return this
+                    .newReference(new ClasspathResource(vanillaProcessorClasspath),
+                                  templatePath,
+                                  actualNodeRef,
+                                  Arrays
+                                              .<Parameter> asList(new ResourceParameter(new RepositoryResource(new RepositoryNodeRef(templateRef)))));
+    }
+
+    public Reference newReference(Encoding encoding, Resource virtualTemplateResource, String templatePath,
+                Resource actualResource, Resource vanillTemplateResource, List<Parameter> extraParameters)
+    {
+        List<Parameter> parameters = new ArrayList<>(2);
+        parameters.add(new ResourceParameter(vanillTemplateResource));
+        parameters.addAll(extraParameters);
+        return this.newReference(encoding,
+                                 virtualTemplateResource,
+                                 templatePath,
+                                 actualResource,
+                                 parameters);
+    }
+
+    public Resource getVanillaTemplateResource(Reference reference)
+    {
+        ResourceParameter vanillaTemplateParamter = (ResourceParameter) reference
+                    .getParameters()
+                        .get(VANILLA_TEMPLATE_PARAM_INDEX);
+        Resource resource = vanillaTemplateParamter.getValue();
+
+        return resource;
+    }
+
+    public Reference newReference(String vanillaProcessorClasspath, String templatePath, NodeRef actualNodeRef,
+                String templateSysPath) throws ProtocolMethodException
+    {
+        Resource templateResource = createSystemPathResource(templateSysPath);
+
+        if (templateResource != null)
+        {
+            return this.newReference(new ClasspathResource(vanillaProcessorClasspath),
+                                     templatePath,
+                                     actualNodeRef,
+                                     Arrays.<Parameter> asList(new ResourceParameter(templateResource)));
+        }
+        else
+        {
+            throw new ProtocolMethodException("Invalid template system path : " + templatePath);
+        }
+    }
+}