Java HTTP Server

com.sun.net.httpserver
Class Filter

java.lang.Object
  extended by com.sun.net.httpserver.Filter

public abstract class Filter
extends Object

A filter used to pre- and post-process incoming requests. Pre-processing occurs before the application's exchange handler is invoked, and post-processing occurs after the exchange handler returns. Filters are organised in chains, and are associated with HttpContext instances.

Each Filter in the chain, invokes the next filter within its own doFilter() implementation. The final Filter in the chain invokes the applications exchange handler.

Since:
1.6

Nested Class Summary
static class Filter.Chain
          a chain of filters associated with a HttpServer.
 
Constructor Summary
protected Filter()
           
 
Method Summary
abstract  String description()
          returns a short description of this Filter
abstract  void doFilter(HttpExchange exchange, Filter.Chain chain)
          Asks this filter to pre/post-process the given exchange.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Filter

protected Filter()
Method Detail

doFilter

public abstract void doFilter(HttpExchange exchange,
                              Filter.Chain chain)
                       throws IOException
Asks this filter to pre/post-process the given exchange. The filter can :-

Parameters:
exchange - the HttpExchange to be filtered.
chain - the Chain which allows the next filter to be invoked.
Throws:
IOException - may be thrown by any filter module, and if caught, must be rethrown again.
NullPointerException - if either exchange or chain are null

description

public abstract String description()
returns a short description of this Filter

Returns:
a string describing the Filter

Java HTTP Server