    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class org.w3c.tools.resources.ResourceFilter

    java.lang.Object
       |
       +----org.w3c.tools.resources.AttributeHolder
               |
               +----org.w3c.tools.resources.Resource
                       |
                       +----org.w3c.tools.resources.FramedResource
                               |
                               +----org.w3c.tools.resources.ResourceFrame
                                       |
                                       +----org.w3c.tools.resources.ResourceFilter

public class ResourceFilter
extends ResourceFrame
implements FilterInterface

##

ResourceFilter()

##

exceptionFilter(RequestInterface, ProtocolException, FilterInterface[], int)
getTargetResource()
  Get our target resource.
ingoingFilter(RequestInterface)
  Simplified ingoingFilter API.
ingoingFilter(RequestInterface, FilterInterface[], int)
  The ingoingFilter method.
lookup(LookupState, LookupResult)
  Lookup time filtering.
outgoingFilter(RequestInterface, ReplyInterface)
  Simplified API to the outgoing filter metho.
outgoingFilter(RequestInterface, ReplyInterface, FilterInterface[], int)
  The outgoingFilter method.
outputFilter(RequestInterface, ReplyInterface, OutputStream)

##

ResourceFilter

     public ResourceFilter()

##

getTargetResource

     public Resource getTargetResource()

  Get our target resource.

lookup

     public boolean lookup(LookupState ls,
                           LookupResult lr) throws ProtocolException

  Lookup time filtering. This method is called while Jigsaw performs resource lookup. Each time a lookup end up on the target resource of that filter, this method will be called.

  Parameters:
    ls - The current lookup state.
    lr - The current lookup result.
  Returns:
    A boolean, true if this filter has performed the whole lookup, and side-effect the lookup result appropriatelly, false otherwise.
  Throws: ProtocolException
    If processing should be interrupted, because an abnormal situation occured.
  Overrides:
    lookup in class ResourceFrame

ingoingFilter

     public ReplyInterface ingoingFilter(RequestInterface request) throws ProtocolException

  Simplified ingoingFilter API. This is a default, simplified API to the ingoing filter method.

  Parameters:
    request - The request to filter.
  Returns:
    A Reply instance, or null if processing should continue normally.
  Throws: ProtocolException
    If processing should be interrupted, because an abnormal situation occured.

ingoingFilter

     public ReplyInterface ingoingFilter(RequestInterface request,
                                         FilterInterface filters[],
                                         int i) throws ProtocolException

  The ingoingFilter method. This is the method that really gets called by Jigsaw core. By default it will invoke the simpler `ingoingFilter` method, taking only the request has a parameter.

  Parameters:
    request - The request that is about to be handled.
    filters - The whole filter list to be applied to the resource.
    i - A pointer into the above array, indicating which filters have already been triggered (the one whose index are lower than i), and what filters have to be triggered (the one whose index are greater or equal to i+1).
  Returns:
    A Reply instance, if the filter did know how to answer the request without further processing, null otherwise.
  Throws: ProtocolException
    If processing should be interrupted, because an abnormal situation occured.

outgoingFilter

     public ReplyInterface outgoingFilter(RequestInterface request,
                                          ReplyInterface reply) throws ProtocolException

  Simplified API to the outgoing filter metho. This is a simplified API to the ougoing filter method, you can either overide this method, or the more powerfull one.

  Parameters:
    request - The original request.
    reply - It's original reply.
  Returns:
    A Reply instance, or null if processing should continue normally.
  Throws: ProtocolException
    If processing should be interrupted, because an abnormal situation occured.

exceptionFilter

     public ReplyInterface exceptionFilter(RequestInterface request,
                                           ProtocolException ex,
                                           FilterInterface filters[],
                                           int i)

outgoingFilter

     public ReplyInterface outgoingFilter(RequestInterface request,
                                          ReplyInterface reply,
                                          FilterInterface filters[],
                                          int fidx) throws ProtocolException

  The outgoingFilter method. This method is the one that gets called by Jigsaw core. By default it will call the simpler `outgoingFilter` method that takes only the request and the reply as parameters.

  Parameters:
    request - The request that has been processed.
    reply - The original reply as emitted by the resource.
    filters - The whole filter that applies to the resource.
    i - The current index of filters. The i filter is ourself, filters with lower indexes have already been applied, and filters with greater indexes are still to be applied.
  Returns:
    A Reply instance, if that filter know how to complete the request processing, or null if reminaing filters are to be called by Jigsaw engine.
  Throws: ProtocolException
    If processing should be interrupted, because an abnormal situation occured.

outputFilter

     public OutputStream outputFilter(RequestInterface request,
                                      ReplyInterface reply,
                                      OutputStream output)

    All Packages  Class Hierarchy  This Package  Previous  Next  Index