325N/A/*
325N/A * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage com.sun.xml.internal.ws.api.server;
325N/A
325N/Aimport com.sun.istack.internal.NotNull;
325N/Aimport com.sun.istack.internal.Nullable;
325N/A
325N/A/**
325N/A * Resolves relative references among {@link SDDocument}s.
325N/A *
325N/A * <p>
325N/A * This interface is implemented by the caller of
325N/A * {@link SDDocument#writeTo} method so
325N/A * that the {@link SDDocument} can correctly produce references
325N/A * to other documents.
325N/A *
325N/A * <p>
325N/A * This mechanism allows the user of {@link WSEndpoint} to
325N/A * assign logical URLs to each {@link SDDocument} (which is often
325N/A * necessarily done in a transport-dependent way), and then
325N/A * serve description documents.
325N/A *
325N/A *
325N/A *
325N/A * <h2>Usage Example 1</h2>
325N/A * <p>
325N/A * HTTP servlet transport chose to expose those metadata documents
325N/A * to HTTP GET requests where each {@link SDDocument} is identified
325N/A * by a simple query string "?<i>ID</i>". (HTTP servlet transport
325N/A * assigns such IDs by itself.)
325N/A *
325N/A * <p>
325N/A * In this nameing scheme, when {@link SDDocument} X refers to
325N/A * {@link SDDocument} Y, it can put a reference as "?<i>IDofY</i>".
325N/A * By implementing {@link DocumentAddressResolver} it can do so.
325N/A *
325N/A * @author Kohsuke Kawaguchi
325N/A */
325N/Apublic interface DocumentAddressResolver {
325N/A /**
325N/A * Produces a relative reference from one document to another.
325N/A *
325N/A * @param current
325N/A * The document that is being generated.
325N/A * @param referenced
325N/A * The document that is referenced.
325N/A * @return
325N/A * The reference to be put inside {@code current} to refer to
325N/A * {@code referenced}. This can be a relative URL as well as
325N/A * an absolute. If null is returned, then the {@link SDDocument}
325N/A * will produce a "implicit reference" (for example, &lt;xs:import>
325N/A * without the @schemaLocation attribute, etc).
325N/A */
325N/A @Nullable String getRelativeAddressFor(@NotNull SDDocument current, @NotNull SDDocument referenced);
325N/A}