All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.xml.ws.api.server.DocumentAddressResolver Maven / Gradle / Ivy

/*
 * Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

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); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy