DefaultXmlSerializer.java

  1. /*
  2.  * Portions of this software was developed by employees of the National Institute
  3.  * of Standards and Technology (NIST), an agency of the Federal Government and is
  4.  * being made available as a public service. Pursuant to title 17 United States
  5.  * Code Section 105, works of NIST employees are not subject to copyright
  6.  * protection in the United States. This software may be subject to foreign
  7.  * copyright. Permission in the United States and in foreign countries, to the
  8.  * extent that NIST may hold copyright, to use, copy, modify, create derivative
  9.  * works, and distribute this software and its documentation without fee is hereby
  10.  * granted on a non-exclusive basis, provided that this notice and disclaimer
  11.  * of warranty appears in all copies.
  12.  *
  13.  * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
  14.  * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
  15.  * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
  16.  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
  17.  * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
  18.  * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
  19.  * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
  20.  * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
  21.  * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
  22.  * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
  23.  * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
  24.  * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
  25.  */

  26. package gov.nist.secauto.metaschema.databind.io.xml;

  27. import com.ctc.wstx.api.WstxOutputProperties;
  28. import com.ctc.wstx.stax.WstxOutputFactory;

  29. import gov.nist.secauto.metaschema.core.util.ObjectUtils;
  30. import gov.nist.secauto.metaschema.databind.io.AbstractSerializer;
  31. import gov.nist.secauto.metaschema.databind.model.IAssemblyClassBinding;

  32. import org.codehaus.stax2.XMLOutputFactory2;
  33. import org.codehaus.stax2.XMLStreamWriter2;

  34. import java.io.IOException;
  35. import java.io.Writer;

  36. import javax.xml.stream.XMLOutputFactory;
  37. import javax.xml.stream.XMLStreamException;

  38. import edu.umd.cs.findbugs.annotations.NonNull;

  39. public class DefaultXmlSerializer<CLASS>
  40.     extends AbstractSerializer<CLASS> {
  41.   private XMLOutputFactory2 xmlOutputFactory;

  42.   /**
  43.    * Construct a new XML serializer based on the top-level assembly indicated by
  44.    * the provided {@code classBinding}.
  45.    *
  46.    * @param classBinding
  47.    *          the bound Module assembly definition that describes the data to
  48.    *          serialize
  49.    */
  50.   public DefaultXmlSerializer(@NonNull IAssemblyClassBinding classBinding) {
  51.     super(classBinding);
  52.   }

  53.   /**
  54.    * Get the configured XML output factory used to create {@link XMLStreamWriter2}
  55.    * instances.
  56.    *
  57.    * @return the factory
  58.    */
  59.   @NonNull
  60.   protected final XMLOutputFactory2 getXMLOutputFactory() {
  61.     synchronized (this) {
  62.       if (xmlOutputFactory == null) {
  63.         xmlOutputFactory = (XMLOutputFactory2) XMLOutputFactory.newInstance();
  64.         assert xmlOutputFactory instanceof WstxOutputFactory;
  65.         xmlOutputFactory.configureForSpeed();
  66.         xmlOutputFactory.setProperty(WstxOutputProperties.P_USE_DOUBLE_QUOTES_IN_XML_DECL, true);
  67.         xmlOutputFactory.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
  68.       }
  69.       assert xmlOutputFactory != null;
  70.       return xmlOutputFactory;
  71.     }
  72.   }

  73.   /**
  74.    * Override the default {@link XMLOutputFactory2} instance with a custom
  75.    * factory.
  76.    *
  77.    * @param xmlOutputFactory
  78.    *          the new factory
  79.    */
  80.   protected void setXMLOutputFactory(@NonNull XMLOutputFactory2 xmlOutputFactory) {
  81.     synchronized (this) {
  82.       this.xmlOutputFactory = xmlOutputFactory;
  83.     }
  84.   }

  85.   /**
  86.    * Create a new stream writer using the provided writer.
  87.    *
  88.    * @param writer
  89.    *          the writer to use for output
  90.    * @return the stream writer created by the output factory
  91.    * @throws IOException
  92.    *           if an error occurred while creating the writer
  93.    */
  94.   @NonNull
  95.   protected final XMLStreamWriter2 newXMLStreamWriter(@NonNull Writer writer) throws IOException {
  96.     try {
  97.       return ObjectUtils.notNull((XMLStreamWriter2) getXMLOutputFactory().createXMLStreamWriter(writer));
  98.     } catch (XMLStreamException ex) {
  99.       throw new IOException(ex);
  100.     }
  101.   }

  102.   @Override
  103.   public void serialize(CLASS data, Writer writer) throws IOException {
  104.     XMLStreamWriter2 streamWriter = newXMLStreamWriter(writer);
  105.     IOException caughtException = null;
  106.     IAssemblyClassBinding classBinding = getClassBinding();

  107.     MetaschemaXmlWriter xmlGenerator = new MetaschemaXmlWriter(streamWriter);

  108.     try {
  109.       xmlGenerator.write(classBinding, data);
  110.       streamWriter.flush();
  111.     } catch (XMLStreamException ex) {
  112.       caughtException = new IOException(ex);
  113.       throw caughtException;
  114.     } finally { // NOPMD - exception handling is needed
  115.       try {
  116.         streamWriter.close();
  117.       } catch (XMLStreamException ex) {
  118.         if (caughtException == null) {
  119.           throw new IOException(ex);
  120.         }
  121.         caughtException.addSuppressed(ex);
  122.         throw caughtException; // NOPMD - intentional
  123.       }
  124.     }
  125.   }
  126. }