javax.xml.ws.EndpointContext Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2009-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.ws;
import java.util.Set;
/**
* {@code EndpointContext} allows multiple endpoints in an application
* to share any information. For example, servlet application's war may
* contain multiple endpoints and these endpoints can get addresses of each
* other by sharing this context. If multiple endpoints share different
* ports of a WSDL, then the multiple port addresses can be patched
* when the WSDL is accessed. It also allows all endpoints to share any
* other runtime information.
*
*
* This needs to be set by using {@link Endpoint#setEndpointContext}
* before {@link Endpoint#publish} methods.
*
* @author Jitendra Kotamraju
* @since 1.7, JAX-WS 2.2
*/
public abstract class EndpointContext {
/**
* This gives list of endpoints in an application. For e.g in
* servlet container, a war file may contain multiple endpoints.
* In case of http, these endpoints are hosted on the same http
* server.
*
* @return list of all endpoints in an application
*/
public abstract Set getEndpoints();
}