Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/DocumentAddressResolver.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/DocumentAddressResolver.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.api.server; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import com.sun.istack.internal.NotNull; |
| aoqi@0 | 29 | import com.sun.istack.internal.Nullable; |
| aoqi@0 | 30 | |
| aoqi@0 | 31 | /** |
| aoqi@0 | 32 | * Resolves relative references among {@link SDDocument}s. |
| aoqi@0 | 33 | * |
| aoqi@0 | 34 | * <p> |
| aoqi@0 | 35 | * This interface is implemented by the caller of |
| aoqi@0 | 36 | * {@link SDDocument#writeTo} method so |
| aoqi@0 | 37 | * that the {@link SDDocument} can correctly produce references |
| aoqi@0 | 38 | * to other documents. |
| aoqi@0 | 39 | * |
| aoqi@0 | 40 | * <p> |
| aoqi@0 | 41 | * This mechanism allows the user of {@link WSEndpoint} to |
| aoqi@0 | 42 | * assign logical URLs to each {@link SDDocument} (which is often |
| aoqi@0 | 43 | * necessarily done in a transport-dependent way), and then |
| aoqi@0 | 44 | * serve description documents. |
| aoqi@0 | 45 | * |
| aoqi@0 | 46 | * |
| aoqi@0 | 47 | * |
| aoqi@0 | 48 | * <h2>Usage Example 1</h2> |
| aoqi@0 | 49 | * <p> |
| aoqi@0 | 50 | * HTTP servlet transport chose to expose those metadata documents |
| aoqi@0 | 51 | * to HTTP GET requests where each {@link SDDocument} is identified |
| aoqi@0 | 52 | * by a simple query string "?<i>ID</i>". (HTTP servlet transport |
| aoqi@0 | 53 | * assigns such IDs by itself.) |
| aoqi@0 | 54 | * |
| aoqi@0 | 55 | * <p> |
| aoqi@0 | 56 | * In this nameing scheme, when {@link SDDocument} X refers to |
| aoqi@0 | 57 | * {@link SDDocument} Y, it can put a reference as "?<i>IDofY</i>". |
| aoqi@0 | 58 | * By implementing {@link DocumentAddressResolver} it can do so. |
| aoqi@0 | 59 | * |
| aoqi@0 | 60 | * @author Kohsuke Kawaguchi |
| aoqi@0 | 61 | */ |
| aoqi@0 | 62 | public interface DocumentAddressResolver { |
| aoqi@0 | 63 | /** |
| aoqi@0 | 64 | * Produces a relative reference from one document to another. |
| aoqi@0 | 65 | * |
| aoqi@0 | 66 | * @param current |
| aoqi@0 | 67 | * The document that is being generated. |
| aoqi@0 | 68 | * @param referenced |
| aoqi@0 | 69 | * The document that is referenced. |
| aoqi@0 | 70 | * @return |
| aoqi@0 | 71 | * The reference to be put inside {@code current} to refer to |
| aoqi@0 | 72 | * {@code referenced}. This can be a relative URL as well as |
| aoqi@0 | 73 | * an absolute. If null is returned, then the {@link SDDocument} |
| aoqi@0 | 74 | * will produce a "implicit reference" (for example, <xs:import> |
| aoqi@0 | 75 | * without the @schemaLocation attribute, etc). |
| aoqi@0 | 76 | */ |
| aoqi@0 | 77 | @Nullable String getRelativeAddressFor(@NotNull SDDocument current, @NotNull SDDocument referenced); |
| aoqi@0 | 78 | } |
