Class PlainFilter

java.lang.Object

sunlabs.brazil.filter.PlainFilter

All Implemented Interfaces:

Filter, Handler

public class PlainFilter
extends Object
implements Filter

Filter to turn text/plain into html. This allows plain text to be processed by other filters that only deal with html.

The following server properties are used:

template

The string to use as an html template. The string should contain a single "%", which is replaced by the text/plain content. The default stuff the content between <pre>...</pre>.

Version:

2.2

Author:

Stephen Uhler

Constructor Summary

Constructors

Constructor	Description
PlainFilter()

Method Summary

Modifier and Type	Method	Description
byte[]	filter(Request request, MimeHeaders headers, byte[] content)	Wrap html around text/plain, converting it to html.
boolean	init(Server server, String prefix)	Initializes the handler.
boolean	respond(Request request)	This is the request object before the content was fetched
boolean	shouldFilter(Request request, MimeHeaders headers)	Only filter text/plain documents

Methods inherited from class Object

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

Constructor Details

PlainFilter

public PlainFilter()

Method Details

init

public boolean init(Server server,
 String prefix)

Description copied from interface: Handler

Initializes the handler.

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 text/plain documents

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)

Wrap html around text/plain, converting it to html. Change the content-type to text/html.

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.