Thu, 31 Aug 2017 15:18:52 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.xml.internal.ws.api.server; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import com.sun.xml.internal.stream.buffer.XMLStreamBuffer; |
aoqi@0 | 29 | import com.sun.xml.internal.ws.streaming.TidyXMLStreamReader; |
aoqi@0 | 30 | import com.sun.xml.internal.ws.api.streaming.XMLStreamReaderFactory; |
aoqi@0 | 31 | |
aoqi@0 | 32 | import javax.xml.stream.XMLInputFactory; |
aoqi@0 | 33 | import javax.xml.stream.XMLStreamException; |
aoqi@0 | 34 | import javax.xml.stream.XMLStreamReader; |
aoqi@0 | 35 | import java.io.IOException; |
aoqi@0 | 36 | import java.io.InputStream; |
aoqi@0 | 37 | import java.net.URL; |
aoqi@0 | 38 | |
aoqi@0 | 39 | /** |
aoqi@0 | 40 | * SPI that provides the source of {@link SDDocument}. |
aoqi@0 | 41 | * |
aoqi@0 | 42 | * <p> |
aoqi@0 | 43 | * This abstract class could be implemented by appliations, or one of the |
aoqi@0 | 44 | * {@link #create} methods can be used. |
aoqi@0 | 45 | * |
aoqi@0 | 46 | * @author Kohsuke Kawaguchi |
aoqi@0 | 47 | */ |
aoqi@0 | 48 | public abstract class SDDocumentSource { |
aoqi@0 | 49 | /** |
aoqi@0 | 50 | * Returns the {@link XMLStreamReader} that reads the document. |
aoqi@0 | 51 | * |
aoqi@0 | 52 | * <p> |
aoqi@0 | 53 | * This method maybe invoked multiple times concurrently. |
aoqi@0 | 54 | * |
aoqi@0 | 55 | * @param xif |
aoqi@0 | 56 | * The implementation may choose to use this object when it wants to |
aoqi@0 | 57 | * create a new parser (or it can just ignore this parameter completely.) |
aoqi@0 | 58 | * @return |
aoqi@0 | 59 | * The caller is responsible for closing the reader to avoid resource leak. |
aoqi@0 | 60 | * |
aoqi@0 | 61 | * @throws XMLStreamException |
aoqi@0 | 62 | * if something goes wrong while creating a parser. |
aoqi@0 | 63 | * @throws IOException |
aoqi@0 | 64 | * if something goes wrong trying to read the document. |
aoqi@0 | 65 | */ |
aoqi@0 | 66 | public abstract XMLStreamReader read(XMLInputFactory xif) throws IOException, XMLStreamException; |
aoqi@0 | 67 | |
aoqi@0 | 68 | /** |
aoqi@0 | 69 | * Returns the {@link XMLStreamReader} that reads the document. |
aoqi@0 | 70 | * |
aoqi@0 | 71 | * <p> |
aoqi@0 | 72 | * This method maybe invoked multiple times concurrently. |
aoqi@0 | 73 | * |
aoqi@0 | 74 | * @return |
aoqi@0 | 75 | * The caller is responsible for closing the reader to avoid resource leak. |
aoqi@0 | 76 | * |
aoqi@0 | 77 | * @throws XMLStreamException |
aoqi@0 | 78 | * if something goes wrong while creating a parser. |
aoqi@0 | 79 | * @throws IOException |
aoqi@0 | 80 | * if something goes wrong trying to read the document. |
aoqi@0 | 81 | */ |
aoqi@0 | 82 | public abstract XMLStreamReader read() throws IOException, XMLStreamException; |
aoqi@0 | 83 | |
aoqi@0 | 84 | /** |
aoqi@0 | 85 | * System ID of this document. |
aoqi@0 | 86 | */ |
aoqi@0 | 87 | public abstract URL getSystemId(); |
aoqi@0 | 88 | |
aoqi@0 | 89 | /** |
aoqi@0 | 90 | * Creates {@link SDDocumentSource} from an URL. |
aoqi@0 | 91 | */ |
aoqi@0 | 92 | public static SDDocumentSource create(final URL url) { |
aoqi@0 | 93 | return new SDDocumentSource() { |
aoqi@0 | 94 | private final URL systemId = url; |
aoqi@0 | 95 | |
aoqi@0 | 96 | public XMLStreamReader read(XMLInputFactory xif) throws IOException, XMLStreamException { |
aoqi@0 | 97 | InputStream is = url.openStream(); |
aoqi@0 | 98 | return new TidyXMLStreamReader( |
aoqi@0 | 99 | xif.createXMLStreamReader(systemId.toExternalForm(),is), is); |
aoqi@0 | 100 | } |
aoqi@0 | 101 | |
aoqi@0 | 102 | public XMLStreamReader read() throws IOException, XMLStreamException { |
aoqi@0 | 103 | InputStream is = url.openStream(); |
aoqi@0 | 104 | return new TidyXMLStreamReader( |
aoqi@0 | 105 | XMLStreamReaderFactory.create(systemId.toExternalForm(),is,false), is); |
aoqi@0 | 106 | } |
aoqi@0 | 107 | |
aoqi@0 | 108 | public URL getSystemId() { |
aoqi@0 | 109 | return systemId; |
aoqi@0 | 110 | } |
aoqi@0 | 111 | }; |
aoqi@0 | 112 | } |
aoqi@0 | 113 | |
aoqi@0 | 114 | /** |
aoqi@0 | 115 | * Creates a {@link SDDocumentSource} from {@link XMLStreamBuffer}. |
aoqi@0 | 116 | */ |
aoqi@0 | 117 | public static SDDocumentSource create(final URL systemId, final XMLStreamBuffer xsb) { |
aoqi@0 | 118 | return new SDDocumentSource() { |
aoqi@0 | 119 | public XMLStreamReader read(XMLInputFactory xif) throws XMLStreamException { |
aoqi@0 | 120 | return xsb.readAsXMLStreamReader(); |
aoqi@0 | 121 | } |
aoqi@0 | 122 | |
aoqi@0 | 123 | public XMLStreamReader read() throws XMLStreamException { |
aoqi@0 | 124 | return xsb.readAsXMLStreamReader(); |
aoqi@0 | 125 | } |
aoqi@0 | 126 | |
aoqi@0 | 127 | public URL getSystemId() { |
aoqi@0 | 128 | return systemId; |
aoqi@0 | 129 | } |
aoqi@0 | 130 | }; |
aoqi@0 | 131 | } |
aoqi@0 | 132 | } |