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:
41: import java.net.URI;
42:
43: /**
44: * Represents the {@link WSEndpoint} bound to a particular transport.
45: *
46: * @see Module#getBoundEndpoints()
47: * @author Kohsuke Kawaguchi
48: */
49: public interface BoundEndpoint {
50: /**
51: * The endpoint that was bound.
52: *
53: * <p>
54: * Multiple {@link BoundEndpoint}s may point to the same {@link WSEndpoint},
55: * if it's bound to multiple transports.
56: *
57: * @return the endpoint
58: */
59: @NotNull
60: WSEndpoint getEndpoint();
61:
62: /**
63: * The address of the bound endpoint.
64: *
65: * <p>
66: * For example, if this endpoint is bound to a servlet endpoint
67: * "http://foobar/myapp/myservice", then this method should
68: * return that address.
69: *
70: * @return address of the endpoint
71: */
72: @NotNull
73: URI getAddress();
74:
75: /**
76: * The address of the bound endpoint using the base address. Often
77: * times, baseAddress is only avaialble during the request.
78: *
79: * <p>
80: * If the endpoint is bound to a servlet endpoint, the base address
81: * won't include the url-pattern, so the base address would be
82: * "http://host:port/context". This method would include url-pattern
83: * for the endpoint and return that address
84: * for e.g. "http://host:port/context/url-pattern"
85: *
86: * @param baseAddress that is used in computing the full address
87: * @return address of the endpoint
88: */
89: @NotNull
90: URI getAddress(String baseAddress);
91: }
|