    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Interface w3c.jigsaw.http.HTTPFilter

public interface HTTPFilter
extends Object

##

ingoingFilter(Request, HTTPFilter[], int)
  The filter's ingoing method is called before any request processing is done by the target resource.
lookup(LookupState, LookupResult)
  The lookup stage filtering.
outgoingFilter(Request, Reply, HTTPFilter[], int)
  The filter's outgoing method is called once the target resource has computed a reply.

##

lookup

      public abstract boolean lookup(LookupState ls,
                                     LookupResult lr) throws HTTPException

  The lookup stage filtering. This filter is invoked during lookup, it can cancel the lookup operation in progress, by either throwing an exception (in case of error), or by returning true, in which case, the filter has perform the whole lookup operation itself.
  Parameters:
    ls - The current lookup state, describing the state of the lookup operation in progress.
    lr - The current lookup result, describing the already computed part of the lookup operation.
  Returns:
    A boolean, true if lookup has been completed by the filter, and nothing else need to be done to complete it. Otherwise lookup should continue normally, and the filter returns false.
  Throws: HTTPException
    If some error occurs, and the whole lookup operation cannot be continued normally.

ingoingFilter

      public abstract Reply ingoingFilter(Request request,
                                          HTTPFilter filters[],
                                          int fidx) throws HTTPException

  The filter's ingoing method is called before any request processing is done by the target resource.

  This method can (if able) compute the whole request's reply, and return it. If processing should continue normally, then the filter must return null.

  Parameters:
    request - The request being processed.
    filters - The whole array of filters to be applied before actually continuing the process.
    fidx - The index in the above array of the filter being called.
  Returns:
    A Reply instance, if the filter knows how to compute it, or null if the request processing should continue normally.
  Throws: HTTPException
    If the filter fails.

outgoingFilter

      public abstract Reply outgoingFilter(Request request,
                                           Reply reply,
                                           HTTPFilter filters[],
                                           int fidx) throws HTTPException

  The filter's outgoing method is called once the target resource has computed a reply.

  This method can return a Reply instance, in which case, the processing should be aborted, and the returned reply should be emited back to thye client. Otherwsie, if the filter returns null the processing continues normally.

  Parameters:
    request - The request being processed.
    reply - The original reply, as emited by the target resource, and which has already been processed by the first filters.
    filters - The whole array of filters to be applied before actually continuing the process.
    fidx - The index in the above array of the filter being called.
  Throws: HTTPException
    If the filter fails.

    All Packages  Class Hierarchy  This Package  Previous  Next  Index