aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.ws.wsdl.writer;
aoqi@0: 
aoqi@0: import com.sun.istack.internal.Nullable;
aoqi@0: import com.sun.xml.internal.ws.api.server.SDDocument;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Resolves relative references among the metadata(WSDL, schema)
aoqi@0:  * documents.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This interface is implemented by the caller of
aoqi@0:  * {@link SDDocument#writeTo} method so that the {@link SDDocument} can
aoqi@0:  * correctly produce references to other documents.
aoqi@0:  *
aoqi@0:  * <h2>Usage Example 1</h2>
aoqi@0:  * <p>
aoqi@0:  * Say: http://localhost/hello?wsdl has reference to
aoqi@0:  * <p>
aoqi@0:  *   &lt;xsd:import namespace="urn:test:types" schemaLocation="http://localhost/hello?xsd=1"/>
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * Using this class, it is possible to write A.wsdl to a local filesystem with
aoqi@0:  * a local file schema import.
aoqi@0:  * <p>
aoqi@0:  *   &lt;xsd:import namespace="urn:test:types" schemaLocation="hello.xsd"/>
aoqi@0:  *
aoqi@0:  * @author Jitendra Kotamraju
aoqi@0:  */
aoqi@0: public interface DocumentLocationResolver {
aoqi@0:     /**
aoqi@0:      * Produces a relative reference from one document to another.
aoqi@0:      *
aoqi@0:      * @param namespaceURI
aoqi@0:      *      The namespace urI for the referenced document.
aoqi@0:      *      for e.g. wsdl:import/@namespace, xsd:import/@namespace
aoqi@0:      * @param systemId
aoqi@0:      *      The location value for the referenced document.
aoqi@0:      *      for e.g. wsdl:import/@location, xsd:import/@schemaLocation
aoqi@0:      * @return
aoqi@0:      *      The reference to be put inside {@code current} to refer to
aoqi@0:      *      {@code referenced}. This can be a relative URL as well as
aoqi@0:      *      an absolute. If null is returned, then the document
aoqi@0:      *      will produce a "implicit reference" (for example, &lt;xs:import>
aoqi@0:      *      without the @schemaLocation attribute, etc).
aoqi@0:      */
aoqi@0:     @Nullable String getLocationFor(String namespaceURI, String systemId);
aoqi@0: }