01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.ws.api.server;
38:
39: import com.sun.istack.NotNull;
40: import com.sun.istack.Nullable;
41:
42: /**
43: * Resolves relative references among {@link SDDocument}s.
44: *
45: * <p>
46: * This interface is implemented by the caller of
47: * {@link SDDocument#writeTo} method so
48: * that the {@link SDDocument} can correctly produce references
49: * to other documents.
50: *
51: * <p>
52: * This mechanism allows the user of {@link WSEndpoint} to
53: * assign logical URLs to each {@link SDDocument} (which is often
54: * necessarily done in a transport-dependent way), and then
55: * serve description documents.
56: *
57: *
58: *
59: * <h2>Usage Example 1</h2>
60: * <p>
61: * HTTP servlet transport chose to expose those metadata documents
62: * to HTTP GET requests where each {@link SDDocument} is identified
63: * by a simple query string "?<i>ID</i>". (HTTP servlet transport
64: * assigns such IDs by itself.)
65: *
66: * <p>
67: * In this nameing scheme, when {@link SDDocument} X refers to
68: * {@link SDDocument} Y, it can put a reference as "?<i>IDofY</i>".
69: * By implementing {@link DocumentAddressResolver} it can do so.
70: *
71: * @author Kohsuke Kawaguchi
72: */
73: public interface DocumentAddressResolver {
74: /**
75: * Produces a relative reference from one document to another.
76: *
77: * @param current
78: * The document that is being generated.
79: * @param referenced
80: * The document that is referenced.
81: * @return
82: * The reference to be put inside {@code current} to refer to
83: * {@code referenced}. This can be a relative URL as well as
84: * an absolute. If null is returned, then the {@link SDDocument}
85: * will produce a "implicit reference" (for example, <xs:import>
86: * without the @schemaLocation attribute, etc).
87: */
88: @Nullable
89: String getRelativeAddressFor(@NotNull
90: SDDocument current, @NotNull
91: SDDocument referenced);
92: }
|