001/* 002 * Copyright (c) 2004 World Wide Web Consortium, 003 * 004 * (Massachusetts Institute of Technology, European Research Consortium for 005 * Informatics and Mathematics, Keio University). All Rights Reserved. This 006 * work is distributed under the W3C(r) Software License [1] in the hope that 007 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied 008 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 009 * 010 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231 011 */ 012 013package org.w3c.dom.ls; 014 015/** 016 * <code>LSResourceResolver</code> provides a way for applications to 017 * redirect references to external resources. 018 * <p> Applications needing to implement custom handling for external 019 * resources can implement this interface and register their implementation 020 * by setting the "resource-resolver" parameter of 021 * <code>DOMConfiguration</code> objects attached to <code>LSParser</code> 022 * and <code>LSSerializer</code>. It can also be register on 023 * <code>DOMConfiguration</code> objects attached to <code>Document</code> 024 * if the "LS" feature is supported. 025 * <p> The <code>LSParser</code> will then allow the application to intercept 026 * any external entities, including the external DTD subset and external 027 * parameter entities, before including them. The top-level document entity 028 * is never passed to the <code>resolveResource</code> method. 029 * <p> Many DOM applications will not need to implement this interface, but it 030 * will be especially useful for applications that build XML documents from 031 * databases or other specialized input sources, or for applications that 032 * use URNs. 033 * <p ><b>Note:</b> <code>LSResourceResolver</code> is based on the SAX2 [<a href='http://www.saxproject.org/'>SAX</a>] <code>EntityResolver</code> 034 * interface. 035 * <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 036and Save Specification</a>. 037 */ 038public interface LSResourceResolver { 039 /** 040 * Allow the application to resolve external resources. 041 * <br> The <code>LSParser</code> will call this method before opening any 042 * external resource, including the external DTD subset, external 043 * entities referenced within the DTD, and external entities referenced 044 * within the document element (however, the top-level document entity 045 * is not passed to this method). The application may then request that 046 * the <code>LSParser</code> resolve the external resource itself, that 047 * it use an alternative URI, or that it use an entirely different input 048 * source. 049 * <br> Application writers can use this method to redirect external 050 * system identifiers to secure and/or local URI, to look up public 051 * identifiers in a catalogue, or to read an entity from a database or 052 * other input source (including, for example, a dialog box). 053 * @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 054 * (i.e. entities), applications must use the value 055 * <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>] 056 * , applications must use the value 057 * <code>"http://www.w3.org/2001/XMLSchema"</code>. Other types of 058 * resources are outside the scope of this specification and therefore 059 * should recommend an absolute URI in order to use this method. 060 * @param namespaceURI The namespace of the resource being resolved, 061 * 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>] 062 * when resolving XML Schema resources. 063 * @param publicId The public identifier of the external entity being 064 * referenced, or <code>null</code> if no public identifier was 065 * supplied or if the resource is not an entity. 066 * @param systemId The system identifier, a URI reference [<a href='http://www.ietf.org/rfc/rfc2396.txt'>IETF RFC 2396</a>], of the 067 * external resource being referenced, or <code>null</code> if no 068 * system identifier was supplied. 069 * @param baseURI The absolute base URI of the resource being parsed, or 070 * <code>null</code> if there is no base URI. 071 * @return A <code>LSInput</code> object describing the new input 072 * source, or <code>null</code> to request that the parser open a 073 * regular URI connection to the resource. 074 */ 075 public LSInput resolveResource(String type, 076 String namespaceURI, 077 String publicId, 078 String systemId, 079 String baseURI); 080 081}