Package com.twelvemonkeys.servlet.image

Class ContentNegotiationFilter

java.lang.Object

com.twelvemonkeys.servlet.GenericFilter

com.twelvemonkeys.servlet.image.ImageFilter

com.twelvemonkeys.servlet.image.ContentNegotiationFilter

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Filter, javax.servlet.FilterConfig

public class ContentNegotiationFilter
extends ImageFilter

This filter implements server side content negotiation and transcoding for images.

Version:

$Id: ContentNegotiationFilter.java#1 $

Author:

Harald Kuhr

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	HTTP_HEADER_USER_AGENT

Fields inherited from class com.twelvemonkeys.servlet.image.ImageFilter

triggerParams

Fields inherited from class com.twelvemonkeys.servlet.GenericFilter

oncePerRequest

Constructor Summary

Constructors

Constructor	Description
ContentNegotiationFilter()

Method Summary

Modifier and Type	Method	Description
protected java.awt.image.RenderedImage	doFilter(java.awt.image.BufferedImage pImage, javax.servlet.ServletRequest pRequest, ImageServletResponse pResponse)	Filters the image for this request.
protected void	doFilterImpl(javax.servlet.ServletRequest pRequest, javax.servlet.ServletResponse pResponse, javax.servlet.FilterChain pChain)	The doFilterImpl method is called once, or each time a request/response pair is passed through the chain, depending on the GenericFilter.oncePerRequest member variable.
protected boolean	trigger(javax.servlet.ServletRequest pRequest)	Makes sure the filter triggers for unknown file formats.

Methods inherited from class com.twelvemonkeys.servlet.image.ImageFilter

setTriggerParams

Methods inherited from class com.twelvemonkeys.servlet.GenericFilter

destroy, doFilter, getFilterConfig, getFilterName, getInitParameter, getInitParameterNames, getServletContext, init, init, log, log, setFilterConfig, setOncePerRequest

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_HEADER_USER_AGENT

protected static final java.lang.String HTTP_HEADER_USER_AGENT

See Also:

Constant Field Values

Constructor Detail

ContentNegotiationFilter

public ContentNegotiationFilter()

Method Detail

doFilterImpl

protected void doFilterImpl(javax.servlet.ServletRequest pRequest,
                            javax.servlet.ServletResponse pResponse,
                            javax.servlet.FilterChain pChain)
                     throws java.io.IOException,
                            javax.servlet.ServletException

Description copied from class: ImageFilter

The doFilterImpl method is called once, or each time a request/response pair is passed through the chain, depending on the GenericFilter.oncePerRequest member variable.

Overrides:

doFilterImpl in class ImageFilter

Parameters:

pRequest - the servlet request

pResponse - the servlet response

pChain - the filter chain

Throws:

java.io.IOException - if an I/O error occurs

javax.servlet.ServletException - if an exception occurs during the filter process

See Also:

GenericFilter.oncePerRequest, doFilter, Filter.doFilter

trigger

protected boolean trigger(javax.servlet.ServletRequest pRequest)

Makes sure the filter triggers for unknown file formats.

Overrides:

trigger in class ImageFilter

Parameters:

pRequest - the request

Returns:

true if the filter should execute, false otherwise

doFilter

protected java.awt.image.RenderedImage doFilter(java.awt.image.BufferedImage pImage,
                                                javax.servlet.ServletRequest pRequest,
                                                ImageServletResponse pResponse)
                                         throws java.io.IOException

Description copied from class: ImageFilter

Filters the image for this request.

Specified by:

doFilter in class ImageFilter

Parameters:

pImage - the image to filter

pRequest - the servlet request

pResponse - the servlet response

Returns:

the filtered image

Throws:

java.io.IOException - if an I/O error occurs during filtering