src/share/jaxws_classes/com/sun/xml/internal/ws/wsdl/writer/DocumentLocationResolver.java

changeset 0
373ffda63c9a
child 637
9c07ef4934dd
equal deleted inserted replaced
-1:000000000000 0:373ffda63c9a
1 /*
2 * Copyright (c) 1997, 2012, 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 com.sun.xml.internal.ws.wsdl.writer;
27
28 import com.sun.istack.internal.Nullable;
29 import com.sun.xml.internal.ws.api.server.SDDocument;
30
31 /**
32 * Resolves relative references among the metadata(WSDL, schema)
33 * documents.
34 *
35 * <p>
36 * This interface is implemented by the caller of
37 * {@link SDDocument#writeTo} method so that the {@link SDDocument} can
38 * correctly produce references to other documents.
39 *
40 * <h2>Usage Example 1</h2>
41 * <p>
42 * Say: http://localhost/hello?wsdl has reference to
43 * <p>
44 * &lt;xsd:import namespace="urn:test:types" schemaLocation="http://localhost/hello?xsd=1"/>
45 *
46 * <p>
47 * Using this class, it is possible to write A.wsdl to a local filesystem with
48 * a local file schema import.
49 * <p>
50 * &lt;xsd:import namespace="urn:test:types" schemaLocation="hello.xsd"/>
51 *
52 * @author Jitendra Kotamraju
53 */
54 public interface DocumentLocationResolver {
55 /**
56 * Produces a relative reference from one document to another.
57 *
58 * @param namespaceURI
59 * The namespace urI for the referenced document.
60 * for e.g. wsdl:import/@namespace, xsd:import/@namespace
61 * @param systemId
62 * The location value for the referenced document.
63 * for e.g. wsdl:import/@location, xsd:import/@schemaLocation
64 * @return
65 * The reference to be put inside {@code current} to refer to
66 * {@code referenced}. This can be a relative URL as well as
67 * an absolute. If null is returned, then the document
68 * will produce a "implicit reference" (for example, &lt;xs:import>
69 * without the @schemaLocation attribute, etc).
70 */
71 @Nullable String getLocationFor(String namespaceURI, String systemId);
72 }

mercurial