1 /*
   2  * Copyright (c) 2015, 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 package javax.xml.catalog;
  26 
  27 import javax.xml.transform.Source;
  28 import javax.xml.transform.URIResolver;
  29 
  30 /**
  31  * A JAXP URIResolver that uses catalogs to resolve references.
  32  *
  33  * @since 9
  34  */
  35 public interface CatalogUriResolver extends URIResolver {
  36 
  37     /**
  38      * The method searches through the catalog entries in the main and
  39      * alternative catalogs to attempt to find a match with the specified URI.
  40      *
  41      * @param href an href attribute, which may be relative or absolute
  42      * @param base The base URI against which the href attribute will be made
  43      * absolute if the absolute URI is required
  44      *
  45      * @return a {@link javax.xml.transform.Source} object if a mapping is found.
  46      * If no mapping is found, returns an empty {@link javax.xml.transform.Source}
  47      * object if the {@code javax.xml.catalog.resolve} property is set to
  48      * {@code ignore};
  49      * returns a {@link javax.xml.transform.Source} object with the original URI
  50      * (href, or href resolved with base if base is not null) if the
  51      * {@code javax.xml.catalog.resolve} property is set to {@code continue}.
  52      *
  53      * @throws CatalogException if no mapping is found and
  54      * {@code javax.xml.catalog.resolve} is specified as strict
  55      */
  56     @Override
  57     public Source resolve(String href, String base);
  58 }