Package org.jivesoftware.admin

Class CacheControlFilter

java.lang.Object

org.jivesoftware.admin.CacheControlFilter

All Implemented Interfaces:

javax.servlet.Filter

public class CacheControlFilter
extends Object
implements javax.servlet.Filter

A servlet filter that sets HTTP Cache-Control headers for the Openfire Admin Console.

This filter distinguishes between static resources and dynamic administrative content:

• Static assets (images, scripts, stylesheets, fonts) receive configurable short-term caching headers to reduce redundant requests and improve responsiveness.
• Dynamic and administrative pages receive no-store/no-cache headers to prevent sensitive content from being cached by browsers or proxies.

Headers are applied after the filter chain has executed, and only when the response status indicates success (200 or 304). This prevents error responses from accidentally receiving cache headers. If a Cache-Control header has already been set by another servlet or filter, this filter will not overwrite it.

Both the set of static resource file extensions and the cache duration are configurable via Openfire system properties.

Author:

Milan Tyagi

See Also:

• STATIC_RESOURCE_EXTENSIONS
• STATIC_RESOURCE_MAX_AGE

Field Summary

Fields

Modifier and Type	Field	Description
static final SystemProperty<List<String>>	STATIC_RESOURCE_EXTENSIONS	A list of file extensions that are considered static resources.
static final SystemProperty<Duration>	STATIC_RESOURCE_MAX_AGE	The maximum duration that static resources may be cached by browsers and proxies.

Constructor Summary

Constructors

Constructor	Description
CacheControlFilter()

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
void	init(javax.servlet.FilterConfig filterConfig)

Methods inherited from class java.lang.Object

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

Field Details

STATIC_RESOURCE_EXTENSIONS

public static final SystemProperty<List<String>> STATIC_RESOURCE_EXTENSIONS

A list of file extensions that are considered static resources. Requests for resources matching these extensions will receive short-term caching headers.

STATIC_RESOURCE_MAX_AGE

public static final SystemProperty<Duration> STATIC_RESOURCE_MAX_AGE

The maximum duration that static resources may be cached by browsers and proxies. The default value is one hour (PT1H).

Constructor Details

CacheControlFilter

public CacheControlFilter()

Method Details

init

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

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

doFilter

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

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter