ca.nrc.cadc.caom2.xml.ArtifactAccessReader.java Source code

Java tutorial

Introduction

Here is the source code for ca.nrc.cadc.caom2.xml.ArtifactAccessReader.java

Source

/*
************************************************************************
*******************  CANADIAN ASTRONOMY DATA CENTRE  *******************
**************  CENTRE CANADIEN DE DONNES ASTRONOMIQUES  **************
*
*  (c) 2018.                            (c) 2018.
*  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/>.
*
************************************************************************
*/

package ca.nrc.cadc.caom2.xml;

import ca.nrc.cadc.caom2.Artifact;
import ca.nrc.cadc.caom2.ProductType;
import ca.nrc.cadc.caom2.ReleaseType;
import ca.nrc.cadc.caom2.access.ArtifactAccess;
import ca.nrc.cadc.xml.XmlUtil;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.StringReader;
import java.net.URI;
import java.util.List;
import org.apache.log4j.Logger;
import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.JDOMException;

/**
 *
 * @author pdowler
 */
public class ArtifactAccessReader {
    private static final Logger log = Logger.getLogger(ArtifactAccessReader.class);

    static enum ENAMES {
        artifactAccess(), artifact(), uri(), productType(), releaseType(), contentLength(), contentType(), contentChecksum(), isPublic(), readGroups();
    }

    public ArtifactAccessReader() {
    }

    public ArtifactAccess read(String xml) throws IOException {
        return read(new StringReader(xml));
    }

    public ArtifactAccess read(InputStream istream) throws IOException {
        return read(new InputStreamReader(istream));
    }

    public ArtifactAccess read(Reader reader) throws IOException {
        if (reader == null) {
            throw new IllegalArgumentException("reader must not be null");
        }

        Document document;
        try {
            document = XmlUtil.buildDocument(reader);
        } catch (JDOMException ex) {
            throw new IllegalArgumentException("invalid input document", ex);
        }

        // Root element and namespace of the Document
        Element root = document.getRootElement();
        if (!ENAMES.artifactAccess.name().equals(root.getName())) {
            throw new IllegalArgumentException(
                    "invalid root element: " + root.getName() + " expected: " + ENAMES.artifactAccess);
        }

        Artifact a = getArtifact(root.getChild(ENAMES.artifact.name()));
        ArtifactAccess ret = new ArtifactAccess(a);

        ret.isPublic = getBoolean(root.getChildTextTrim(ENAMES.isPublic.name()));

        getGroupList(ret.getReadGroups(), ENAMES.readGroups.name(), root.getChildren(ENAMES.readGroups.name()));

        return ret;
    }

    private boolean getBoolean(String s) {
        if ("true".equals(s)) {
            return true;
        }
        return false;
    }

    private URI getURI(String s, boolean required) {
        if (!required && s == null) {
            return null;
        }
        try {
            return new URI(s);
        } catch (Exception ex) {
            throw new IllegalArgumentException("missing/invalid uri element: " + s + " expected: valid URI");
        }
    }

    private Long getLong(String s) {
        if (s == null) {
            return null;
        }
        try {
            return Long.parseLong(s);
        } catch (Exception ex) {
            throw new IllegalArgumentException("invalid numeric element: " + s + " expected: valid long");
        }
    }

    private Artifact getArtifact(Element ae) {
        URI uri = getURI(ae.getChildTextTrim(ENAMES.uri.name()), true);
        ProductType pt = ProductType.toValue(ae.getChildTextTrim(ENAMES.productType.name()));
        ReleaseType rt = ReleaseType.toValue(ae.getChildTextTrim(ENAMES.releaseType.name()));
        Artifact ret = new Artifact(uri, pt, rt);
        ret.contentChecksum = getURI(ae.getChildTextTrim(ENAMES.contentChecksum.name()), false);
        ret.contentLength = getLong(ae.getChildTextTrim(ENAMES.contentLength.name()));
        ret.contentType = ae.getChildTextTrim(ENAMES.contentType.name());

        return ret;
    }

    private void getGroupList(List<URI> fill, String ename, List<Element> elements) {
        if (elements == null || elements.isEmpty()) {
            return;
        }

        if (elements.size() > 1) {
            throw new IllegalArgumentException(
                    "invalid input document: found multiple " + ename + " expected: 0 or 1");
        }
        Element ge = elements.get(0);
        for (Element e : ge.getChildren()) {
            if (!ENAMES.uri.name().equals(e.getName())) {
                throw new IllegalArgumentException(
                        "invalid child element in " + ename + ": " + e.getName() + " expected: uri");
            }
            URI guri = getURI(e.getTextTrim(), true);
            fill.add(guri);
        }
    }
}