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

Variable Index

o ATTR_BUREAU_IDENTIFIER
Attribute index - The identifier of our bureau.
o bureau
Our loaded lable bureau.
o PICS_EXTENSION
The bag describing the PICS extension:
o PICS_PROTOCOL_ID
The PICS protocol version that this filter handles.

Constructor Index

o PICSFilter()

Method Index

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

Variables

o PICS_PROTOCOL_ID 
 public static final String PICS_PROTOCOL_ID
The PICS protocol version that this filter handles.

o PICS_EXTENSION 
 public static HttpBag PICS_EXTENSION
The bag describing the PICS extension:

o ATTR_BUREAU_IDENTIFIER 
 protected static int ATTR_BUREAU_IDENTIFIER
Attribute index - The identifier of our bureau.

o bureau 
 protected LabelBureauInterface bureau
Our loaded lable bureau.

Constructors

o PICSFilter 
 public PICSFilter()

Methods

o getBureauIdentifier 
 public File getBureauIdentifier()
Get our label bureau identifier.

o acquireBureau 
 protected final void acquireBureau()
Make sure our label bureau is loaded.

o 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.
o outgoingFilter 
 public Reply outgoingFilter(Request request,
                             Reply reply) throws HTTPException
Simplified API to the outgoing filter metho.

Overrides:
outgoingFilter in class ResourceFilter
o initialize 
 public void initialize(Object values[])
Initialize the filter.

Overrides:
initialize in class ResourceFilter 
All Packages  Class Hierarchy  This Package  Previous  Next  Index