com.elasticpath.commons.filter.impl
Class CachingControlFilter

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

All Implemented Interfaces:

javax.servlet.Filter

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

Create caching control headers based on the definition.

Nested Class Summary

static class

CachingControlFilter.CachingControlEntry Reprents a caching control entry.

Constructor Summary

CachingControlFilter()

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 inRequest, javax.servlet.ServletResponse inResponse, javax.servlet.FilterChain inFilterChain) 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.
java.util.List	getCachingControlEntries() Returns caching control entries.
java.lang.String	getDateTimeStrInGMT(java.util.Date date) Returns the date string in GMT time zone.
void	init(javax.servlet.FilterConfig filterConfig) Called by the web container to indicate to a filter that it is being placed into service.
void	setCachingControlEntries(java.util.List cachingControlEntries) Sets the caching control entries.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingControlFilter

public CachingControlFilter()

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 inRequest,
                     javax.servlet.ServletResponse inResponse,
                     javax.servlet.FilterChain inFilterChain)
              throws java.io.IOException,
                     javax.servlet.ServletException

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:

inRequest - -the request

inResponse - -the response

inFilterChain - - the filter chain

Throws:

javax.servlet.ServletException - - if something goes wrong

java.io.IOException - - if something goes wrong

getCachingControlEntries

public java.util.List getCachingControlEntries()

Returns caching control entries.

Returns:

caching control entries

getDateTimeStrInGMT

public java.lang.String getDateTimeStrInGMT(java.util.Date date)

Returns the date string in GMT time zone.

Parameters:

date - the date

Returns:

the date string in GMT time zone.

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.

setCachingControlEntries

public void setCachingControlEntries(java.util.List cachingControlEntries)

Sets the caching control entries.

Parameters:

cachingControlEntries - the caching control entries to set