freenet.client.filter

Interface FilterCallback

All Known Implementing Classes:

GenericReadFilterCallback, NullFilterCallback

public interface FilterCallback

Callback to be provided to a content filter.

Method Summary

Modifier and Type	Method and Description
java.lang.String	onBaseHref(java.lang.String baseHref) Process a base URI in the page.
void	onFinished()
void	onText(java.lang.String s, java.lang.String type) Process plain-text.
java.lang.String	processForm(java.lang.String method, java.lang.String action) Process a form on the page.
java.lang.String	processTag(HTMLFilter.ParsedTag pt) Process a tag.
java.lang.String	processURI(java.lang.String uri, java.lang.String overrideType) Process a URI.
java.lang.String	processURI(java.lang.String uri, java.lang.String overrideType, boolean noRelative, boolean inline) Process a URI.
java.lang.String	processURI(java.lang.String uri, java.lang.String overrideType, java.lang.String forceSchemeHostAndPort, boolean inline) Process a URI forcing the host.

Method Detail

processURI

java.lang.String processURI(java.lang.String uri,
                            java.lang.String overrideType)
                     throws CommentException

Process a URI. If it cannot be turned into something sufficiently safe, then return null.

Parameters:

overrideType - Force the return type.

Throws:

CommentException - If the URI is nvalid or unacceptable in some way.

processURI

java.lang.String processURI(java.lang.String uri,
                            java.lang.String overrideType,
                            boolean noRelative,
                            boolean inline)
                     throws CommentException

Process a URI. If it cannot be turned into something sufficiently safe, then return null.

Parameters:

overrideType - Force the return type.

noRelative - always turn into absolute URI, adding the baseUri if needed

inline - inline URIs may be prefetched while filtering

Throws:

CommentException - If the URI is nvalid or unacceptable in some way.

processURI

java.lang.String processURI(java.lang.String uri,
                            java.lang.String overrideType,
                            java.lang.String forceSchemeHostAndPort,
                            boolean inline)
                     throws CommentException

Process a URI forcing the host. If it cannot be turned into something sufficiently safe, then return null.

Parameters:

overrideType - Force the return type.

inline - inline URIs may be prefetched while filtering

Throws:

CommentException - If the URI is nvalid or unacceptable in some way.

onBaseHref

java.lang.String onBaseHref(java.lang.String baseHref)

Process a base URI in the page. Not only is this filtered, it affects all relative uri's on the page.

onText

void onText(java.lang.String s,
            java.lang.String type)

Process plain-text. Notification only; can't modify. Type can be null, or can correspond, for example to HTML tag name around text (for example: "title"). Note that the string will have been fed through the relevant decoder if necessary (e.g. HTMLDecoder). It must be re-encoded if it is sent out as text to a browser.

processForm

java.lang.String processForm(java.lang.String method,
                             java.lang.String action)
                      throws CommentException

Process a form on the page.

Parameters:

method - The form sending method. Normally GET or POST.

action - The URI to send the form to.

Returns:

The new action URI, or null if the form is not allowed.

Throws:

CommentException

processTag

java.lang.String processTag(HTMLFilter.ParsedTag pt)

Process a tag. If it needs changing, then return the changed HTML, if not, then return null;

Parameters:

pt - - The tag to be replaced

Returns:

The new tag, or null, if it doesn't need changing

onFinished

void onFinished()