src/share/jaxws_classes/com/sun/xml/internal/ws/api/server/BoundEndpoint.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 637
9c07ef4934dd
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286 1 /*
alanb@368 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package com.sun.xml.internal.ws.api.server;
ohair@286 27
ohair@286 28 import com.sun.istack.internal.NotNull;
ohair@286 29 import com.sun.xml.internal.ws.api.Component;
ohair@286 30
ohair@286 31 import java.net.URI;
ohair@286 32
ohair@286 33 /**
ohair@286 34 * Represents the {@link WSEndpoint} bound to a particular transport.
ohair@286 35 *
ohair@286 36 * @see Module#getBoundEndpoints()
ohair@286 37 * @author Kohsuke Kawaguchi
ohair@286 38 */
ohair@286 39 public interface BoundEndpoint extends Component {
ohair@286 40 /**
ohair@286 41 * The endpoint that was bound.
ohair@286 42 *
ohair@286 43 * <p>
ohair@286 44 * Multiple {@link BoundEndpoint}s may point to the same {@link WSEndpoint},
ohair@286 45 * if it's bound to multiple transports.
ohair@286 46 *
ohair@286 47 * @return the endpoint
ohair@286 48 */
ohair@286 49 @NotNull WSEndpoint getEndpoint();
ohair@286 50
ohair@286 51 /**
ohair@286 52 * The address of the bound endpoint.
ohair@286 53 *
ohair@286 54 * <p>
ohair@286 55 * For example, if this endpoint is bound to a servlet endpoint
ohair@286 56 * "http://foobar/myapp/myservice", then this method should
ohair@286 57 * return that address.
ohair@286 58 *
ohair@286 59 * @return address of the endpoint
ohair@286 60 */
ohair@286 61 @NotNull URI getAddress();
ohair@286 62
ohair@286 63 /**
ohair@286 64 * The address of the bound endpoint using the base address. Often
ohair@286 65 * times, baseAddress is only avaialble during the request.
ohair@286 66 *
ohair@286 67 * <p>
ohair@286 68 * If the endpoint is bound to a servlet endpoint, the base address
ohair@286 69 * won't include the url-pattern, so the base address would be
ohair@286 70 * "http://host:port/context". This method would include url-pattern
ohair@286 71 * for the endpoint and return that address
ohair@286 72 * for e.g. "http://host:port/context/url-pattern"
ohair@286 73 *
ohair@286 74 * @param baseAddress that is used in computing the full address
ohair@286 75 * @return address of the endpoint
ohair@286 76 */
ohair@286 77 @NotNull URI getAddress(String baseAddress);
ohair@286 78 }

mercurial