com.atlassian.jira.web.servlet

Class HttpResponseHeaders

java.lang.Object

com.atlassian.jira.web.servlet.HttpResponseHeaders

public class HttpResponseHeaders
extends Object

Utility methods for setting headers on the HTTP response.

Since:

v5.0

Field Summary

Fields

Modifier and Type	Field and Description
static long	ABOUT_ONE_YEAR_MILLIS Approximately one year, in milliseconds.
static long	ONE_DAY

Method Summary

Modifier and Type	Method and Description
static void	cachePrivatelyForAboutOneYear(javax.servlet.http.HttpServletResponse response) Sets the Cache-control and Expires headers to allow browsers, but not proxies, to cache the response for up to approximately 1 year.
static void	cachePrivatelyForSeconds(javax.servlet.http.HttpServletResponse response, long seconds)
static void	cachePubliclyForAboutOneYear(javax.servlet.http.HttpServletResponse response) Sets the Cache-control and Expires headers to allow browsers and proxies to cache the response for up to approximately 1 year.

Methods inherited from class java.lang.Object

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

Field Detail

ONE_DAY

public static final long ONE_DAY

See Also:

Constant Field Values

ABOUT_ONE_YEAR_MILLIS

public static final long ABOUT_ONE_YEAR_MILLIS

Approximately one year, in milliseconds.

Method Detail

cachePrivatelyForAboutOneYear

public static void cachePrivatelyForAboutOneYear(javax.servlet.http.HttpServletResponse response)

Sets the Cache-control and Expires headers to allow browsers, but not proxies, to cache the response for up to approximately 1 year. This kind of caching is appropriate for non-public content such as avatars, attachments, thumbnails, etc. More specifically, this sets the following headers:

   Cache-control: private, max-age=31536000
   Expires: Wed, 31 Dec 1969 23:59:59 GMT
 

The Expires header is set to a date in the past to prevent HTTP 1.0 proxies from caching what is non publicly-accessible content. Since the Cache-control header takes precendence over the Expires header, HTTP 1.1-capable proxies will still cache the data privately.

If the response already has a Cache-control header, it will be overwritten.

Parameters:

response - the HttpServletResponse on which we will set the header

Since:

v5.0

cachePrivatelyForSeconds

public static void cachePrivatelyForSeconds(javax.servlet.http.HttpServletResponse response,
                                            long seconds)

cachePubliclyForAboutOneYear

public static void cachePubliclyForAboutOneYear(javax.servlet.http.HttpServletResponse response)

Sets the Cache-control and Expires headers to allow browsers and proxies to cache the response for up to approximately 1 year. This kind of caching is appropriate for public content such as icons, sprites, etc.

   Cache-control: private, max-age=31536000
   Expires: "now" + 1 year
 

If the response already has a Cache-control header, it will be overwritten.

Parameters:

response - the HttpServletResponse on which we will set the header

Since:

v5.0