1 /*

     2  * Copyright (c) 2009, 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 javax.xml.stream;

    27 

    28 /**

    29  * This interface is used to resolve resources during an XML parse.  If an application wishes to

    30  * perform custom entity resolution it must register an instance of this interface with

    31  * the XMLInputFactory using the setXMLResolver method.

    32  *

    33  * @version 1.0

    34  * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.

    35  * @since 1.6

    36  */

    37 public interface XMLResolver {

    38 

    39   /**

    40    * Retrieves a resource.  This resource can be of the following three return types:

    41    * (1) java.io.InputStream (2) javax.xml.stream.XMLStreamReader (3) java.xml.stream.XMLEventReader.

    42    * If this method returns null the processor will attempt to resolve the entity using its

    43    * default mechanism.

    44    *

    45    * @param publicID The public identifier of the external entity being referenced, or null if none was supplied.

    46    * @param systemID The system identifier of the external entity being referenced.

    47    * @param baseURI  Absolute base URI associated with systemId.

    48    * @param namespace The namespace of the entity to resolve.

    49    * @return The resource requested or null.

    50    * @throws XMLStreamException if there was a failure attempting to resolve the resource.

    51    */

    52   public Object resolveEntity(String publicID,

    53                               String systemID,

    54                               String baseURI,

    55                               String namespace)

    56     throws XMLStreamException;

    57 }