View Javadoc
1   /*
2    * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package com.sun.xml.internal.ws.api.wsdl.parser;
27  
28  import com.sun.xml.internal.ws.api.server.SDDocumentSource;
29  import org.xml.sax.EntityResolver;
30  import org.xml.sax.SAXException;
31  
32  import javax.xml.stream.XMLStreamException;
33  import javax.xml.stream.XMLStreamReader;
34  import java.io.IOException;
35  import java.net.URL;
36  
37  /**
38   * Resolves a reference to {@link XMLStreamReader}.
39   *
40   * This is kinda like {@link EntityResolver} but works
41   * at the XML infoset level.
42   *
43   * @author Kohsuke Kawaguchi
44   */
45  public interface XMLEntityResolver {
46      /**
47       * See {@link EntityResolver#resolveEntity(String, String)} for the contract.
48       */
49      Parser resolveEntity(String publicId,String systemId)
50          throws SAXException, IOException, XMLStreamException;
51  
52      public static final class Parser {
53          /**
54           * System ID of the document being parsed.
55           */
56          public final URL systemId;
57          /**
58           * The parser instance parsing the infoset.
59           */
60          public final XMLStreamReader parser;
61  
62          public Parser(URL systemId, XMLStreamReader parser) {
63              assert parser!=null;
64              this.systemId = systemId;
65              this.parser = parser;
66          }
67  
68          /**
69           * Creates a {@link Parser} that reads from {@link SDDocumentSource}.
70           */
71          public Parser(SDDocumentSource doc) throws IOException, XMLStreamException {
72              this.systemId = doc.getSystemId();
73              this.parser = doc.read();
74          }
75  
76      }
77  }