1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * This code is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 only, as
6 * published by the Free Software Foundation. Oracle designates this
7 * particular file as subject to the "Classpath" exception as provided
8 * by Oracle in the LICENSE file that accompanied this code.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 */
24
25 /*
26 * This file is available under and governed by the GNU General Public
27 * License version 2 only, as published by the Free Software Foundation.
28 * However, the following notice accompanied the original version of this
29 * file and, per its terms, should not be removed:
30 *
31 * Copyright (c) 2004 World Wide Web Consortium,
32 *
33 * (Massachusetts Institute of Technology, European Research Consortium for
34 * Informatics and Mathematics, Keio University). All Rights Reserved. This
35 * work is distributed under the W3C(r) Software License [1] in the hope that
36 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
37 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
38 *
39 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
40 */
41
42 package org.w3c.dom.ls;
43
44 /**
45 * <code>LSResourceResolver</code> provides a way for applications to
46 * redirect references to external resources.
47 * <p> Applications needing to implement custom handling for external
48 * resources can implement this interface and register their implementation
49 * by setting the "resource-resolver" parameter of
50 * <code>DOMConfiguration</code> objects attached to <code>LSParser</code>
51 * and <code>LSSerializer</code>. It can also be register on
52 * <code>DOMConfiguration</code> objects attached to <code>Document</code>
53 * if the "LS" feature is supported.
54 * <p> The <code>LSParser</code> will then allow the application to intercept
55 * any external entities, including the external DTD subset and external
56 * parameter entities, before including them. The top-level document entity
57 * is never passed to the <code>resolveResource</code> method.
58 * <p> Many DOM applications will not need to implement this interface, but it
59 * will be especially useful for applications that build XML documents from
60 * databases or other specialized input sources, or for applications that
61 * use URNs.
62 * <p ><b>Note:</b> <code>LSResourceResolver</code> is based on the SAX2 [<a href='http://www.saxproject.org/'>SAX</a>] <code>EntityResolver</code>
63 * interface.
64 * <p>See also the <a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-LS-20040407'>Document Object Model (DOM) Level 3 Load
65 and Save Specification</a>.
66 *
67 * @since 1.5
68 */
69 public interface LSResourceResolver {
70 /**
71 * Allow the application to resolve external resources.
72 * <br> The <code>LSParser</code> will call this method before opening any
73 * external resource, including the external DTD subset, external
74 * entities referenced within the DTD, and external entities referenced
75 * within the document element (however, the top-level document entity
76 * is not passed to this method). The application may then request that
77 * the <code>LSParser</code> resolve the external resource itself, that
78 * it use an alternative URI, or that it use an entirely different input
79 * source.
80 * <br> Application writers can use this method to redirect external
81 * system identifiers to secure and/or local URI, to look up public
82 * identifiers in a catalogue, or to read an entity from a database or
83 * other input source (including, for example, a dialog box).
84 * @param type The type of the resource being resolved. For XML [<a href='http://www.w3.org/TR/2004/REC-xml-20040204'>XML 1.0</a>] resources
85 * (i.e. entities), applications must use the value
86 * <code>"http://www.w3.org/TR/REC-xml"</code>. For XML Schema [<a href='http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/'>XML Schema Part 1</a>]
87 * , applications must use the value
88 * <code>"http://www.w3.org/2001/XMLSchema"</code>. Other types of
89 * resources are outside the scope of this specification and therefore
90 * should recommend an absolute URI in order to use this method.
91 * @param namespaceURI The namespace of the resource being resolved,
92 * e.g. the target namespace of the XML Schema [<a href='http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/'>XML Schema Part 1</a>]
93 * when resolving XML Schema resources.
94 * @param publicId The public identifier of the external entity being
95 * referenced, or <code>null</code> if no public identifier was
96 * supplied or if the resource is not an entity.
97 * @param systemId The system identifier, a URI reference [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>], of the
98 * external resource being referenced, or <code>null</code> if no
99 * system identifier was supplied.
100 * @param baseURI The absolute base URI of the resource being parsed, or
101 * <code>null</code> if there is no base URI.
102 * @return A <code>LSInput</code> object describing the new input
103 * source, or <code>null</code> to request that the parser open a
104 * regular URI connection to the resource.
105 */
106 public LSInput resolveResource(String type,
107 String namespaceURI,
108 String publicId,
109 String systemId,
110 String baseURI);
111
112 }