Top Description Fields Constructors Methods
javax.xml.ws.spi.http

public abstract Class HttpContext

extends Object
Class Inheritance
Imports
javax.xml.ws.Endpoint, java.util.Set
HttpContext represents a mapping between the root URI path of a web service to a 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

Field Summary

Modifier and TypeField and Description
protected HttpHandler
handler

The handler to set for this context.

Constructor Summary

AccessConstructor and Description
public
HttpContext()

Method Summary

Modifier and TypeMethod and Description
public abstract Object

Returns:

attribute value
getAttribute(String
attribute name
name)

Returns an attribute value for container's configuration and other data that can be used by jax-ws runtime.

public abstract Set<String>

Returns:

set of all attribute names
getAttributeNames()

Returns all attribute names for container's configuration and other data that can be used by jax-ws runtime.

public abstract String

Returns:

this context's path
getPath()

Returns the path for this context.

public void
setHandler(HttpHandler
the handler to set for this context
handler)

JAX-WS runtime sets its handler during Endpoint#publish(HttpContext) to handle HTTP requests for this context.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

handlerback to summary
protected HttpHandler handler

The handler to set for this context.

Constructor Detail

HttpContextback to summary
public HttpContext()

Method Detail

getAttributeback to summary
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:String

attribute name

Returns:Object

attribute value

getAttributeNamesback to summary
public abstract Set<String> getAttributeNames()

Returns all attribute names for container's configuration and other data that can be used by jax-ws runtime.

Returns:Set<String>

set of all attribute names

getPathback to summary
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:String

this context's path

setHandlerback to summary
public void setHandler(HttpHandler handler)

JAX-WS runtime sets its handler during Endpoint#publish(HttpContext) to handle HTTP requests for this context. Container or its extensions use this handler to process the requests.

Parameters
handler:HttpHandler

the handler to set for this context