ca.nrc.cadc.vos.TransferWriter.java Source code

Java tutorial

Introduction

Here is the source code for ca.nrc.cadc.vos.TransferWriter.java

Source

/*
************************************************************************
*******************  CANADIAN ASTRONOMY DATA CENTRE  *******************
**************  CENTRE CANADIEN DE DONNES ASTRONOMIQUES  **************
*
*  (c) 2009.                            (c) 2009.
*  Government of Canada                 Gouvernement du Canada
*  National Research Council            Conseil national de recherches
*  Ottawa, Canada, K1A 0R6              Ottawa, Canada, K1A 0R6
*  All rights reserved                  Tous droits rservs
*                                       
*  NRC disclaims any warranties,        Le CNRC dnie toute garantie
*  expressed, implied, or               nonce, implicite ou lgale,
*  statutory, of any kind with          de quelque nature que ce
*  respect to the software,             soit, concernant le logiciel,
*  including without limitation         y compris sans restriction
*  any warranty of merchantability      toute garantie de valeur
*  or fitness for a particular          marchande ou de pertinence
*  purpose. NRC shall not be            pour un usage particulier.
*  liable in any event for any          Le CNRC ne pourra en aucun cas
*  damages, whether direct or           tre tenu responsable de tout
*  indirect, special or general,        dommage, direct ou indirect,
*  consequential or incidental,         particulier ou gnral,
*  arising from the use of the          accessoire ou fortuit, rsultant
*  software.  Neither the name          de l'utilisation du logiciel. Ni
*  of the National Research             le nom du Conseil National de
*  Council of Canada nor the            Recherches du Canada ni les noms
*  names of its contributors may        de ses  participants ne peuvent
*  be used to endorse or promote        tre utiliss pour approuver ou
*  products derived from this           promouvoir les produits drivs
*  software without specific prior      de ce logiciel sans autorisation
*  written permission.                  pralable et particulire
*                                       par crit.
*                                       
*  This file is part of the             Ce fichier fait partie du projet
*  OpenCADC project.                    OpenCADC.
*                                       
*  OpenCADC is free software:           OpenCADC est un logiciel libre ;
*  you can redistribute it and/or       vous pouvez le redistribuer ou le
*  modify it under the terms of         modifier suivant les termes de
*  the GNU Affero General Public        la GNU Affero General Public
*  License as published by the          License? telle que publie
*  Free Software Foundation,            par la Free Software Foundation
*  either version 3 of the              : soit la version 3 de cette
*  License, or (at your option)         licence, soit ( votre gr)
*  any later version.                   toute version ultrieure.
*                                       
*  OpenCADC is distributed in the       OpenCADC est distribu
*  hope that it will be useful,         dans lespoir quil vous
*  but WITHOUT ANY WARRANTY;            sera utile, mais SANS AUCUNE
*  without even the implied             GARANTIE : sans mme la garantie
*  warranty of MERCHANTABILITY          implicite de COMMERCIALISABILIT
*  or FITNESS FOR A PARTICULAR          ni dADQUATION  UN OBJECTIF
*  PURPOSE.  See the GNU Affero         PARTICULIER. Consultez la Licence
*  General Public License for           Gnrale Publique GNU Affero
*  more details.                        pour plus de dtails.
*                                       
*  You should have received             Vous devriez avoir reu une
*  a copy of the GNU Affero             copie de la Licence Gnrale
*  General Public License along         Publique GNU Affero avec
*  with OpenCADC.  If not, see          OpenCADC ; si ce nest
*  <http://www.gnu.org/licenses/>.      pas le cas, consultez :
*                                       <http://www.gnu.org/licenses/>.
*
*  $Revision: 4 $
*
************************************************************************
*/

package ca.nrc.cadc.vos;

import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;

import org.apache.log4j.Logger;
import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.output.Format;
import org.jdom2.output.XMLOutputter;

/**
 * Writes a Transfer as XML to an output.
 * 
 * @author Sailor Zhang
 */
public class TransferWriter {
    @SuppressWarnings("unused")
    private static Logger log = Logger.getLogger(TransferWriter.class);

    public TransferWriter() {
    }

    /**
     * Write the transfer to an OutputStream.
     *
     * @param trans
     * @param out OutputStream to write to.
     * @throws IOException if the writer fails to write.
     */
    public void write(Transfer trans, OutputStream out) throws IOException {
        write(trans, new OutputStreamWriter(out));
    }

    /**
     * Write the transfer to a writer.
     *
     * @param trans
     * @param writer Writer to write to.
     * @throws IOException if the writer fails to write.
     */
    public void write(Transfer trans, Writer writer) throws IOException {
        Element root = buildRoot(trans);
        write(root, writer);
    }

    /**
     * Build root element for the transfer.
     * @param transfer
     * @return root element
     */
    private Element buildRoot(Transfer transfer) {
        Element root = new Element("transfer", TransferReader.VOS_NS);
        root.addNamespaceDeclaration(TransferReader.VOS_NS);

        Element e = null;

        e = new Element("target", TransferReader.VOS_NS);
        e.addContent(transfer.getTarget().getURIObject().toASCIIString());
        root.addContent(e);

        e = new Element("direction", TransferReader.VOS_NS);
        e.addContent(transfer.getDirection().getValue());
        root.addContent(e);

        e = new Element("view", TransferReader.VOS_NS);
        if (transfer.getView() != null) {
            e.setAttribute("uri", transfer.getView().getURI().toString());
            for (View.Parameter param : transfer.getView().getParameters()) {
                Element pm = new Element("param", TransferReader.VOS_NS);
                pm.setAttribute("uri", param.getUri().toString());
                pm.setText(param.getValue());
                e.addContent(pm);
            }
            root.addContent(e);
        }

        if (transfer.getProtocols() != null) {
            for (Protocol protocol : transfer.getProtocols()) {
                Element pr = new Element("protocol", TransferReader.VOS_NS);
                pr.setAttribute("uri", protocol.getUri());
                if (protocol.getEndpoint() != null) {
                    Element ep = new Element("endpoint", TransferReader.VOS_NS);
                    ep.addContent(protocol.getEndpoint());
                    pr.addContent(ep);
                }
                root.addContent(pr);
            }
        }

        e = new Element("keepBytes", TransferReader.VOS_NS);
        e.addContent(new Boolean(transfer.isKeepBytes()).toString());
        root.addContent(e);

        return root;
    }

    /**
     * Write to root Element to a writer.
     *
     * @param root Root Element to write.
     * @param writer Writer to write to.
     * @throws IOException if the writer fails to write.
     */
    @SuppressWarnings("unchecked")
    protected void write(Element root, Writer writer) throws IOException {
        XMLOutputter outputter = new XMLOutputter();
        outputter.setFormat(Format.getPrettyFormat());
        Document document = new Document(root);
        outputter.output(document, writer);
    }

}