    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class org.w3c.jigsaw.pics.PICSFilter

    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
                                               |
                                               +----org.w3c.jigsaw.pics.PICSFilter

public class PICSFilter
extends ResourceFilter

This package implements a PICS filter. The PICS filters allows server administrator to rate the documents they deliver. The references for this protocol is here.

The PICS filter defines the following attributes:

The list of parameters
Parameter name | Semantics | Default value | Type
--- | --- | --- | ---
bureau | The label bureau to query for this entity labels. | none | java.lang.String

##

ATTR_BUREAU_IDENTIFIER
  Attribute index - The identifier of our bureau.
bureau
  Our loaded lable bureau.

##

PICSFilter()

##

acquireBureau()
  Make sure our label bureau is loaded.
getBureauIdentifier()
  Get our label bureau identifier.
initialize(Object[])
  Initialize the frames of that framed resource.
isPICSQuery(Request)
  Check the query to examine if it requires some PICS handling.
outgoingFilter(RequestInterface, ReplyInterface)
  The outgoingFilter method.

##

ATTR_BUREAU_IDENTIFIER

     protected static int ATTR_BUREAU_IDENTIFIER

  Attribute index - The identifier of our bureau.

bureau

     protected LabelBureauInterface bureau

  Our loaded lable bureau.

##

PICSFilter

     public PICSFilter()

##

getBureauIdentifier

     public File getBureauIdentifier()

  Get our label bureau identifier.

acquireBureau

     protected final void acquireBureau()

  Make sure our label bureau is loaded.

isPICSQuery

     protected HttpBag isPICSQuery(Request request) throws HTTPException

  Check the query to examine if it requires some PICS handling. If this is the case, it returns a Bag object corresponding to the part of the Accept-Protocol header that relates with PICS.

  Parameters:
    request - The request to be checked.
  Returns:
    A Bag object if PICS handling required, null otherwise.
  Throws: HTTPException
    if processing the request failed.

outgoingFilter

     public ReplyInterface outgoingFilter(RequestInterface req,
                                          ReplyInterface rep) throws HTTPException

  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: HTTPException
    If processing should be interrupted, because an abnormal situation occured.
  Overrides:
    outgoingFilter in class ResourceFilter

initialize

     public void initialize(Object values[])

  Initialize the frames of that framed resource.

  Overrides:
    initialize in class FramedResource

    All Packages  Class Hierarchy  This Package  Previous  Next  Index