jdk8-mips64-public/jaxws: src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/BoundEndpoint.java@9c07ef4934dd

     1 /*

     2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    26 package com.sun.xml.internal.ws.api.server;

    28 import com.sun.istack.internal.NotNull;

    29 import com.sun.xml.internal.ws.api.Component;

    31 import java.net.URI;

    33 /**

    34  * Represents the {@link WSEndpoint} bound to a particular transport.

    35  *

    36  * @see Module#getBoundEndpoints()

    37  * @author Kohsuke Kawaguchi

    38  */

    39 public interface BoundEndpoint extends Component {

    40     /**

    41      * The endpoint that was bound.

    42      *

    43      * <p>

    44      * Multiple {@link BoundEndpoint}s may point to the same {@link WSEndpoint},

    45      * if it's bound to multiple transports.

    46      *

    47      * @return the endpoint

    48      */

    49     @NotNull WSEndpoint getEndpoint();

    51     /**

    52      * The address of the bound endpoint.

    53      *

    54      * <p>

    55      * For example, if this endpoint is bound to a servlet endpoint

    56      * "http://foobar/myapp/myservice", then this method should

    57      * return that address.

    58      *

    59      * @return address of the endpoint

    60      */

    61     @NotNull URI getAddress();

    63     /**

    64      * The address of the bound endpoint using the base address. Often

    65      * times, baseAddress is only avaialble during the request.

    66      *

    67      * <p>

    68      * If the endpoint is bound to a servlet endpoint, the base address

    69      * won't include the url-pattern, so the base address would be

    70      * "http://host:port/context". This method would include url-pattern

    71      * for the endpoint and return that address

    72      * for e.g. "http://host:port/context/url-pattern"

    73      *

    74      * @param baseAddress that is used in computing the full address

    75      * @return address of the endpoint

    76      */

    77     @NotNull URI getAddress(String baseAddress);

    78 }

Mercurial > jdk8-mips64-public > jaxws / file revision