- java.lang.Object
-
- javax.xml.ws.spi.http.HttpContext
-
public abstract class HttpContext extends Object
HttpContext represents a mapping between the root URI path of a web service to aHttpHandler
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.
- Since:
- JAX-WS 2.2
-
-
Field Summary
Fields Modifier and Type Field and Description protected HttpHandler
handler
-
Constructor Summary
Constructors Constructor and Description HttpContext()
-
Method Summary
Methods Modifier and Type Method and Description abstract Object
getAttribute(String name)
Returns an attribute value for container's configuration and other data that can be used by jax-ws runtime.abstract Set<String>
getAttributeNames()
Returns all attribute names for container's configuration and other data that can be used by jax-ws runtime.abstract String
getPath()
Returns the path for this context.void
setHandler(HttpHandler handler)
JAX-WS runtime sets its handler duringEndpoint.publish(HttpContext)
to handle HTTP requests for this context.
-
-
-
Field Detail
-
handler
protected HttpHandler handler
-
-
Method Detail
-
setHandler
public void setHandler(HttpHandler handler)
JAX-WS runtime sets its handler duringEndpoint.publish(HttpContext)
to handle HTTP requests for this context. Container or its extensions use this handler to process the requests.- Parameters:
handler
- the handler to set for this context
-
getPath
public abstract String getPath()
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();
- Returns:
- this context's path
-
getAttribute
public abstract Object getAttribute(String name)
Returns an attribute value for container's configuration and other data that can be used by jax-ws runtime.- Parameters:
name
- attribute name- Returns:
- attribute value
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/xml/ws/spi/http/HttpContext.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.