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: import com.sun.istack.Nullable;
41:
42: import javax.xml.namespace.QName;
43:
44: /**
45: * Resolves port address for an endpoint. A WSDL may contain multiple
46: * endpoints, and some of the endpoints may be packaged in a single WAR file.
47: * If an endpoint is serving the WSDL, it would be nice to fill the port addresses
48: * of other endpoints in the WAR.
49: *
50: * <p>
51: * This interface is implemented by the caller of
52: * {@link SDDocument#writeTo} method so
53: * that the {@link SDDocument} can correctly fills the addresses of known
54: * endpoints.
55: *
56: *
57: * @author Jitendra Kotamraju
58: */
59: public abstract class PortAddressResolver {
60: /**
61: * Gets the endpoint address for a WSDL port
62: *
63: * @param serviceName
64: * WSDL service name(wsd:service in WSDL) for which address is needed. Always non-null.
65: * @param portName
66: * WSDL port name(wsdl:port in WSDL) for which address is needed. Always non-null.
67: * @return
68: * The address needs to be put in WSDL for port element's location
69: * attribute. Can be null. If it is null, existing port address
70: * is written as it is (without any patching).
71: */
72: public abstract @Nullable
73: String getAddressFor(@NotNull
74: QName serviceName, @NotNull
75: String portName);
76: }
|