Class ExecFilter
java.lang.Object
sunlabs.brazil.filter.ExecFilter
Filter to Run all content through an external process filter.
The content is provided as the standard input to a command, that is
expected to return the new content.
The following server properties are used:
- command
- The command to exec. The content is supplied as stdin, and the filtered output is expected on stdout. ${...} substitutions Are done at each filter invocation.
- types
- A regular expression that matches the content types for the content we wish to filter
- type
- This property is set to the content type of the content just before command is evaluated.
- newType
- This property, if set, is used as the new content type. It is evaluated for ${...} at each conversion.
- error
- If the command failed, this property will contain the error message. If the command generated output on stderr, this property will contain the output.
prefix.types=image/(jpeg|gif) prefix.command= convert -sample 50% \ ${map.${prefix.type}}:- ${map.${prefix.type}}:- map.image/gif=GIF map.image/jpeg=JPEG
- Version:
- 2.2
- Author:
- Stephen Uhler
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbyte[]
filter
(Request request, MimeHeaders headers, byte[] content) Run content through filter.boolean
Initializes the handler.boolean
This is the request object before the content was fetchedboolean
shouldFilter
(Request request, MimeHeaders headers) Only filter content types that match
-
Constructor Details
-
ExecFilter
public ExecFilter()
-
-
Method Details
-
init
Description copied from interface:Handler
Initializes the handler.- Specified by:
init
in interfaceHandler
- Parameters:
server
- The HTTP server that created thisHandler
. TypicalHandler
s will useServer.props
to obtain run-time configuration information.prefix
- The handlers name. The string thisHandler
may prepend to all of the keys that it uses to extract configuration information fromServer.props
. This is set (by theServer
andChainHandler
) to help avoid configuration parameter namespace collisions.- Returns:
true
if thisHandler
initialized successfully,false
otherwise. Iffalse
is returned, thisHandler
should not be used.
-
respond
This is the request object before the content was fetched -
shouldFilter
Only filter content types that match- Specified by:
shouldFilter
in interfaceFilter
- Parameters:
request
- The in-progress HTTP request.headers
- The MIME headers generated by the wrappedHandler
.- Returns:
true
if this filter would like to examine and possibly rewrite the content,false
otherwise.
-
filter
Run content through filter. Process ${...}- Specified by:
filter
in interfaceFilter
- Parameters:
request
- The finished HTTP request.headers
- The MIME headers generated by theHandler
.content
- The output from theHandler
that thisFilter
may rewrite.- Returns:
- The rewritten content. The
Filter
may return the originalcontent
unchanged. TheFilter
may returnnull
to indicate that theFilterHandler
should stop processing the request and should not return any content to the client.
-