use Templates for compiled XSLT instead of Transformer - use Template…

…s are thread-safe and NOT Transformer
DSpace · Aug 29, 2023 · 0ac1a88 · 0ac1a88
1 parent 2cd74f7
commit 0ac1a88
Show file tree

Hide file tree

Showing 15 changed files with 68 additions and 48 deletions.
diff --git a/src/main/java/com/lyncode/xoai/dataprovider/data/internal/MetadataFormat.java b/src/main/java/com/lyncode/xoai/dataprovider/data/internal/MetadataFormat.java
@@ -19,6 +19,7 @@
 import com.lyncode.xoai.dataprovider.data.ItemIdentifier;
 import com.lyncode.xoai.dataprovider.filter.conditions.Condition;
 
+import javax.xml.transform.Templates;
 import javax.xml.transform.Transformer;
 
 /**
@@ -27,14 +28,14 @@
  */
 public class MetadataFormat {
     private String prefix;
-    private Transformer xsltTransformer;
+    private Templates xsltTemplates;
     private String namespace;
     private String schemaLocation;
     private Condition filter;
 
-    public MetadataFormat(String prefix, Transformer transformer, String namespace, String schemaLocation) {
+    public MetadataFormat(String prefix, Templates xsltTemplates, String namespace, String schemaLocation) {
         this.prefix = prefix;
-        this.xsltTransformer = transformer;
+        this.xsltTemplates = xsltTemplates;
         this.namespace = namespace;
         this.schemaLocation = schemaLocation;
     }
@@ -43,8 +44,8 @@ public String getPrefix() {
         return prefix;
     }
 
-    public Transformer getTransformer() {
-        return xsltTransformer;
+    public Templates getXsltTemplates() {
+        return xsltTemplates;
     }
 
     public String getNamespace() {

diff --git a/src/main/java/com/lyncode/xoai/dataprovider/data/internal/MetadataTransformer.java b/src/main/java/com/lyncode/xoai/dataprovider/data/internal/MetadataTransformer.java
@@ -16,28 +16,28 @@
 
 package com.lyncode.xoai.dataprovider.data.internal;
 
-import com.lyncode.xoai.dataprovider.transform.XSLTransformer;
+import com.lyncode.xoai.dataprovider.transform.XSLTemplates;
 
 /**
 
  * @version 3.1.0
  */
 public class MetadataTransformer {
-    private XSLTransformer xslTransformer;
+    private XSLTemplates xslTemplates;
 
     public MetadataTransformer() {
-        xslTransformer = null;
+        xslTemplates = null;
     }
 
-    public MetadataTransformer(XSLTransformer xsltTransformer) {
-        this.xslTransformer = xsltTransformer;
+    public MetadataTransformer(XSLTemplates xslTemplates) {
+        this.xslTemplates = xslTemplates;
     }
 
-    public boolean hasTransformer() {
-        return (this.xslTransformer != null);
+    public boolean hasXslTemplates() {
+        return (this.xslTemplates != null);
     }
 
-    public XSLTransformer getXslTransformer() {
-        return this.xslTransformer;
+    public XSLTemplates getXslTemplates() {
+        return this.xslTemplates;
     }
 }
diff --git a/src/main/java/com/lyncode/xoai/dataprovider/format/MetadataFormatManager.java b/src/main/java/com/lyncode/xoai/dataprovider/format/MetadataFormatManager.java
@@ -26,6 +26,7 @@
 import org.apache.log4j.LogManager;
 import org.apache.log4j.Logger;
 
+import javax.xml.transform.Templates;
 import javax.xml.transform.Transformer;
 import javax.xml.transform.TransformerConfigurationException;
 import java.io.IOException;
@@ -48,17 +49,17 @@ public MetadataFormatManager(ResourceResolver resolver, List<FormatConfiguration
                                  FilterManager filterManager) throws ConfigurationException {
         contexts = new HashMap<String, MetadataFormat>();
         for (FormatConfiguration format : config) {
-            Transformer transformer = null;
+            Templates templates = null;
 
             try {
-                transformer = resolver.getTransformer(format.getXslt());
+                templates = resolver.getTemplates(format.getXslt());
             } catch (TransformerConfigurationException e) {
                 throw new ConfigurationException(e.getMessage(), e);
             } catch (IOException e) {
                 throw new ConfigurationException(e.getMessage(), e);
             }
 
-            MetadataFormat metadataFormat = new MetadataFormat(format.getPrefix(), transformer, format.getNamespace(), format.getSchemaLocation());
+            MetadataFormat metadataFormat = new MetadataFormat(format.getPrefix(), templates, format.getNamespace(), format.getSchemaLocation());
             if (format.hasFilter())
                 metadataFormat.setFilter(filterManager.getFilter(format.getFilter().getReference()));
             contexts.put(format.getId(), metadataFormat);

diff --git a/src/main/java/com/lyncode/xoai/dataprovider/handlers/GetRecordHandler.java b/src/main/java/com/lyncode/xoai/dataprovider/handlers/GetRecordHandler.java
@@ -54,14 +54,14 @@ public GetRecordType handle(OAIParameters parameters) throws OAIException, Handl
         if (!itemHelper.getItem().isDeleted()) {
             MetadataType metadata = null;
             try {
-                if (context.getTransformer().hasTransformer()) {
+                if (context.getTransformer().hasXslTemplates()) {
                     metadata = new MetadataType(itemHelper.toPipeline(true)
-                            .apply(context.getTransformer().getXslTransformer().getValue())
-                            .apply(format.getTransformer())
+                            .apply(context.getTransformer().getXslTemplates().getValue())
+                            .apply(format.getXsltTemplates())
                             .getTransformed());
                 } else {
                     metadata = new MetadataType(itemHelper.toPipeline(true)
-                            .apply(format.getTransformer())
+                            .apply(format.getXsltTemplates())
                             .getTransformed());
                 }
             } catch (WritingXmlException e) {

diff --git a/src/main/java/com/lyncode/xoai/dataprovider/handlers/ListRecordsHandler.java b/src/main/java/com/lyncode/xoai/dataprovider/handlers/ListRecordsHandler.java
@@ -150,14 +150,14 @@ private RecordType createRecord(OAIParameters parameters, Item item)
         if (!item.isDeleted()) {
             MetadataType metadata = null;
             try {
-                if (context.getTransformer().hasTransformer()) {
+                if (context.getTransformer().hasXslTemplates()) {
                     metadata = new MetadataType(itemHelperWrap.toPipeline(true)
-                            .apply(context.getTransformer().getXslTransformer().getValue())
-                            .apply(format.getTransformer())
+                            .apply(context.getTransformer().getXslTemplates().getValue())
+                            .apply(format.getXsltTemplates())
                             .getTransformed());
                 } else {
                     metadata = new MetadataType(itemHelperWrap.toPipeline(true)
-                            .apply(format.getTransformer())
+                            .apply(format.getXsltTemplates())
                             .getTransformed());
                 }
             } catch (WritingXmlException e) {

diff --git a/src/main/java/com/lyncode/xoai/dataprovider/services/api/ResourceResolver.java b/src/main/java/com/lyncode/xoai/dataprovider/services/api/ResourceResolver.java
@@ -1,11 +1,13 @@
 package com.lyncode.xoai.dataprovider.services.api;
 
+import javax.xml.transform.Templates;
 import javax.xml.transform.Transformer;
 import javax.xml.transform.TransformerConfigurationException;
 import java.io.IOException;
 import java.io.InputStream;
 
 public interface ResourceResolver {
     InputStream getResource(String path) throws IOException;
-    Transformer getTransformer (String path) throws IOException, TransformerConfigurationException;
+
+    Templates getTemplates(String path) throws IOException, TransformerConfigurationException;
 }
diff --git a/src/main/java/com/lyncode/xoai/dataprovider/services/impl/FileResourceResolver.java b/src/main/java/com/lyncode/xoai/dataprovider/services/impl/FileResourceResolver.java
@@ -2,6 +2,7 @@
 
 import com.lyncode.xoai.dataprovider.services.api.ResourceResolver;
 
+import javax.xml.transform.Templates;
 import javax.xml.transform.Transformer;
 import javax.xml.transform.TransformerConfigurationException;
 import javax.xml.transform.TransformerFactory;
@@ -24,8 +25,9 @@ public InputStream getResource(String path) throws IOException {
         return new FileInputStream(new File(basePath, path));
     }
 
+
     @Override
-    public Transformer getTransformer(String path) throws IOException, TransformerConfigurationException {
-        return tFactory.newTransformer(new StreamSource(getResource(path)));
+    public Templates getTemplates(String path) throws IOException, TransformerConfigurationException {
+        return tFactory.newTemplates(new StreamSource(getResource(path)));
     }
 }
diff --git a/src/main/java/com/lyncode/xoai/dataprovider/transform/TransformManager.java b/src/main/java/com/lyncode/xoai/dataprovider/transform/TransformManager.java
@@ -42,8 +42,8 @@ public TransformManager(ResourceResolver resolver, List<TransformerConfiguration
             for (TransformerConfiguration t : transformerConfigurations) {
                 try {
                     _contexts.put(t.getId(),
-                            new MetadataTransformer(new XSLTransformer(
-                                    resolver.getTransformer(t.getXslt())
+                            new MetadataTransformer(new XSLTemplates(
+                                    resolver.getTemplates(t.getXslt())
                             ))
                     );
                 } catch (TransformerConfigurationException e) {

diff --git a/src/main/java/com/lyncode/xoai/dataprovider/transform/XSLTemplates.java b/src/main/java/com/lyncode/xoai/dataprovider/transform/XSLTemplates.java
@@ -0,0 +1,11 @@
+package com.lyncode.xoai.dataprovider.transform;
+
+import com.lyncode.xoai.util.TinyType;
+
+import javax.xml.transform.Templates;
+
+public class XSLTemplates extends TinyType<Templates> {
+    public XSLTemplates(Templates templates) {
+        super(templates);
+    }
+}
diff --git a/src/main/java/com/lyncode/xoai/dataprovider/transform/XSLTransformer.java b/src/main/java/com/lyncode/xoai/dataprovider/transform/XSLTransformer.java
diff --git a/src/main/java/com/lyncode/xoai/util/XSLPipeline.java b/src/main/java/com/lyncode/xoai/util/XSLPipeline.java
@@ -1,6 +1,7 @@
 package com.lyncode.xoai.util;
 
 import javax.xml.transform.OutputKeys;
+import javax.xml.transform.Templates;
 import javax.xml.transform.Transformer;
 import javax.xml.transform.TransformerException;
 import javax.xml.transform.stream.StreamResult;
@@ -19,8 +20,9 @@ public XSLPipeline(InputStream inputStream, boolean omitXMLDeclaration) {
         this.omitXMLDeclaration = omitXMLDeclaration;
     }
 
-    public XSLPipeline apply(Transformer xslTransformer) throws TransformerException {
+    public XSLPipeline apply(Templates xslTemplates) throws TransformerException {
         outputStream = new ByteArrayOutputStream();
+        Transformer xslTransformer = xslTemplates.newTransformer();
         xslTransformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, (omitXMLDeclaration) ? "yes" : "no");
         xslTransformer.transform(new StreamSource(inputStream), new StreamResult(outputStream));
         inputStream = new ByteArrayInputStream(outputStream.toByteArray());

diff --git a/src/test/java/com/lyncode/xoai/tests/dataprovider/acceptance/AbstractDataProviderTest.java b/src/test/java/com/lyncode/xoai/tests/dataprovider/acceptance/AbstractDataProviderTest.java
@@ -35,6 +35,7 @@
 import javax.xml.stream.XMLStreamException;
 import javax.xml.transform.TransformerConfigurationException;
 import javax.xml.transform.TransformerFactory;
+import javax.xml.transform.stream.StreamSource;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.text.ParseException;
@@ -70,7 +71,9 @@ public abstract class AbstractDataProviderTest {
 
     @Before
     public void setUp() throws IOException, TransformerConfigurationException, ParseException {
-        when(resourceResolver.getTransformer(XOAI_XSLT_LOCATION)).thenReturn(tFactory.newTransformer());
+        when(resourceResolver.getTemplates(XOAI_XSLT_LOCATION)).
+                thenReturn(tFactory.newTemplates(new StreamSource(
+                        this.getClass().getClassLoader().getResourceAsStream("identity_transform.xsl"))));
 
         configuration = new Configuration().withIndented(true);
 

diff --git a/src/test/java/com/lyncode/xoai/tests/dataprovider/unit/XmlTest.java b/src/test/java/com/lyncode/xoai/tests/dataprovider/unit/XmlTest.java
@@ -7,9 +7,10 @@
 
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamWriter;
-import javax.xml.transform.Transformer;
+import javax.xml.transform.Templates;
 import javax.xml.transform.TransformerConfigurationException;
 import javax.xml.transform.TransformerFactory;
+import javax.xml.transform.stream.StreamSource;
 import java.io.ByteArrayOutputStream;
 
 public abstract class XmlTest {
@@ -27,9 +28,10 @@ protected String theOutput() {
         return output.toString();
     }
 
-    protected Transformer identityTransformer() {
+    protected Templates identityTemplate() {
         try {
-            return tFactory.newTransformer();
+            return tFactory.newTemplates(new StreamSource(
+                    this.getClass().getClassLoader().getResourceAsStream("identity_transform.xsl")));
         } catch (TransformerConfigurationException e) {
             throw new RuntimeException(e.getMessage(), e);
         }

diff --git a/src/test/java/com/lyncode/xoai/tests/util/XSLPipelineTest.java b/src/test/java/com/lyncode/xoai/tests/util/XSLPipelineTest.java
@@ -30,14 +30,14 @@ public void shouldGiveTheSameIfNoTransformationIsApplied() throws IOException {
     @Test
     public void shouldTransformWithXmlDeclarationOnTop() throws TransformerException, IOException {
         XSLPipeline underTest = new XSLPipeline(input, false);
-        underTest.apply(identityTransformer());
+        underTest.apply(identityTemplate());
         assertThat(IOUtils.toString(underTest.getTransformed()), containsString("<?xml"));
     }
 
     @Test
     public void shouldTransformWithoutXmlDeclarationOnTop() throws TransformerException, IOException {
         XSLPipeline underTest = new XSLPipeline(input, true);
-        underTest.apply(identityTransformer());
+        underTest.apply(identityTemplate());
         assertThat(IOUtils.toString(underTest.getTransformed()), not(containsString("<?xml")));
     }
 }
diff --git a/src/test/resources/identity_transform.xsl b/src/test/resources/identity_transform.xsl
@@ -0,0 +1,7 @@
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+    <xsl:template match="@*|node()">
+        <xsl:copy>
+            <xsl:apply-templates select="@*|node()"/>
+        </xsl:copy>
+    </xsl:template>
+</xsl:stylesheet>