javax.xml.ws.spi.http.HttpContext 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.spi.http;
import javax.xml.ws.Endpoint;
import java.util.Set;
/**
* HttpContext represents a mapping between the root URI path of a web
* service to a {@link HttpHandler} which is invoked to handle requests
* destined for that path on the associated container.
*
* Container provides the implementation for this and it matches
* web service requests to corresponding HttpContext objects.
*
* @author Jitendra Kotamraju
* @since 1.7, JAX-WS 2.2
*/
public abstract class HttpContext {
/**
* The handler to set for this context.
*/
protected HttpHandler handler;
/**
* JAX-WS runtime sets its handler during
* {@link Endpoint#publish(HttpContext)} to handle
* HTTP requests for this context. Container or its extensions
* use this handler to process the requests.
*
* @param handler the handler to set for this context
*/
public void setHandler(HttpHandler handler) {
this.handler = handler;
}
/**
* Returns the path for this context. This path uniquely identifies
* an endpoint inside an application and the path is relative to
* application's context path. Container should give this
* path based on how it matches request URIs to this HttpContext object.
*
*
* For servlet container, this is typically a url-pattern for an endpoint.
*
*
* Endpoint's address for this context can be computed as follows:
*
* HttpExchange exch = ...;
* String endpointAddress =
* exch.getScheme() + "://"
* + exch.getLocalAddress().getHostName()
* + ":" + exch.getLocalAddress().getPort()
* + exch.getContextPath() + getPath();
*
*
* @return this context's path
*/
public abstract String getPath();
/**
* Returns an attribute value for container's configuration
* and other data that can be used by jax-ws runtime.
*
* @param name attribute name
* @return attribute value
*/
public abstract Object getAttribute(String name);
/**
* Returns all attribute names for container's configuration
* and other data that can be used by jax-ws runtime.
*
* @return set of all attribute names
*/
public abstract Set getAttributeNames();
}