Mercurial > jdk8-mips64-public > jaxws / file diff

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/ws/wsdl/writer/DocumentLocationResolver.java	Wed Apr 27 01:27:09 2016 +0800
     1.3 @@ -0,0 +1,72 @@
     1.4 +/*
     1.5 + * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package com.sun.xml.internal.ws.wsdl.writer;
    1.30 +
    1.31 +import com.sun.istack.internal.Nullable;
    1.32 +import com.sun.xml.internal.ws.api.server.SDDocument;
    1.33 +
    1.34 +/**
    1.35 + * Resolves relative references among the metadata(WSDL, schema)
    1.36 + * documents.
    1.37 + *
    1.38 + * <p>
    1.39 + * This interface is implemented by the caller of
    1.40 + * {@link SDDocument#writeTo} method so that the {@link SDDocument} can
    1.41 + * correctly produce references to other documents.
    1.42 + *
    1.43 + * <h2>Usage Example 1</h2>
    1.44 + * <p>
    1.45 + * Say: http://localhost/hello?wsdl has reference to
    1.46 + * <p>
    1.47 + *   &lt;xsd:import namespace="urn:test:types" schemaLocation="http://localhost/hello?xsd=1"/>
    1.48 + *
    1.49 + * <p>
    1.50 + * Using this class, it is possible to write A.wsdl to a local filesystem with
    1.51 + * a local file schema import.
    1.52 + * <p>
    1.53 + *   &lt;xsd:import namespace="urn:test:types" schemaLocation="hello.xsd"/>
    1.54 + *
    1.55 + * @author Jitendra Kotamraju
    1.56 + */
    1.57 +public interface DocumentLocationResolver {
    1.58 +    /**
    1.59 +     * Produces a relative reference from one document to another.
    1.60 +     *
    1.61 +     * @param namespaceURI
    1.62 +     *      The namespace urI for the referenced document.
    1.63 +     *      for e.g. wsdl:import/@namespace, xsd:import/@namespace
    1.64 +     * @param systemId
    1.65 +     *      The location value for the referenced document.
    1.66 +     *      for e.g. wsdl:import/@location, xsd:import/@schemaLocation
    1.67 +     * @return
    1.68 +     *      The reference to be put inside {@code current} to refer to
    1.69 +     *      {@code referenced}. This can be a relative URL as well as
    1.70 +     *      an absolute. If null is returned, then the document
    1.71 +     *      will produce a "implicit reference" (for example, &lt;xs:import>
    1.72 +     *      without the @schemaLocation attribute, etc).
    1.73 +     */
    1.74 +    @Nullable String getLocationFor(String namespaceURI, String systemId);
    1.75 +}