com.sun.xml.ws.api.server.DocumentAddressResolver Maven / Gradle / Ivy
Show all versions of webservices-rt Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.api.server;
import com.sun.istack.NotNull;
import com.sun.istack.Nullable;
/**
* Resolves relative references among {@link SDDocument}s.
*
*
* This interface is implemented by the caller of
* {@link SDDocument#writeTo} method so
* that the {@link SDDocument} can correctly produce references
* to other documents.
*
*
* This mechanism allows the user of {@link WSEndpoint} to
* assign logical URLs to each {@link SDDocument} (which is often
* necessarily done in a transport-dependent way), and then
* serve description documents.
*
*
*
*
Usage Example 1
*
* HTTP servlet transport chose to expose those metadata documents
* to HTTP GET requests where each {@link SDDocument} is identified
* by a simple query string "?ID". (HTTP servlet transport
* assigns such IDs by itself.)
*
*
* In this nameing scheme, when {@link SDDocument} X refers to
* {@link SDDocument} Y, it can put a reference as "?IDofY".
* By implementing {@link DocumentAddressResolver} it can do so.
*
* @author Kohsuke Kawaguchi
*/
public interface DocumentAddressResolver {
/**
* Produces a relative reference from one document to another.
*
* @param current
* The document that is being generated.
* @param referenced
* The document that is referenced.
* @return
* The reference to be put inside {@code current} to refer to
* {@code referenced}. This can be a relative URL as well as
* an absolute. If null is returned, then the {@link SDDocument}
* will produce a "implicit reference" (for example, <xs:import>
* without the @schemaLocation attribute, etc).
*/
@Nullable String getRelativeAddressFor(@NotNull SDDocument current, @NotNull SDDocument referenced);
}