DOM3LS_XMLUtils.java

  1. /*
  2.  * GovWay - A customizable API Gateway 
  3.  * https://govway.org
  4.  * 
  5.  * Copyright (c) 2005-2025 Link.it srl (https://link.it). 
  6.  * 
  7.  * This program is free software: you can redistribute it and/or modify
  8.  * it under the terms of the GNU General Public License version 3, as published by
  9.  * the Free Software Foundation.
  10.  *
  11.  * This program is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.  * GNU General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public License
  17.  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18.  *
  19.  */


  22. package org.openspcoop2.utils.xml;

  24. import java.io.ByteArrayOutputStream;
  25. import java.io.File;
  26. import java.io.FileNotFoundException;
  27. import java.io.FileOutputStream;
  28. import java.io.OutputStream;
  29. import java.io.StringWriter;
  30. import java.io.Writer;

  32. import org.w3c.dom.DOMConfiguration;
  33. import org.w3c.dom.DOMImplementation;
  34. import org.w3c.dom.Document;
  35. import org.w3c.dom.Element;
  36. import org.w3c.dom.Node;
  37. import org.w3c.dom.ls.DOMImplementationLS;
  38. import org.w3c.dom.ls.LSOutput;
  39. import org.w3c.dom.ls.LSSerializer;


  42. /**
  43.  * Classe utilizzabile per ottenere documenti xml
  44.  *
  45.  *
  46.  * @author Poli Andrea (apoli@link.it)
  47.  * @author $Author$
  48.  * @version $Rev$, $Date$
  49.  */

  51. public class DOM3LS_XMLUtils {

  53.     public static AbstractXMLUtils xmlUtils = XMLUtils.getInstance();
  54.     public static synchronized void setXMLUtils(AbstractXMLUtils xmlUtilsParam) {
  55.         DOM3LS_XMLUtils.xmlUtils = xmlUtilsParam;
  56.     }

  58.     
  59.     
  60.     // *********** prettyPrintWithDOM3LS **************
  61.     
  62.     /*
  63.      * DOM Level 3 Load and Save (LS) is the new API for pretty-printing XML.  
  64.      * Support for LS is included with JAXP 1.4 which is bundled as part of Sun’s JDK 1.5, 
  65.      * but unfortunately pretty-print formatting only works in JDK 1.6 or better.
  66.      */
  67.     
  68.     private static void _serialize(Document documentImplementation,Node n, Object out, boolean prettyPrint) {
  69.         // Pretty-prints a DOM document to XML using DOM Load and Save's LSSerializer.
  70.         // Note that the "format-pretty-print" DOM configuration parameter can only be set in JDK 1.6+.
  71.         DOMImplementation domImplementation = documentImplementation.getImplementation();
  72.         if (domImplementation.hasFeature("LS", "3.0") && domImplementation.hasFeature("Core", "2.0")) {
  73.             DOMImplementationLS domImplementationLS = (DOMImplementationLS) domImplementation.getFeature("LS", "3.0");
  74.             LSSerializer lsSerializer = domImplementationLS.createLSSerializer();
  75.             DOMConfiguration domConfiguration = lsSerializer.getDomConfig();
  76.             if(prettyPrint) {
  77.                 if (domConfiguration.canSetParameter("format-pretty-print", Boolean.TRUE)) {
  78.                     lsSerializer.getDomConfig().setParameter("format-pretty-print", Boolean.TRUE);
  79.                 } else {
  80.                     throw new RuntimeException("DOMConfiguration 'format-pretty-print' parameter isn't settable.");
  81.                 }
  82.             }
  83.             LSOutput lsOutput = domImplementationLS.createLSOutput();
  84.             lsOutput.setEncoding("UTF-8");
  85.             if(out instanceof OutputStream) {
  86.                 lsOutput.setByteStream((OutputStream)out);
  87.             }
  88.             else if(out instanceof Writer) {
  89.                 lsOutput.setCharacterStream((Writer) out);
  90.             }
  91.             lsSerializer.write(n, lsOutput);
  92.         } else {
  93.             throw new RuntimeException("DOM 3.0 LS and/or DOM 2.0 Core not supported.");
  94.         }
  95.     }
  96.     
  97.     
  98.     // OUTPUT STREAM
  99.     
  100.     public static void serialize(Document document,OutputStream out, boolean prettyPrint){
  101.         DOM3LS_XMLUtils.serialize(document, document, out, prettyPrint);
  102.     }
  103.     public static void serialize(Document document,OutputStream out){
  104.         DOM3LS_XMLUtils.serialize(document, document, out, false);
  105.     }
  106.     public static void serialize(Element element,OutputStream out, boolean prettyPrint){
  107.         DOM3LS_XMLUtils.serialize(element.getOwnerDocument(), element, out, prettyPrint);
  108.     }
  109.     public static void serialize(Element element,OutputStream out){
  110.         DOM3LS_XMLUtils.serialize(element.getOwnerDocument(), element, out, false);
  111.     }
  112.     public static void serialize(Node node,OutputStream out, boolean prettyPrint){
  113.         DOM3LS_XMLUtils.serialize(node.getOwnerDocument(), node, out, prettyPrint);
  114.     }
  115.     public static void serialize(Node node,OutputStream out){
  116.         DOM3LS_XMLUtils.serialize(node.getOwnerDocument(), node, out, false);
  117.     }
  118.     public static void serialize(Document documentImplementation,Node n, OutputStream out, boolean prettyPrint){
  119.         DOM3LS_XMLUtils._serialize(documentImplementation, n, out, prettyPrint);
  120.     }
  121.     
  122.     
  123.     // WRITER
  124.     
  125.     public static void serialize(Document document,Writer writer, boolean prettyPrint){
  126.         DOM3LS_XMLUtils.serialize(document, document, writer, prettyPrint);
  127.     }
  128.     public static void serialize(Document document,Writer writer){
  129.         DOM3LS_XMLUtils.serialize(document, document, writer, false);
  130.     }
  131.     public static void serialize(Element element,Writer writer, boolean prettyPrint){
  132.         DOM3LS_XMLUtils.serialize(element.getOwnerDocument(), element, writer, prettyPrint);
  133.     }
  134.     public static void serialize(Element element,Writer writer){
  135.         DOM3LS_XMLUtils.serialize(element.getOwnerDocument(), element, writer, false);
  136.     }
  137.     public static void serialize(Node node,Writer writer, boolean prettyPrint){
  138.         DOM3LS_XMLUtils.serialize(node.getOwnerDocument(), node, writer, prettyPrint);
  139.     }
  140.     public static void serialize(Node node,Writer writer){
  141.         DOM3LS_XMLUtils.serialize(node.getOwnerDocument(), node, writer, false);
  142.     }
  143.     public static void serialize(Document documentImplementation,Node n, Writer writer, boolean prettyPrint){
  144.         DOM3LS_XMLUtils._serialize(documentImplementation, n, writer, prettyPrint);
  145.     }
  146.     
  147.     
  148.     // FILE
  149.     
  150.     public static void serialize(Document document,File file, boolean prettyPrint) throws FileNotFoundException{
  151.         DOM3LS_XMLUtils.serialize(document, document, file, prettyPrint);
  152.     }
  153.     public static void serialize(Document document,File file) throws FileNotFoundException{
  154.         DOM3LS_XMLUtils.serialize(document, document, file, false);
  155.     }
  156.     public static void serialize(Element element,File file, boolean prettyPrint) throws FileNotFoundException{
  157.         DOM3LS_XMLUtils.serialize(element.getOwnerDocument(), element, file, prettyPrint);
  158.     }
  159.     public static void serialize(Element element,File file) throws FileNotFoundException{
  160.         DOM3LS_XMLUtils.serialize(element.getOwnerDocument(), element, file, false);
  161.     }
  162.     public static void serialize(Node node,File file, boolean prettyPrint) throws FileNotFoundException{
  163.         DOM3LS_XMLUtils.serialize(node.getOwnerDocument(), node, file, prettyPrint);
  164.     }
  165.     public static void serialize(Node node,File file) throws FileNotFoundException{
  166.         DOM3LS_XMLUtils.serialize(node.getOwnerDocument(), node, file, false);
  167.     }
  168.     public static void serialize(Document documentImplementation,Node n, File file, boolean prettyPrint) throws FileNotFoundException{
  169.         DOM3LS_XMLUtils._serialize(documentImplementation, n, file, prettyPrint);
  170.     }
  171.     
  172.     public static void _serialize(Document documentImplementation,Node n, File file, boolean prettyPrint) throws FileNotFoundException{
  173.         FileOutputStream fout = null;
  174.         try{
  175.             fout = new FileOutputStream(file);
  176.             DOM3LS_XMLUtils._serialize(documentImplementation,n,fout,prettyPrint);
  177.         }finally{
  178.             try{
  179.                 if(fout!=null) {
  180.                     fout.flush();
  181.                 }
  182.             }catch(Exception eClose){
  183.                 // close
  184.             }
  185.             try{
  186.                 if(fout!=null) {
  187.                     fout.close();
  188.                 }
  189.             }catch(Exception eClose){
  190.                 // close
  191.             }
  192.         }
  193.     }
  194.     
  195.     
  196.     // TO STRING
  197.     
  198.     public static String toString(Document document, boolean prettyPrint){
  199.         return DOM3LS_XMLUtils.toString(document, document, prettyPrint);
  200.     }
  201.     public static String toString(Document document){
  202.         return DOM3LS_XMLUtils.toString(document, document, false);
  203.     }
  204.     public static String toString(Element element, boolean prettyPrint){
  205.         return DOM3LS_XMLUtils.toString(element.getOwnerDocument(), element, prettyPrint);
  206.     }
  207.     public static String toString(Element element){
  208.         return DOM3LS_XMLUtils.toString(element.getOwnerDocument(), element, false);
  209.     }
  210.     public static String toString(Node node, boolean prettyPrint){
  211.         return DOM3LS_XMLUtils.toString(node.getOwnerDocument(), node, prettyPrint);
  212.     }
  213.     public static String toString(Node node){
  214.         return DOM3LS_XMLUtils.toString(node.getOwnerDocument(), node, false);
  215.     }
  216.     public static String toString(Document documentImplementation,Node n, boolean prettyPrint){
  217.         return DOM3LS_XMLUtils._toString(documentImplementation, n, prettyPrint);
  218.     }
  219.     
  220.     public static String _toString(Document documentImplementation,Node n, boolean prettyPrint){
  221.         StringWriter stringWriter = new StringWriter();
  222.         DOM3LS_XMLUtils._serialize(documentImplementation,n,stringWriter,prettyPrint);
  223.         return stringWriter.toString();
  224.     }
  225.     
  226.     
  227.     
  228.     // TO BYTE ARRAY 
  229.     
  230.     public static byte[] toByteArray(Document document, boolean prettyPrint){
  231.         return DOM3LS_XMLUtils.toByteArray(document, document, prettyPrint);
  232.     }
  233.     public static byte[] toByteArray(Document document){
  234.         return DOM3LS_XMLUtils.toByteArray(document, document, false);
  235.     }
  236.     public static byte[] toByteArray(Element element, boolean prettyPrint){
  237.         return DOM3LS_XMLUtils.toByteArray(element.getOwnerDocument(), element, prettyPrint);
  238.     }
  239.     public static byte[] toByteArray(Element element){
  240.         return DOM3LS_XMLUtils.toByteArray(element.getOwnerDocument(), element, false);
  241.     }
  242.     public static byte[] toByteArray(Node node, boolean prettyPrint){
  243.         return DOM3LS_XMLUtils.toByteArray(node.getOwnerDocument(), node, prettyPrint);
  244.     }
  245.     public static byte[] toByteArray(Node node){
  246.         return DOM3LS_XMLUtils.toByteArray(node.getOwnerDocument(), node, false);
  247.     }
  248.     public static byte[] toByteArray(Document documentImplementation,Node n, boolean prettyPrint){
  249.         return DOM3LS_XMLUtils._toByteArray(documentImplementation, n, prettyPrint);
  250.     }
  251.     
  252.     public static byte[] _toByteArray(Document documentImplementation,Node n, boolean prettyPrint) {
  253.         ByteArrayOutputStream bout = null;
  254.         try{
  255.             bout = new ByteArrayOutputStream();
  256.             DOM3LS_XMLUtils._serialize(documentImplementation,n,bout,prettyPrint);
  257.         }finally{
  258.             try{
  259.                 bout.flush();
  260.             }catch(Exception eClose){}
  261.             try{
  262.                 bout.close();
  263.             }catch(Exception eClose){}
  264.         }
  265.         return bout.toByteArray();
  266.     }
  267. }
Created with JaCoCo 0.8.8.202204050719