com.sun.xml.ws.api.server.PortAddressResolver Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at https://glassfish.dev.java.net/public/CDDLv1.0.html.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2006 Sun Microsystems Inc. All Rights Reserved
*/
package com.sun.xml.ws.api.server;
import com.sun.istack.NotNull;
import com.sun.istack.Nullable;
import javax.xml.namespace.QName;
/**
* Resolves port address for an endpoint. A WSDL may contain multiple
* endpoints, and some of the endpoints may be packaged in a single WAR file.
* If an endpoint is serving the WSDL, it would be nice to fill the port addresses
* of other endpoints in the WAR.
*
*
* This interface is implemented by the caller of
* {@link SDDocument#writeTo} method so
* that the {@link SDDocument} can correctly fills the addresses of known
* endpoints.
*
*
* @author Jitendra Kotamraju
*/
public abstract class PortAddressResolver {
/**
* Gets the endpoint address for a WSDL port
*
* @param serviceName
* WSDL service name(wsd:service in WSDL) for which address is needed. Always non-null.
* @param portName
* WSDL port name(wsdl:port in WSDL) for which address is needed. Always non-null.
* @return
* The address needs to be put in WSDL for port element's location
* attribute. Can be null. If it is null, existing port address
* is written as it is (without any patching).
*/
public abstract @Nullable String getAddressFor(@NotNull QName serviceName, @NotNull String portName);
}