Class MD5Filter

java.lang.Object

sunlabs.brazil.filter.MD5Filter

All Implemented Interfaces:

Filter, Handler

public class MD5Filter
extends Object
implements Filter

Filter to compute the MD5 checksum of the content, and generate the appropriate "Content-MD5" http header. As md5 checksum generation can be expensive, care should be taken as to which types of content are digested.

The following server properties are used:

prefix, suffix, glob, match

Specify the URLs that trigger this filter (See MatchString).

Version:

2.3

Author:

Stephen Uhler

Constructor Summary

Constructors

Constructor	Description
MD5Filter()

Method Summary

Modifier and Type	Method	Description
byte[]	filter(Request request, MimeHeaders headers, byte[] content)	Compute digest, add to header.
boolean	init(Server server, String prefix)	Make sure MD5 is available in this VM, or don't start.
boolean	respond(Request request)	This is the request object before the content was fetched.
boolean	shouldFilter(Request request, MimeHeaders headers)	Only filter url's that match.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MD5Filter

public MD5Filter()

Method Details

init

public boolean init(Server server,
 String prefix)

Make sure MD5 is available in this VM, or don't start.

Specified by:

init in interface Handler

Parameters:

server - The HTTP server that created this Handler. Typical Handlers will use Server.props to obtain run-time configuration information.

prefix - The handlers name. The string this Handler may prepend to all of the keys that it uses to extract configuration information from Server.props. This is set (by the Server and ChainHandler) to help avoid configuration parameter namespace collisions.

Returns:

true if this Handler initialized successfully, false otherwise. If false is returned, this Handler should not be used.

respond

public boolean respond(Request request)

This is the request object before the content was fetched.

Specified by:

respond in interface Handler

Parameters:

request - The Request object that represents the HTTP request.

Returns:

true if the request was handled. A request was handled if a response was supplied to the client, typically by calling Request.sendResponse() or Request.sendError.

shouldFilter

public boolean shouldFilter(Request request,
 MimeHeaders headers)

Only filter url's that match.

Specified by:

shouldFilter in interface Filter

Parameters:

request - The in-progress HTTP request.

headers - The MIME headers generated by the wrapped Handler.

Returns:

true if this filter would like to examine and possibly rewrite the content, false otherwise.

filter

public byte[] filter(Request request,
 MimeHeaders headers,
 byte[] content)

Compute digest, add to header.

Specified by:

filter in interface Filter

Parameters:

request - The finished HTTP request.

headers - The MIME headers generated by the Handler.

content - The output from the Handler that this Filter may rewrite.

Returns:

The rewritten content. The Filter may return the original content unchanged. The Filter may return null to indicate that the FilterHandler should stop processing the request and should not return any content to the client.