public abstract class

HttpContext

extends Object
java.lang.Object
   ↳ com.sun.net.httpserver.HttpContext

Class Overview

HttpContext represents a mapping between the root URI path of an application to a HttpHandler which is invoked to handle requests destined for that path on the associated HttpServer or HttpsServer.

HttpContext instances are created by the create methods in HttpServer and HttpsServer

A chain of Filter objects can be added to a HttpContext. All exchanges processed by the context can be pre- and post-processed by each Filter in the chain.

Summary

Protected Constructors
HttpContext()
Public Methods
abstract Map<String, Object> getAttributes()
returns a mutable Map, which can be used to pass configuration and other data to Filter modules and to the context's exchange handler.
abstract Authenticator getAuthenticator()
Returns the currently set Authenticator for this context if one exists.
abstract List<Filter> getFilters()
returns this context's list of Filters.
abstract HttpHandler getHandler()
returns the handler for this context
abstract String getPath()
returns the path this context was created with
abstract HttpServer getServer()
returns the server this context was created with
abstract Authenticator setAuthenticator(Authenticator auth)
Sets the Authenticator for this HttpContext.
abstract void setHandler(HttpHandler h)
Sets the handler for this context, if not already set.
[Expand]
Inherited Methods
From class java.lang.Object

Protected Constructors

protected HttpContext ()

Public Methods

public abstract Map<String, Object> getAttributes ()

returns a mutable Map, which can be used to pass configuration and other data to Filter modules and to the context's exchange handler.

Every attribute stored in this Map will be visible to every HttpExchange processed by this context

public abstract Authenticator getAuthenticator ()

Returns the currently set Authenticator for this context if one exists.

Returns
  • this HttpContext's Authenticator, or null if none is set.

public abstract List<Filter> getFilters ()

returns this context's list of Filters. This is the actual list used by the server when dispatching requests so modifications to this list immediately affect the the handling of exchanges.

public abstract HttpHandler getHandler ()

returns the handler for this context

Returns
  • the HttpHandler for this context

public abstract String getPath ()

returns the path this context was created with

Returns
  • this context's path

public abstract HttpServer getServer ()

returns the server this context was created with

Returns
  • this context's server

public abstract Authenticator setAuthenticator (Authenticator auth)

Sets the Authenticator for this HttpContext. Once an authenticator is establised on a context, all client requests must be authenticated, and the given object will be invoked to validate each request. Each call to this method replaces any previous value set.

Parameters
auth the authenticator to set. If null then any previously set authenticator is removed, and client authentication will no longer be required.
Returns
  • the previous Authenticator, if any set, or null otherwise.

public abstract void setHandler (HttpHandler h)

Sets the handler for this context, if not already set.

Parameters
h the handler to set for this context
Throws
IllegalArgumentException if this context's handler is already set.
NullPointerException if handler is null