Java tutorial
/* ************************************************************************ ******************* 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.InputStream; import java.io.InputStreamReader; import java.io.Reader; import java.io.StringReader; import java.net.URI; import java.net.URISyntaxException; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; import org.apache.log4j.Logger; import org.jdom2.Document; import org.jdom2.Element; import org.jdom2.JDOMException; import org.jdom2.Namespace; import ca.nrc.cadc.uws.util.XmlUtil; import ca.nrc.cadc.vos.View.Parameter; /** * Constructs a Transfer from an XML source. This class is not thread safe but it is * re-usable so it can safely be used to sequentially parse multiple XML transfer * documents. * * @author pdowler */ public class TransferReader { public static final String VOSPACE_SCHEMA_URL = "http://www.ivoa.net/xml/VOSpace/v2.0"; public static final String VOSPACE_SCHEMA_RESOURCE = "VOSpace-2.0.xsd"; static Namespace VOS_NS = Namespace.getNamespace("vos", "http://www.ivoa.net/xml/VOSpace/v2.0"); private static Logger log = Logger.getLogger(TransferReader.class); protected Map<String, String> schemaMap; /** * Constructor. XML Schema validation is enabled by default. */ public TransferReader() { this(true); } /** * Constructor. XML schema validation may be disabled, in which case the client * is likely to fail in horrible ways (e.g. NullPointerException) if it receives * invalid documents. However, performance may be improved. * * @param enableSchemaValidation */ public TransferReader(boolean enableSchemaValidation) { if (enableSchemaValidation) { String vospaceSchemaUrl = XmlUtil.getResourceUrlString(VOSPACE_SCHEMA_RESOURCE, TransferReader.class); if (vospaceSchemaUrl == null) throw new RuntimeException("failed to find " + VOSPACE_SCHEMA_RESOURCE + " in classpath"); this.schemaMap = new HashMap<String, String>(); schemaMap.put(VOSPACE_SCHEMA_URL, vospaceSchemaUrl); log.debug("schema validation enabled"); } else log.debug("schema validation disabled"); } public Transfer read(Reader reader) throws IOException, TransferParsingException { try { // TODO: investigate creating a SAXBuilder once and re-using it // as long as we can detect concurrent access (a la java collections) Document doc = XmlUtil.validateXml(reader, schemaMap); return parseTransfer(doc); } catch (JDOMException ex) { throw new TransferParsingException("failed to parse XML", ex); } catch (URISyntaxException ex) { throw new TransferParsingException("invalid URI in transfer document", ex); } } public Transfer read(InputStream in) throws IOException, TransferParsingException { InputStreamReader reader = new InputStreamReader(in); return read(reader); } public Transfer read(String string) throws IOException, TransferParsingException { StringReader reader = new StringReader(string); return read(reader); } private Transfer parseTransfer(Document document) throws URISyntaxException { Element root = document.getRootElement(); Direction direction = parseDirection(root); // String serviceUrl; // not in XML yet VOSURI target = new VOSURI(root.getChildText("target", VOS_NS)); // TODO: get view nodes and uri attribute View view = null; Parameter param = null; List views = root.getChildren("view", VOS_NS); if (views != null && views.size() > 0) { Element v = (Element) views.get(0); view = new View(new URI(v.getAttributeValue("uri"))); List params = v.getChildren("param", VOS_NS); if (params != null) { for (Object o : params) { Element p = (Element) o; param = new Parameter(new URI(p.getAttributeValue("uri")), p.getText()); view.getParameters().add(param); } } } List<Protocol> protocols = parseProtocols(root); String keepBytesStr = root.getChildText("keepBytes", VOS_NS); if (keepBytesStr != null) { boolean keepBytes = true; keepBytes = keepBytesStr.equalsIgnoreCase("true"); return new Transfer(target, direction, view, protocols, keepBytes); } return new Transfer(target, direction, view, protocols); } private Direction parseDirection(Element root) { Direction rtn = null; String strDirection = root.getChildText("direction", VOS_NS); if (strDirection == null) throw new RuntimeException("Did not find direction element in XML."); if (strDirection.equalsIgnoreCase(Direction.pullFromVoSpace.getValue())) rtn = Direction.pullFromVoSpace; else if (strDirection.equalsIgnoreCase(Direction.pullToVoSpace.getValue())) rtn = Direction.pullToVoSpace; else if (strDirection.equalsIgnoreCase(Direction.pushFromVoSpace.getValue())) rtn = Direction.pushFromVoSpace; else if (strDirection.equalsIgnoreCase(Direction.pushToVoSpace.getValue())) rtn = Direction.pushToVoSpace; else rtn = new Direction(strDirection); return rtn; } private List<Protocol> parseProtocols(Element root) { List<Protocol> rtn = null; //Element e = root.getChild("protocols", NS); List prots = root.getChildren("protocol", VOS_NS); if (prots != null && prots.size() > 0) { rtn = new ArrayList<Protocol>(prots.size()); for (Object obj : prots) { Element eProtocol = (Element) obj; String uri = eProtocol.getAttributeValue("uri"); String endpoint = eProtocol.getChildText("endpoint", VOS_NS); rtn.add(new Protocol(uri, endpoint, null)); } } return rtn; } }