XmlProductHandler.java

  1. /*
  2.  * XmlProductHandler
  3.  */
  4. package gov.usgs.earthquake.product.io;

  6. import java.io.InputStream;
  7. import java.io.OutputStream;
  8. import java.net.URI;
  9. import java.net.URL;
  10. import java.util.Base64;

  12. import gov.usgs.util.StreamUtils;
  13. import gov.usgs.util.XmlUtils;
  14. import gov.usgs.util.CryptoUtils.Version;
  15. import gov.usgs.earthquake.product.Content;
  16. import gov.usgs.earthquake.product.URLContent;
  17. import gov.usgs.earthquake.product.ProductId;


  20. /**
  21.  * Store a product to an OutputStream using XML.
  22.  */
  23. public class XmlProductHandler implements ProductHandler {

  25.     /** Declaration for XML and version */
  26.     public static final String XML_DECLARATION = "<?xml version=\"1.0\"?>\n";
  27.     /** Namespace for XML product */
  28.     public static final String PRODUCT_XML_NAMESPACE = "http://earthquake.usgs.gov/distribution/product";

  30.     /** Element for product */
  31.     public static final String PRODUCT_ELEMENT = "product";
  32.     /** Product Attribute for id */
  33.     public static final String PRODUCT_ATTRIBUTE_ID = "id";
  34.     /** Product Attribute for updateTime */
  35.     public static final String PRODUCT_ATTRIBUTE_UPDATED = "updateTime";
  36.     /** Product Attribute for status */
  37.     public static final String PRODUCT_ATTRIBUTE_STATUS = "status";
  38.     /** Product Attribute for trackerURL */
  39.     public static final String PRODUCT_ATTRIBUTE_TRACKER_URL = "trackerURL";

  41.     /** Element for property */
  42.     public static final String PROPERTY_ELEMENT = "property";
  43.     /** Property attribute for name */
  44.     public static final String PROPERTY_ATTRIBUTE_NAME = "name";
  45.     /** Property attribute for value */
  46.     public static final String PROPERTY_ATTRIBUTE_VALUE = "value";

  48.     /** Element for link */
  49.     public static final String LINK_ELEMENT = "link";
  50.     /** Link attribute for relation */
  51.     public static final String LINK_ATTRIBUTE_RELATION = "rel";
  52.     /** Link attribute for href */
  53.     public static final String LINK_ATTRIBUTE_HREF = "href";

  55.     /** Element for content */
  56.     public static final String CONTENT_ELEMENT = "content";
  57.     /** Content attribute for path */
  58.     public static final String CONTENT_ATTRIBUTE_PATH = "path";
  59.     /** Content attribute for type */
  60.     public static final String CONTENT_ATTRIBUTE_TYPE = "type";
  61.     /** Content attribute for length */
  62.     public static final String CONTENT_ATTRIBUTE_LENGTH = "length";
  63.     /** Content attribute for modified */
  64.     public static final String CONTENT_ATTRIBUTE_MODIFIED = "modified";
  65.     /** Used with URLContent. */
  66.     public static final String CONTENT_ATTRIBUTE_HREF = "href";
  67.     /** Content attribute for encoded */
  68.     public static final String CONTENT_ATTRIBUTE_ENCODED = "encoded";

  70.     /** Element for signature */
  71.     public static final String SIGNATURE_ELEMENT = "signature";
  72.     /** Signature attribute for version */
  73.     public static final String SIGNATURE_ATTRIBUTE_VERSION = "version";

  75.     /** The OutputStream where xml is written. */
  76.     private OutputStream out;

  78.     /** Controls whether the XML Declaration is output with the XML. */
  79.     private boolean includeDeclaration = true;

  81.     /** Signature version. */
  82.     private Version signatureVersion = Version.SIGNATURE_V1;

  84.     /**
  85.      * Create a new XmlProductHandler object.
  86.      *
  87.      * @param out
  88.      *            the OutputStream where xml will be written.
  89.      */
  90.     public XmlProductHandler(final OutputStream out) {
  91.         this.out = out;
  92.     }

  94.     /**
  95.      * Create a new XmlProductHandler object.
  96.      *
  97.      * @param out
  98.      *            the OutputStream where xml will be written.
  99.      * @param includeDeclaration
  100.      *            whether to include the XML declaration with output
  101.      */
  102.     public XmlProductHandler(final OutputStream out, boolean includeDeclaration) {
  103.         this.out = out;
  104.         this.includeDeclaration = includeDeclaration;
  105.     }

  107.     /**
  108.      * Output the product root element.
  109.      */
  110.     public void onBeginProduct(ProductId id, String status, URL trackerURL)
  111.             throws Exception {
  112.         StringBuffer buf = new StringBuffer();
  113.         if (includeDeclaration) {
  114.             buf.append(XML_DECLARATION);
  115.         }
  116.         buf.append("<").append(PRODUCT_ELEMENT);
  117.         buf.append(" xmlns=\"").append(PRODUCT_XML_NAMESPACE).append("\"");
  118.         buf.append(" ").append(PRODUCT_ATTRIBUTE_ID).append("=\"")
  119.                 .append(XmlUtils.escape(id.toString())).append("\"");
  120.         buf.append(" ").append(PRODUCT_ATTRIBUTE_UPDATED).append("=\"")
  121.                 .append(XmlUtils.formatDate(id.getUpdateTime())).append("\"");
  122.         buf.append(" ").append(PRODUCT_ATTRIBUTE_STATUS).append("=\"")
  123.                 .append(XmlUtils.escape(status)).append("\"");
  124.         if (trackerURL != null) {
  125.             buf.append(" ").append(PRODUCT_ATTRIBUTE_TRACKER_URL).append("=\"")
  126.                     .append(trackerURL.toExternalForm()).append("\"");
  127.         }
  128.         buf.append(">\n");

  130.         out.write(buf.toString().getBytes());
  131.     }

  133.     /**
  134.      * Output a content object as xml.
  135.      */
  136.     public void onContent(ProductId id, String path, Content content)
  137.             throws Exception {
  138.         // open element
  139.         StringBuffer buf = new StringBuffer();
  140.         buf.append("\t<").append(CONTENT_ELEMENT);
  141.         buf.append(" ").append(CONTENT_ATTRIBUTE_PATH).append("=\"")
  142.                 .append(XmlUtils.escape(path)).append("\"");
  143.         buf.append(" ").append(CONTENT_ATTRIBUTE_TYPE).append("=\"")
  144.                 .append(XmlUtils.escape(content.getContentType())).append("\"");
  145.         buf.append(" ").append(CONTENT_ATTRIBUTE_LENGTH).append("=\"")
  146.                 .append(content.getLength()).append("\"");
  147.         buf.append(" ").append(CONTENT_ATTRIBUTE_MODIFIED).append("=\"")
  148.                 .append(XmlUtils.formatDate(content.getLastModified()))
  149.                 .append("\"");

  151.         if (content instanceof URLContent) {
  152.             // URL CONTENT
  153.             buf.append(" ").append(CONTENT_ATTRIBUTE_HREF).append("=\"")
  154.                     .append(((URLContent) content).getURL().toString())
  155.                     .append("\"");

  157.             // close element early, url is alternative to embedded content
  158.             buf.append("/>");
  159.             out.write(buf.toString().getBytes());
  160.             return;
  161.         }

  163.         else {
  164.             // EMBEDDED CONTENT
  165.             buf.append(" ").append(CONTENT_ATTRIBUTE_ENCODED)
  166.                     .append("=\"true\"");

  168.             buf.append(">");
  169.             out.write(buf.toString().getBytes());

  171.             InputStream in = null;
  172.             OutputStream base64out = null;
  173.             try {
  174.                 in = content.getInputStream();
  175.                 base64out = Base64.getEncoder().wrap(
  176.                         new StreamUtils.UnclosableOutputStream(out));
  177.                 // write element content
  178.                 StreamUtils.transferStream(in, base64out);
  179.             } finally {
  180.                 StreamUtils.closeStream(in);
  181.                 StreamUtils.closeStream(base64out);
  182.             }

  184.             // close element
  185.             buf = new StringBuffer();
  186.             buf.append("</").append(CONTENT_ELEMENT).append(">\n");
  187.             out.write(buf.toString().getBytes());
  188.         }
  189.     }

  191.     /**
  192.      * Output the closing product element.
  193.      */
  194.     public void onEndProduct(ProductId id) throws Exception {
  195.         StringBuffer buf = new StringBuffer();
  196.         buf.append("</").append(PRODUCT_ELEMENT).append(">\n");

  198.         out.write(buf.toString().getBytes());
  199.         out.flush();
  200.         out.close();
  201.     }

  203.     /**
  204.      * Output a link element as xml.
  205.      */
  206.     public void onLink(ProductId id, String relation, URI href)
  207.             throws Exception {
  208.         StringBuffer buf = new StringBuffer();
  209.         buf.append("\t<").append(LINK_ELEMENT);
  210.         buf.append(" ").append(LINK_ATTRIBUTE_RELATION).append("=\"")
  211.                 .append(XmlUtils.escape(relation)).append("\"");
  212.         buf.append(" ").append(LINK_ATTRIBUTE_HREF).append("=\"")
  213.                 .append(XmlUtils.escape(href.toString())).append("\"");
  214.         buf.append("/>\n");

  216.         out.write(buf.toString().getBytes());
  217.     }

  219.     /**
  220.      * Output the property element as xml.
  221.      */
  222.     public void onProperty(ProductId id, String name, String value)
  223.             throws Exception {
  224.         StringBuffer buf = new StringBuffer();
  225.         buf.append("\t<").append(PROPERTY_ELEMENT);
  226.         buf.append(" ").append(PROPERTY_ATTRIBUTE_NAME).append("=\"")
  227.                 .append(XmlUtils.escape(name)).append("\"");
  228.         buf.append(" ").append(PROPERTY_ATTRIBUTE_VALUE).append("=\"")
  229.                 .append(XmlUtils.escape(value)).append("\"");
  230.         buf.append("/>\n");

  232.         out.write(buf.toString().getBytes());
  233.     }

  235.     public void onSignatureVersion(ProductId id, Version version) throws Exception {
  236.         // save for output during onSignature
  237.         this.signatureVersion = version;
  238.     }

  240.     /**
  241.      * Output the signature element as xml.
  242.      */
  243.     public void onSignature(ProductId id, String signature) throws Exception {
  244.         if (signature == null) {
  245.             return;
  246.         }

  248.         StringBuffer buf = new StringBuffer();
  249.         buf.append("\t<").append(SIGNATURE_ELEMENT);
  250.         buf.append(" ").append(SIGNATURE_ATTRIBUTE_VERSION).append("=\"")
  251.                 .append(signatureVersion.toString()).append("\"");
  252.         buf.append(">");
  253.         buf.append(signature);
  254.         buf.append("</").append(SIGNATURE_ELEMENT).append(">\n");

  256.         out.write(buf.toString().getBytes());
  257.     }

  259.     /**
  260.      * Free any resources associated with this handler.
  261.      */
  262.     @Override
  263.     public void close() {
  264.         StreamUtils.closeStream(out);
  265.     }


  268. }
Created with JaCoCo 0.8.8.202204050719