All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class w3c.jigsaw.filters.ErrorFilter 

java.lang.Object
   |
   +----w3c.tools.store.AttributeHolder
           |
           +----w3c.tools.store.Resource
                   |
                   +----w3c.tools.store.ResourceFrame
                           |
                           +----w3c.jigsaw.resources.ResourceFilter
                                   |
                                   +----w3c.jigsaw.filters.ErrorFilter
public class ErrorFilter
extends ResourceFilter
The ErroFilter class allows you to customize and enhance error messages. This filter will catch all errors on their way back to the client, and use internal requests to provide a nice customizable error message.

You can use any resources (including server side includes, content negotiated resources, etc) to deliver error messages.

Variable Index

o ATTR_BASEURL
Attribute index - The base URL for error messages.
o ATTR_EXTENSION
Attribute index - The common extension for error messages (can be null).
o ERRED
A request state, to avoid looping on errors about errors.

Constructor Index

o ErrorFilter()

Method Index

o exceptionFilter(Request, HTTPException, HTTPFilter[], int)
We do catch exceptions, just in case we can customize the error.
o getBaseURL()
Get the base URL describing the error directory.
o getErrorResource(int)
Compute the path for the given status code.
o getExtension()
Get the value of the extension attribute.
o ingoingFilter(Request)
This one just makes sure the outgoing filter gets called.
o initialize(Object[])
Initialize the filter.
o outgoingFilter(Request, Reply)
Re-compute error message.

Variables

o ERRED 
 protected static final String ERRED
A request state, to avoid looping on errors about errors.

o ATTR_BASEURL 
 protected static int ATTR_BASEURL
Attribute index - The base URL for error messages.

o ATTR_EXTENSION 
 protected static int ATTR_EXTENSION
Attribute index - The common extension for error messages (can be null).

Constructors

o ErrorFilter 
 public ErrorFilter()

Methods

o getBaseURL 
 public String getBaseURL()
Get the base URL describing the error directory.

Returns:
The base URL.
o getExtension 
 public String getExtension()
Get the value of the extension attribute.

Returns:
A String, for the common extension to error messages, or null if undefined.
o getErrorResource 
 public String getErrorResource(int status)
Compute the path for the given status code.

Returns:
A path leading to the customizable error message for the given status code.
o ingoingFilter 
 public Reply ingoingFilter(Request request) throws HTTPException
This one just makes sure the outgoing filter gets called.

Parameters:
request - The original request to be handled.
Overrides:
ingoingFilter in class ResourceFilter
o outgoingFilter 
 public Reply outgoingFilter(Request request,
                             Reply reply) throws HTTPException
Re-compute error message. This filter uses internal redirection to get the error message body. In case of failure, the original reply is returned, otherwise, a new reply is gotten from the appropriate error resource, and is returned.

Parameters:
request - The request that has been handled.
reply - The reply, as emited by the original resource.
Returns:
A new error reply, having the same status code, and authentication information then the given reply, but enhanced with the error resource body.
Overrides:
outgoingFilter in class ResourceFilter
o exceptionFilter 
 public Reply exceptionFilter(Request request,
                              HTTPException ex,
                              HTTPFilter filters[],
                              int idx)
We do catch exceptions, just in case we can customize the error.

Parameters:
request - The request tha triggered the exception.
ex - The exception.
filters - Remaining filters to be called.
idx - Current filter index within above array.
Overrides:
exceptionFilter 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