Thu, 31 Aug 2017 15:18:52 +0800
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.xml.internal.ws.api.Component; |
aoqi@0 | 30 | |
aoqi@0 | 31 | import java.net.URI; |
aoqi@0 | 32 | |
aoqi@0 | 33 | /** |
aoqi@0 | 34 | * Represents the {@link WSEndpoint} bound to a particular transport. |
aoqi@0 | 35 | * |
aoqi@0 | 36 | * @see Module#getBoundEndpoints() |
aoqi@0 | 37 | * @author Kohsuke Kawaguchi |
aoqi@0 | 38 | */ |
aoqi@0 | 39 | public interface BoundEndpoint extends Component { |
aoqi@0 | 40 | /** |
aoqi@0 | 41 | * The endpoint that was bound. |
aoqi@0 | 42 | * |
aoqi@0 | 43 | * <p> |
aoqi@0 | 44 | * Multiple {@link BoundEndpoint}s may point to the same {@link WSEndpoint}, |
aoqi@0 | 45 | * if it's bound to multiple transports. |
aoqi@0 | 46 | * |
aoqi@0 | 47 | * @return the endpoint |
aoqi@0 | 48 | */ |
aoqi@0 | 49 | @NotNull WSEndpoint getEndpoint(); |
aoqi@0 | 50 | |
aoqi@0 | 51 | /** |
aoqi@0 | 52 | * The address of the bound endpoint. |
aoqi@0 | 53 | * |
aoqi@0 | 54 | * <p> |
aoqi@0 | 55 | * For example, if this endpoint is bound to a servlet endpoint |
aoqi@0 | 56 | * "http://foobar/myapp/myservice", then this method should |
aoqi@0 | 57 | * return that address. |
aoqi@0 | 58 | * |
aoqi@0 | 59 | * @return address of the endpoint |
aoqi@0 | 60 | */ |
aoqi@0 | 61 | @NotNull URI getAddress(); |
aoqi@0 | 62 | |
aoqi@0 | 63 | /** |
aoqi@0 | 64 | * The address of the bound endpoint using the base address. Often |
aoqi@0 | 65 | * times, baseAddress is only avaialble during the request. |
aoqi@0 | 66 | * |
aoqi@0 | 67 | * <p> |
aoqi@0 | 68 | * If the endpoint is bound to a servlet endpoint, the base address |
aoqi@0 | 69 | * won't include the url-pattern, so the base address would be |
aoqi@0 | 70 | * "http://host:port/context". This method would include url-pattern |
aoqi@0 | 71 | * for the endpoint and return that address |
aoqi@0 | 72 | * for e.g. "http://host:port/context/url-pattern" |
aoqi@0 | 73 | * |
aoqi@0 | 74 | * @param baseAddress that is used in computing the full address |
aoqi@0 | 75 | * @return address of the endpoint |
aoqi@0 | 76 | */ |
aoqi@0 | 77 | @NotNull URI getAddress(String baseAddress); |
aoqi@0 | 78 | } |