src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/SDDocumentSource.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 637
9c07ef4934dd
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

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

mercurial