A B C D E F G H I L N P R S T W

A

acceptsEncoding(HttpServletRequest, String) - Method in class net.sf.ehcache.constructs.web.filter.Filter

Checks if request accepts the named encoding.

acceptsGzipEncoding(HttpServletRequest) - Method in class net.sf.ehcache.constructs.web.filter.Filter

Determine whether the user agent accepts GZIP encoding.

acceptsGzipEncoding(HttpServletRequest) - Method in class net.sf.ehcache.constructs.web.filter.GzipFilter

Determine whether the user agent accepts GZIP encoding.

addCookie(Cookie) - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Adds a cookie.

addGzipHeader(HttpServletResponse) - Static method in class net.sf.ehcache.constructs.web.ResponseUtil

Adds the gzip HTTP header to the response.

addHeader(String, String) - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Adds a header.

AlreadyCommittedException - Exception in net.sf.ehcache.constructs.web

This exception is thrown if, in particular, the ServletResponse.isCommitted() method shows the response has been committed.

AlreadyCommittedException() - Constructor for exception net.sf.ehcache.constructs.web.AlreadyCommittedException

Constructor for the exception

AlreadyCommittedException(String) - Constructor for exception net.sf.ehcache.constructs.web.AlreadyCommittedException

Constructs an exception with the message given

AlreadyGzippedException - Exception in net.sf.ehcache.constructs.web

The web package performs gzipping operations.

AlreadyGzippedException() - Constructor for exception net.sf.ehcache.constructs.web.AlreadyGzippedException

Constructor for the exception

AlreadyGzippedException(String) - Constructor for exception net.sf.ehcache.constructs.web.AlreadyGzippedException

Constructs an exception with the message given

B

blockingCache - Variable in class net.sf.ehcache.constructs.web.filter.CachingFilter

The cache holding the web pages.

buildPage(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

Builds the PageInfo object by passing the request along the filter chain

buildPage(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class net.sf.ehcache.constructs.web.filter.PageFragmentCachingFilter

Builds the PageInfo object by passing the request along the filter chain

buildPage(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class net.sf.ehcache.constructs.web.filter.SimpleCachingHeadersPageCachingFilter

Builds the PageInfo object by passing the request along the filter chain

buildPageInfo(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

Build page info either using the cache or building the page directly.

C

cacheName - Variable in class net.sf.ehcache.constructs.web.filter.CachingFilter

The cache name can be set through init parameters.

CachingFilter - Class in net.sf.ehcache.constructs.web.filter

An abstract CachingFilter.

CachingFilter() - Constructor for class net.sf.ehcache.constructs.web.filter.CachingFilter

calculateKey(HttpServletRequest) - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

CachingFilter works off a key.

calculateKey(HttpServletRequest) - Method in class net.sf.ehcache.constructs.web.filter.SimplePageCachingFilter

Pages are cached based on their key.

calculateKey(HttpServletRequest) - Method in class net.sf.ehcache.constructs.web.filter.SimplePageFragmentCachingFilter

CachingFilter works off a key.

calculateTimeToLiveMilliseconds() - Method in class net.sf.ehcache.constructs.web.filter.SimpleCachingHeadersPageCachingFilter

Get the time to live for a page, in milliseconds

checkNoReentry(HttpServletRequest) - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

Check that this caching filter is not being reentered by the same recursively.

contextDestroyed(ServletContextEvent) - Method in class net.sf.ehcache.constructs.web.ShutdownListener

Notification that the servlet context is about to be shut down.

contextInitialized(ServletContextEvent) - Method in class net.sf.ehcache.constructs.web.ShutdownListener

Notification that the web application is ready to process requests.

D

DEFAULT_CACHE_NAME - Static variable in class net.sf.ehcache.constructs.web.filter.SimplePageCachingFilter

The name of the filter.

destroy() - Method in class net.sf.ehcache.constructs.web.filter.Filter

Destroys the filter.

doDestroy() - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

Destroys the filter.

doDestroy() - Method in class net.sf.ehcache.constructs.web.filter.Filter

A template method that performs any Filter specific destruction tasks.

doDestroy() - Method in class net.sf.ehcache.constructs.web.filter.GzipFilter

A template method that performs any Filter specific destruction tasks.

doFilter(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

Performs the filtering for a request.

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class net.sf.ehcache.constructs.web.filter.Filter

Performs the filtering.

doFilter(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class net.sf.ehcache.constructs.web.filter.Filter

A template method that performs the filtering for a request.

doFilter(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class net.sf.ehcache.constructs.web.filter.GzipFilter

Performs the filtering for a request.

doFilter(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class net.sf.ehcache.constructs.web.filter.PageFragmentCachingFilter

Performs the filtering for a request.

doFilter(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class net.sf.ehcache.constructs.web.filter.SimplePageCachingFilterWithBlankPageProblem

Performs the filtering for a request.

doGet(HttpServletRequest, HttpServletResponse) - Method in class net.sf.ehcache.constructs.web.servlet.ForwardToCachedPageServlet

Parses the request URL and dispatches it to the appropriate JSP

doGet(HttpServletRequest, HttpServletResponse) - Method in class net.sf.ehcache.constructs.web.servlet.IncludeCachedPageServlet

Parses the request URL and dispatches it to the appropriate JSP

doInit(FilterConfig) - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

Initialises blockingCache to use.

doInit(FilterConfig) - Method in class net.sf.ehcache.constructs.web.filter.Filter

A template method that performs any Filter specific initialisation tasks.

doInit(FilterConfig) - Method in class net.sf.ehcache.constructs.web.filter.GzipFilter

Performs initialisation.

E

exceptionsToLogDifferently - Variable in class net.sf.ehcache.constructs.web.filter.Filter

The exceptions to log differently, as a comma separated list

exceptionsToLogDifferentlyLevel - Variable in class net.sf.ehcache.constructs.web.filter.Filter

A the level of the exceptions which will be logged differently.

F

Filter - Class in net.sf.ehcache.constructs.web.filter

A generic Filter with most of what we need done.

Filter() - Constructor for class net.sf.ehcache.constructs.web.filter.Filter

filterConfig - Variable in class net.sf.ehcache.constructs.web.filter.Filter

The filter configuration.

FilterNonReentrantException - Exception in net.sf.ehcache.constructs.web.filter

Thrown when it is detected that a caching filter's Filter.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain) method is reentered by the same thread.

FilterNonReentrantException() - Constructor for exception net.sf.ehcache.constructs.web.filter.FilterNonReentrantException

Constructor for the exception

FilterNonReentrantException(String) - Constructor for exception net.sf.ehcache.constructs.web.filter.FilterNonReentrantException

Constructs an exception with the message given

filterNotDisabled(HttpServletRequest) - Method in class net.sf.ehcache.constructs.web.filter.Filter

Filters can be disabled programmatically by adding a Filter.NO_FILTER parameter to the request.

FilterServletOutputStream - Class in net.sf.ehcache.constructs.web.filter

A custom ServletOutputStream for use by our filters

FilterServletOutputStream(OutputStream) - Constructor for class net.sf.ehcache.constructs.web.filter.FilterServletOutputStream

Creates a FilterServletOutputStream.

flush() - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Flushes all the streams for this response.

flushBuffer() - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Flushes buffer and commits response to client.

formatHttpDate(Date) - Method in class net.sf.ehcache.constructs.web.HttpDateFormatter

ForwardToCachedPageServlet - Class in net.sf.ehcache.constructs.web.servlet

A Front Controller for the /CachedPage.jsp page.

ForwardToCachedPageServlet() - Constructor for class net.sf.ehcache.constructs.web.servlet.ForwardToCachedPageServlet

G

GenericResponseWrapper - Class in net.sf.ehcache.constructs.web

Provides a wrapper for HttpServletResponseWrapper.

GenericResponseWrapper(HttpServletResponse, OutputStream) - Constructor for class net.sf.ehcache.constructs.web.GenericResponseWrapper

Creates a GenericResponseWrapper

getCacheManager() - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

Gets the CacheManager for this CachingFilter.

getCacheManager() - Method in class net.sf.ehcache.constructs.web.filter.SimplePageCachingFilter

Gets the CacheManager for this CachingFilter.

getCacheManager() - Method in class net.sf.ehcache.constructs.web.filter.SimplePageFragmentCachingFilter

Gets the CacheManager for this CachingFilter.

getCacheName() - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

A meaningful name representative of the JSP page being cached.

getCacheName() - Method in class net.sf.ehcache.constructs.web.filter.SimplePageCachingFilter

A meaningful name representative of the page being cached.

getCacheName() - Method in class net.sf.ehcache.constructs.web.filter.SimplePageFragmentCachingFilter

Returns the name of the cache to use for this filter.

getContentLength() - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Gets the content length.

getContentType() - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Gets the content type.

getContentType() - Method in class net.sf.ehcache.constructs.web.PageInfo

getCookies() - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Gets all the cookies.

getCreated() - Method in class net.sf.ehcache.constructs.web.PageInfo

The Date this PageInfo object was created

getFilterConfig() - Method in class net.sf.ehcache.constructs.web.filter.Filter

Returns the filter config.

getGzippedBody() - Method in class net.sf.ehcache.constructs.web.PageInfo

getHeaders() - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Gets the headers.

getOutputStream() - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Gets the outputstream.

getResponseHeaders() - Method in class net.sf.ehcache.constructs.web.PageInfo

Returns the headers of the response.

getSerializableCookies() - Method in class net.sf.ehcache.constructs.web.PageInfo

Returns the cookies of the response.

getStatus() - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Returns the status code for this response.

getStatusCode() - Method in class net.sf.ehcache.constructs.web.PageInfo

Returns the status code of the response.

getTimeToLiveSeconds() - Method in class net.sf.ehcache.constructs.web.PageInfo

The time to live in seconds.

getUngzippedBody() - Method in class net.sf.ehcache.constructs.web.PageInfo

getWriter() - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Gets the print writer.

GzipFilter - Class in net.sf.ehcache.constructs.web.filter

Provides GZIP compression of responses.

GzipFilter() - Constructor for class net.sf.ehcache.constructs.web.filter.GzipFilter

H

hasGzippedBody() - Method in class net.sf.ehcache.constructs.web.PageInfo

hasUngzippedBody() - Method in class net.sf.ehcache.constructs.web.PageInfo

HttpDateFormatter - Class in net.sf.ehcache.constructs.web

RFC 2616 - HTTP/1.1 Protocol

Section 3.3.1 defines the preferred full date and time as:

HttpDateFormatter() - Constructor for class net.sf.ehcache.constructs.web.HttpDateFormatter

Constructs a new formatter.

I

IncludeCachedPageServlet - Class in net.sf.ehcache.constructs.web.servlet

A Front Controller for the /CachedPage.jsp page.

IncludeCachedPageServlet() - Constructor for class net.sf.ehcache.constructs.web.servlet.IncludeCachedPageServlet

init(FilterConfig) - Method in class net.sf.ehcache.constructs.web.filter.Filter

Initialises the filter.

isGzipped(byte[]) - Static method in class net.sf.ehcache.constructs.web.PageInfo

Checks the first two bytes of the candidate byte array for the magic number 0x677a.

isOk() - Method in class net.sf.ehcache.constructs.web.PageInfo

Returns true if the response is Ok.

L

logRequestHeaders(HttpServletRequest) - Method in class net.sf.ehcache.constructs.web.filter.Filter

Logs the request headers, if debug is enabled.

N

NAME - Static variable in class net.sf.ehcache.constructs.web.filter.SimpleCachingHeadersPageCachingFilter

The name of the filter.

NAME - Static variable in class net.sf.ehcache.constructs.web.filter.SimplePageCachingFilterWithBlankPageProblem

The name of the filter.

NAME - Static variable in class net.sf.ehcache.constructs.web.filter.SimplePageFragmentCachingFilter

This filter's name

net.sf.ehcache.constructs.web - package net.sf.ehcache.constructs.web

Constructs useful for Java EE Web Container environments, specifically the Servlet 2.3 and later specifications.

net.sf.ehcache.constructs.web.filter - package net.sf.ehcache.constructs.web.filter

Caching filters compliant with the filters in the Servlet 2.3 specification.

net.sf.ehcache.constructs.web.servlet - package net.sf.ehcache.constructs.web.servlet

Servlets to test including and forwarding from a Front Controller

NO_FILTER - Static variable in class net.sf.ehcache.constructs.web.filter.Filter

If a request attribute NO_FILTER is set, then filtering will be skipped

P

PageFragmentCachingFilter - Class in net.sf.ehcache.constructs.web.filter

A Template for a page caching filter that is designed for "included" pages, eg: jsp:includes.

PageFragmentCachingFilter() - Constructor for class net.sf.ehcache.constructs.web.filter.PageFragmentCachingFilter

PageInfo - Class in net.sf.ehcache.constructs.web

A Serializable representation of a HttpServletResponse.

PageInfo(int, String, Collection, Collection, byte[], boolean, long) - Constructor for class net.sf.ehcache.constructs.web.PageInfo

Creates a PageInfo object representing the "page".

parseDateFromHttpDate(String) - Method in class net.sf.ehcache.constructs.web.HttpDateFormatter

Parses dates supplied in accordance with Section 3.3.1 of RFC 2616

processInitParams(FilterConfig) - Method in class net.sf.ehcache.constructs.web.filter.Filter

Processes initialisation parameters.

R

reset() - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Resets the response.

resetBuffer() - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Resets the buffers.

ResponseHeadersNotModifiableException - Exception in net.sf.ehcache.constructs.web

The HttpServletResponse.setHeader(String, String) method sets a response header with the given name and value.

ResponseHeadersNotModifiableException() - Constructor for exception net.sf.ehcache.constructs.web.ResponseHeadersNotModifiableException

Constructor for the exception

ResponseHeadersNotModifiableException(String) - Constructor for exception net.sf.ehcache.constructs.web.ResponseHeadersNotModifiableException

Constructs an exception with the message given

ResponseUtil - Class in net.sf.ehcache.constructs.web

A collection of response processing utilities, which are shared between 2 or more filters

S

sendError(int, String) - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Send the error.

sendError(int) - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Send the error.

sendRedirect(String) - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Send the redirect.

SerializableCookie - Class in net.sf.ehcache.constructs.web

A serializable cookie which wraps Cookie.

SerializableCookie(Cookie) - Constructor for class net.sf.ehcache.constructs.web.SerializableCookie

Creates a cookie.

setCacheNameIfAnyConfigured(FilterConfig) - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

Sets the cacheName from the filterConfig

setContentLength(int) - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Sets the content length.

setContentType(HttpServletResponse, PageInfo) - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

Set the content type.

setContentType(String) - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Sets the content type.

setCookies(PageInfo, HttpServletResponse) - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

Set the serializableCookies

setHeader(String, String) - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

setHeaders(PageInfo, boolean, HttpServletResponse) - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

Set the headers in the response object, excluding the Gzip header

setStatus(HttpServletResponse, PageInfo) - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

Status code

setStatus(int) - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Sets the status code for this response.

setStatus(int, String) - Method in class net.sf.ehcache.constructs.web.GenericResponseWrapper

Sets the status code for this response.

setTimeToLiveWithCheckForNeverExpires(long) - Method in class net.sf.ehcache.constructs.web.PageInfo

See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html To mark a response as "never expires," an origin server sends an Expires date approximately one year from the time the response is sent.

shouldBodyBeZero(HttpServletRequest, int) - Static method in class net.sf.ehcache.constructs.web.ResponseUtil

Performs a number of checks to ensure response saneness according to the rules of RFC2616: If the response code is HttpServletResponse.SC_NO_CONTENT then it is illegal for the body to contain anything.

shouldGzippedBodyBeZero(byte[], HttpServletRequest) - Static method in class net.sf.ehcache.constructs.web.ResponseUtil

Checks whether a gzipped body is actually empty and should just be zero.

ShutdownListener - Class in net.sf.ehcache.constructs.web

A ServletContextListener that shutsdown CacheManager.

ShutdownListener() - Constructor for class net.sf.ehcache.constructs.web.ShutdownListener

SimpleCachingHeadersPageCachingFilter - Class in net.sf.ehcache.constructs.web.filter

This Filter extends SimplePageCachingFilter, adding support for the HTTP cache headers: ETag, Last-Modified and Expires.

SimpleCachingHeadersPageCachingFilter() - Constructor for class net.sf.ehcache.constructs.web.filter.SimpleCachingHeadersPageCachingFilter

SimplePageCachingFilter - Class in net.sf.ehcache.constructs.web.filter

A simple page CachingFilter suitable for most uses.

SimplePageCachingFilter() - Constructor for class net.sf.ehcache.constructs.web.filter.SimplePageCachingFilter

SimplePageCachingFilterWithBlankPageProblem - Class in net.sf.ehcache.constructs.web.filter

This implementation only writes the response when it is not committed.

SimplePageCachingFilterWithBlankPageProblem() - Constructor for class net.sf.ehcache.constructs.web.filter.SimplePageCachingFilterWithBlankPageProblem

SimplePageFragmentCachingFilter - Class in net.sf.ehcache.constructs.web.filter

A simple page fragment CachingFilter suitable for most uses.

SimplePageFragmentCachingFilter() - Constructor for class net.sf.ehcache.constructs.web.filter.SimplePageFragmentCachingFilter

suppressStackTraces - Variable in class net.sf.ehcache.constructs.web.filter.Filter

Most Throwables in Web applications propagate to the user.

T

toCookie() - Method in class net.sf.ehcache.constructs.web.SerializableCookie

Builds a Cookie object from this object.

W

write(int) - Method in class net.sf.ehcache.constructs.web.filter.FilterServletOutputStream

Writes to the stream.

write(byte[]) - Method in class net.sf.ehcache.constructs.web.filter.FilterServletOutputStream

Writes to the stream.

write(byte[], int, int) - Method in class net.sf.ehcache.constructs.web.filter.FilterServletOutputStream

Writes to the stream.

writeContent(HttpServletRequest, HttpServletResponse, PageInfo) - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

Writes the response content.

writeResponse(HttpServletRequest, HttpServletResponse, PageInfo) - Method in class net.sf.ehcache.constructs.web.filter.CachingFilter

Writes the response from a PageInfo object.

writeResponse(HttpServletResponse, PageInfo) - Method in class net.sf.ehcache.constructs.web.filter.PageFragmentCachingFilter

Assembles a response from a cached page include.

writeResponse(HttpServletRequest, HttpServletResponse, PageInfo) - Method in class net.sf.ehcache.constructs.web.filter.SimpleCachingHeadersPageCachingFilter

Writes the response from a PageInfo object.

A B C D E F G H I L N P R S T W