Java tutorial
/* ************************************************************************ ******************* CANADIAN ASTRONOMY DATA CENTRE ******************* ************** CENTRE CANADIEN DE DONNES ASTRONOMIQUES ************** * * (c) 2011. (c) 2011. * 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: 5 $ * ************************************************************************ */ package ca.nrc.cadc.reg; import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; import java.io.Reader; import java.io.StringReader; import java.io.UnsupportedEncodingException; import java.net.MalformedURLException; import java.net.URI; import java.net.URISyntaxException; import java.net.URL; 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.auth.AuthMethod; import ca.nrc.cadc.xml.XmlUtil; /** * Parser to setup the schema map for parsing a VOSI-capabilities document. * * @author yeunga */ public class CapabilitiesReader { private static final Logger log = Logger.getLogger(CapabilitiesReader.class); private String resourceIDStr = ""; private String standardIDStr = ""; private String accessURLStr = ""; private String securityMethodStr = ""; protected Map<String, String> schemaMap; public CapabilitiesReader() { this(true); } public CapabilitiesReader(boolean enableSchemaValidation) { if (enableSchemaValidation) { this.schemaMap = XMLConstants.SCHEMA_MAP; } } /** * Construct a Capabilities from an XML String source. * * @param xml String of the XML. * @return Capabiltiies Capabilities. */ public Capabilities read(String xml) { if (xml == null) { throw new IllegalArgumentException("XML must not be null"); } return read(new StringReader(xml)); } /** * Construct a Capabilities from a InputStream. * * @param in InputStream. * @return Capabilities Capabilities. * @throws IOException */ public Capabilities read(InputStream istream) { if (istream == null) { throw new RuntimeException("capabilities xml file stream closed"); } try { return read(new InputStreamReader(istream, "UTF-8")); } catch (UnsupportedEncodingException e) { throw new RuntimeException("UTF-8 encoding not supported"); } } public Capabilities read(Reader reader) { if (reader == null) { throw new IllegalArgumentException("reader must not be null"); } // Create a JDOM Document from the XML Document document; try { document = XmlUtil.buildDocument(reader, schemaMap); } catch (IOException ioe) { String msg = "Error reading XML: " + ioe.getMessage(); throw new RuntimeException(msg, ioe); } catch (JDOMException jde) { String msg = "XML failed schema validation: " + jde.getMessage(); throw new RuntimeException(msg, jde); } return this.buildCapabilities(document.getRootElement()); } private Capabilities buildCapabilities(final Element root) { Capabilities caps = new Capabilities(); List<Element> capElementList = root.getChildren("capability", Namespace.NO_NAMESPACE); for (Element capElement : capElementList) { Capability cap = this.buildCapability(capElement); caps.getCapabilities().add(cap); } return caps; } private Capability buildCapability(final Element capElement) { Capability cap = new Capability(this.parseStandardID(capElement)); List<Element> intfElementList = capElement.getChildren("interface"); for (Element intfElement : intfElementList) { Interface intf = this.buildInterface(intfElement); cap.getInterfaces().add(intf); } return cap; } private Interface buildInterface(final Element intfElement) { AccessURL accessURL = this.parseAccessURL(intfElement.getChild("accessURL")); URI securityMethod = this.parseSecurityMethod(intfElement.getChild("securityMethod")); String roleString = intfElement.getAttributeValue("role"); Interface intf = new Interface(accessURL, securityMethod); intf.role = roleString; return intf; } private URI parseSecurityMethod(final Element securityMethodElement) { URI standardID; if (securityMethodElement == null) { // anonymous access standardID = Standards.getSecurityMethod(AuthMethod.ANON); } else { // get the standardID for secure access String standardIDString = securityMethodElement.getAttributeValue("standardID"); if (standardIDString == null) { String prefix = this.resourceIDStr + this.standardIDStr + this.accessURLStr; String msg = prefix + ", standardID attribute not found in securityMethod element"; throw new RuntimeException(msg); } this.securityMethodStr = ", securityMethod standardID=" + standardIDString; try { standardID = new URI(standardIDString); } catch (URISyntaxException e) { String prefix = this.resourceIDStr + this.standardIDStr + this.accessURLStr + this.securityMethodStr; String msg = prefix + ", invalid securityMethod standardID in xml: " + e.getMessage(); throw new RuntimeException(msg); } } log.debug("securityMethod standardID: " + standardID); return standardID; } private AccessURL parseAccessURL(final Element accessURLElement) { AccessURL accessURL = new AccessURL(this.parseURL(accessURLElement)); accessURL.use = this.parseUse(accessURLElement); return accessURL; } private String parseUse(final Element accessURLElement) { String useString = accessURLElement.getAttributeValue("use"); if (useString == null) { String msg = this.resourceIDStr + this.standardIDStr + this.accessURLStr + ", use attribute not found in accessURL element"; throw new RuntimeException(msg); } log.debug("accessURL use: " + useString); return useString; } private URL parseURL(final Element accessURLElement) { String accessURLString = accessURLElement.getText(); if (accessURLString == null) { String msg = this.resourceIDStr + this.standardIDStr + ", URL not found in accessURL element"; throw new RuntimeException(msg); } log.debug("accessURL: " + accessURLString); this.accessURLStr = ", accessURL=" + accessURLString; URL accessURL; try { accessURL = new URL(accessURLString); } catch (MalformedURLException e) { String msg = this.resourceIDStr + this.standardIDStr + this.accessURLStr + ", invalid accessURL in xml: " + e.getMessage(); throw new RuntimeException(msg); } return accessURL; } private URI parseStandardID(final Element capElement) { String standardIDString = capElement.getAttributeValue("standardID"); if (standardIDString == null) { String msg = this.resourceIDStr + ", standardID attribute not found in capability element"; throw new RuntimeException(msg); } this.standardIDStr = ", standardID=" + standardIDString; URI standardID; try { standardID = new URI(standardIDString); } catch (URISyntaxException e) { String msg = this.resourceIDStr + this.standardIDStr + ", invalid standardID in xml: " + e.getMessage(); throw new RuntimeException(msg); } log.debug("capabilities standardID: " + standardIDString); return standardID; } }