com.elasticpath.commons.filter.impl
Class EncodingFilter

java.lang.Object
  com.elasticpath.commons.filter.impl.EncodingFilter

All Implemented Interfaces:

javax.servlet.Filter

public final class EncodingFilter
extends java.lang.Object
implements javax.servlet.Filter

Currently, many browsers do not send character encoding information in the Content-Type header of an HTTP request. If an encoding has not been specified by the client request, the container uses a default encoding to parse request parameters. If the client hasn't set the character encoding and the request parameters are encoded with a different encoding than the default, the parameters will be parsed incorrectly. You can use the method setCharacterEncoding in the ServletRequest interface to set the encoding. Since this method must be called prior to parsing any post data or reading any input from the request, this function is a prime application for filters.

Constructor Summary

EncodingFilter()

Method Summary

void	destroy() Called by the web container to indicate to a filter that it is being taken out of service.
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain) The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain.
void	init(javax.servlet.FilterConfig filterConfig) Called by the web container to indicate to a filter that it is being placed into service.

Methods inherited from class java.lang.Object

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

Constructor Detail

EncodingFilter

public EncodingFilter()

Method Detail

destroy

public void destroy()

Called by the web container to indicate to a filter that it is being taken out of service. This method is only called once all threads within the filter's doFilter method have exited or after a timeout period has passed. After the web container calls this method, it will not call the doFilter method again on this instance of the filter.

Specified by:

destroy in interface javax.servlet.Filter

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws javax.servlet.ServletException,
                     EpLicensingInvalidException,
                     EpLicensingMissingException

The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain. The FilterChain passed in to this method allows the Filter to pass on the request and response to the next entity in the chain. In EncodingFilter, we make sure the characterEncoding set is properly.

Specified by:

doFilter in interface javax.servlet.Filter

Parameters:

request - -the request

response - -the response

chain - - the filter chain

Throws:

javax.servlet.ServletException - - if something goes wrong

EpLicensingInvalidException - - if license is invalid

EpLicensingMissingException - - if license is missing

init

public void init(javax.servlet.FilterConfig filterConfig)

Called by the web container to indicate to a filter that it is being placed into service. The servlet container calls the init method exactly once after instantiating the filter. The init method must complete successfully before the filter is asked to do any filtering work.

Specified by:

init in interface javax.servlet.Filter

Parameters:

filterConfig - - the filerConfig.