javawebparts.filter
Class CharacterEncodingFilter

java.lang.Object
  |
  +--javawebparts.filter.CharacterEncodingFilter

All Implemented Interfaces:

javax.servlet.Filter

public class CharacterEncodingFilter

extends java.lang.Object

implements javax.servlet.Filter

This filter allows for setting the Content-Type header of a request to set the character encoding scheme. Because some browsers do not send the character encoding scheme in the Content-Type header, problems can arise when the server uses a default scheme to parse incoming request parameters. If the default scheme does not happen to match what the clients' default is, the parameters will be parsed incorrectly. Note that if the client did send an encoding scheme, this filter WILL NOT override it.

Init parameters are:

• pathSpec - Either "include" or "exclude". This determines whether the list of paths in the pathList parameter is a list of paths to include in filter functionality, or a list of paths to exclude. Required: No. Default: None.



• pathList - This is a comma-separated list of paths, which can use asterisk for wildcard support, that denotes either paths to include or exclude from the functioning of this filter (depending on what pathSpec is set to). The paths ARE case-senitive! There is no limit to how many items can be specified, although for performance reasons a developer will probably want to specify as few as possible to get the job done (each requested path is matched via regex). Note also that you are of course still required to specify a path for the filter itself as per the servlet spec. This parameter however, together with pathSpec, gives you more control and flexibility than that setting alone. Required: No. Default: None.
  
  General note on pathSpec and pathList: If pathSpec is not specified but pathList IS, then 'exclude' is assumed for pathSpec. If pathSpec is specified by pathList IS NOT, then the filter WILL NEVER EXECUTE (this is technically a misconfiguration). If NEITHER is defined then the generic filter mapping will be in effect only.



• encodingScheme - This is the actual value to set in the header. This can be any valid character encoding scheme value like ASCII, UTF-8, etc. Required: Yes. Default: None.

Example configuration in web.xml:

<filter>
<filter-name>CharacterEncodingFilter</filter-name>
<filter-class>javawebparts.filter. CharacterEncodingFilter</filter-class>
<init-param>
<param-name>encodingScheme</param-name>
<param-value>?????</param-value>
</init-param>
</filter>

<filter-mapping>
<filter-name>CharacterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>

Author:

Frank W. Zammetti.

Field Summary

private java.lang.String	encodingScheme The encodingScheme read in from configuration.
private static org.apache.commons.logging.Log	log Log instance.
private java.util.ArrayList	pathList List of paths for filter functionality determination.
private java.lang.String	pathSpec Whether pathList includes or excludes.

Constructor Summary

CharacterEncodingFilter()

Method Summary

void	destroy() Destroy.
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain filterChain) Do filter's work.
void	init(javax.servlet.FilterConfig filterConfig) Initialize this filter.

Methods inherited from class java.lang.Object

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

Field Detail

log

private static org.apache.commons.logging.Log log

Log instance.

pathSpec

private java.lang.String pathSpec

Whether pathList includes or excludes.

pathList

private java.util.ArrayList pathList

List of paths for filter functionality determination.

encodingScheme

private java.lang.String encodingScheme

The encodingScheme read in from configuration.

Constructor Detail

CharacterEncodingFilter

public CharacterEncodingFilter()

Method Detail

destroy

public void destroy()

Destroy.

Specified by:

destroy in interface javax.servlet.Filter

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Initialize this filter.

Specified by:

init in interface javax.servlet.Filter

Parameters:

filterConfig - The configuration information for this filter.

Throws:

javax.servlet.ServletException - ServletException.

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain filterChain)
              throws java.io.IOException,
                     javax.servlet.ServletException

Do filter's work.

Specified by:

doFilter in interface javax.servlet.Filter

Parameters:

request - The current request object.

response - The current response object.

filterChain - The current filter chain.

Throws:

javax.servlet.ServletException - ServletException.

java.io.IOException - IOException.