Package sunlabs.brazil.filter

Class ReFilter

  • All Implemented Interfaces:
    Filter, Handler
    public class ReFilter
extends java.lang.Object
implements Filter
    Filter to replace text content via a reqular expression substitution. See Regexp.sub(java.lang.String, java.lang.String) and Regexp.subAll(java.lang.String, java.lang.String).

    Note: The regular expression processing should be consolodated with the RePollHandler, and the tag_extract... processing.

    The following server properties are used:

    re
    The regular expression to match the content
    sub
    The replacement expression. If not specified, the matched content is deleted.
    oneOnly
    If set, only replace the first match. by default, all matches are replaced.
    noCase
    If set, case-insensitive matchins is performed.
    Version:
    2.4
    Author:
    Stephen Uhler

    • Constructor Summary

      Constructors 
      Constructor Description
      ReFilter()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      byte[] filter​(Request request, MimeHeaders headers, byte[] content)
      If the content matches the regular expression, do the substitution.
      boolean init​(Server server, java.lang.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 documents

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ReFilter

        public ReFilter()

    • Method Detail

      • init

        public boolean init​(Server server,
                    java.lang.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 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)
        If the content matches the regular expression, do the substitution. Otherwise, return the original content un-changed.
        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.