    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class w3c.jigsaw.pics.PICSFilter

    java.lang.Object
       |
       +----w3c.tools.store.AttributeHolder
               |
               +----w3c.tools.store.Resource
                       |
                       +----w3c.tools.store.ResourceFrame
                               |
                               +----w3c.jigsaw.resources.ResourceFilter
                                       |
                                       +----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.
PICS_EXTENSION
  The bag describing the PICS extension:
PICS_PROTOCOL_ID
  The PICS protocol version that this filter handles.

##

PICSFilter()

##

acquireBureau()
  Make sure our label bureau is loaded.
getBureauIdentifier()
  Get our label bureau identifier.
initialize(Object[])
  Initialize the filter.
isPICSQuery(Request)
  Check the query to examine if it requires some PICS handling.
outgoingFilter(Request, Reply)
  Simplified API to the outgoing filter metho.

##

PICS_PROTOCOL_ID

     public static final String PICS_PROTOCOL_ID

  The PICS protocol version that this filter handles.

PICS_EXTENSION

     public static HttpBag PICS_EXTENSION

  The bag describing the PICS extension:

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.

outgoingFilter

     public Reply outgoingFilter(Request request,
                                 Reply reply) throws HTTPException

  Simplified API to the outgoing filter metho.

  Overrides:
    outgoingFilter in class ResourceFilter

initialize

     public void initialize(Object values[])

  Initialize the filter.

  Overrides:
    initialize in class ResourceFilter

    All Packages  Class Hierarchy  This Package  Previous  Next  Index