• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/com/sun/xml/internal/ws/wsdl/writer/DocumentLocationResolver.java@9c07ef4934dd (annotated)

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

Thu, 31 Aug 2017 15:18:52 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:18:52 +0800

changeset 637

9c07ef4934dd

parent 368

0989ad8c0860

parent 0

373ffda63c9a

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.xml.internal.ws.wsdl.writer;
aoqi@0	27
aoqi@0	28	import com.sun.istack.internal.Nullable;
aoqi@0	29	import com.sun.xml.internal.ws.api.server.SDDocument;
aoqi@0	30
aoqi@0	31	/**
aoqi@0	32	* Resolves relative references among the metadata(WSDL, schema)
aoqi@0	33	* documents.
aoqi@0	34	*
aoqi@0	35	* <p>
aoqi@0	36	* This interface is implemented by the caller of
aoqi@0	37	* {@link SDDocument#writeTo} method so that the {@link SDDocument} can
aoqi@0	38	* correctly produce references to other documents.
aoqi@0	39	*
aoqi@0	40	* <h2>Usage Example 1</h2>
aoqi@0	41	* <p>
aoqi@0	42	* Say: http://localhost/hello?wsdl has reference to
aoqi@0	43	* <p>
aoqi@0	44	* &lt;xsd:import namespace="urn:test:types" schemaLocation="http://localhost/hello?xsd=1"/>
aoqi@0	45	*
aoqi@0	46	* <p>
aoqi@0	47	* Using this class, it is possible to write A.wsdl to a local filesystem with
aoqi@0	48	* a local file schema import.
aoqi@0	49	* <p>
aoqi@0	50	* &lt;xsd:import namespace="urn:test:types" schemaLocation="hello.xsd"/>
aoqi@0	51	*
aoqi@0	52	* @author Jitendra Kotamraju
aoqi@0	53	*/
aoqi@0	54	public interface DocumentLocationResolver {
aoqi@0	55	/**
aoqi@0	56	* Produces a relative reference from one document to another.
aoqi@0	57	*
aoqi@0	58	* @param namespaceURI
aoqi@0	59	* The namespace urI for the referenced document.
aoqi@0	60	* for e.g. wsdl:import/@namespace, xsd:import/@namespace
aoqi@0	61	* @param systemId
aoqi@0	62	* The location value for the referenced document.
aoqi@0	63	* for e.g. wsdl:import/@location, xsd:import/@schemaLocation
aoqi@0	64	* @return
aoqi@0	65	* The reference to be put inside {@code current} to refer to
aoqi@0	66	* {@code referenced}. This can be a relative URL as well as
aoqi@0	67	* an absolute. If null is returned, then the document
aoqi@0	68	* will produce a "implicit reference" (for example, &lt;xs:import>
aoqi@0	69	* without the @schemaLocation attribute, etc).
aoqi@0	70	*/
aoqi@0	71	@Nullable String getLocationFor(String namespaceURI, String systemId);
aoqi@0	72	}