grails.plugin.cache.web

Class PageInfo

java.lang.Object

grails.plugin.cache.web.PageInfo

All Implemented Interfaces:

java.io.Serializable

public class PageInfo
extends java.lang.Object
implements java.io.Serializable

A Serializable representation of a HttpServletResponse. Based on net.sf.ehcache.constructs.web.PageInfo and grails.plugin.springcache.web.HeadersCategory.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	contentType
protected java.util.Date	created
protected static int	FOUR_KB
protected static int	GZIP_MAGIC_NUMBER_BYTE_1
protected static int	GZIP_MAGIC_NUMBER_BYTE_2
protected byte[]	gzippedBody
protected HttpDateFormatter	httpDateFormatter
protected static java.util.Set<java.lang.String>	IGNORED_INTERFACES
protected static long	ONE_YEAR_IN_SECONDS
protected static java.util.regex.Pattern	PATTERN_CACHE_DIRECTIVE
protected java.util.Map<java.lang.String,java.io.Serializable>	requestAttributes
protected java.util.List<Header<? extends java.io.Serializable>>	responseHeaders
protected java.util.List<SerializableCookie>	serializableCookies
protected int	statusCode
protected boolean	storeGzipped
protected long	timeToLiveSeconds
protected byte[]	ungzippedBody

Constructor Summary

Constructors

Constructor and Description
PageInfo(int statusCode, java.lang.String contentType, byte[] body, boolean storeGzipped, long timeToLiveSeconds, java.util.Collection<Header<? extends java.io.Serializable>> headers, java.util.Collection<javax.servlet.http.Cookie> cookies, java.util.Map<java.lang.String,java.io.Serializable> requestAttributes) Creates a PageInfo object representing the "page".

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getCacheDirectives()
java.lang.String	getContentType()
java.util.Date	getCreated() The Date this PageInfo object was created
long	getDateHeader(java.lang.String headerName)
byte[]	getGzippedBody()
java.lang.String	getHeader(java.lang.String headerName)
java.util.List<Header<? extends java.io.Serializable>>	getHeaders()
java.util.Map<java.lang.String,java.io.Serializable>	getRequestAttributes()
java.util.List<SerializableCookie>	getSerializableCookies() Returns the cookies of the response.
int	getStatusCode() Returns the status code of the response.
long	getTimeToLiveSeconds() The time to live in seconds.
byte[]	getUngzippedBody()
protected byte[]	gzip(byte[] ungzipped)
boolean	hasGzippedBody()
boolean	hasUngzippedBody()
protected boolean	isBodyParameterGzipped() The response body will be assumed to be gzipped if the GZIP header has been set.
static boolean	isGzipped(byte[] candidate) Checks the first two bytes of the candidate byte array for the magic number 0x677a.
protected boolean	isInvalidObject(java.lang.Object object)
boolean	isMatch(javax.servlet.http.HttpServletRequest request) Returns true if the page's etag header indicates it is the same as the copy held by the client as indicated by the request's if-none-match header.
boolean	isModified(javax.servlet.http.HttpServletRequest request) Returns true if the page's last-modified header indicates it is newer than the copy held by the client as indicated by the request's if-modified-since header.
boolean	isOk() Returns true if the response is Ok.
protected void	setCacheableRequestAttributes(java.util.Map<java.lang.String,java.io.Serializable> attributes)
protected void	setTimeToLiveWithCheckForNeverExpires(long ttlSeconds) 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.
protected byte[]	ungzip(byte[] gzipped) A highly performant ungzip implementation.

Methods inherited from class java.lang.Object

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

Field Detail

PATTERN_CACHE_DIRECTIVE

protected static final java.util.regex.Pattern PATTERN_CACHE_DIRECTIVE

FOUR_KB

protected static final int FOUR_KB

See Also:

Constant Field Values

GZIP_MAGIC_NUMBER_BYTE_1

protected static final int GZIP_MAGIC_NUMBER_BYTE_1

See Also:

Constant Field Values

GZIP_MAGIC_NUMBER_BYTE_2

protected static final int GZIP_MAGIC_NUMBER_BYTE_2

See Also:

Constant Field Values

ONE_YEAR_IN_SECONDS

protected static final long ONE_YEAR_IN_SECONDS

See Also:

Constant Field Values

IGNORED_INTERFACES

protected static final java.util.Set<java.lang.String> IGNORED_INTERFACES

httpDateFormatter

protected final HttpDateFormatter httpDateFormatter

responseHeaders

protected final java.util.List<Header<? extends java.io.Serializable>> responseHeaders

serializableCookies

protected final java.util.List<SerializableCookie> serializableCookies

requestAttributes

protected java.util.Map<java.lang.String,java.io.Serializable> requestAttributes

contentType

protected java.lang.String contentType

gzippedBody

protected byte[] gzippedBody

ungzippedBody

protected byte[] ungzippedBody

statusCode

protected int statusCode

storeGzipped

protected boolean storeGzipped

created

protected java.util.Date created

timeToLiveSeconds

protected long timeToLiveSeconds

Constructor Detail

PageInfo

public PageInfo(int statusCode,
        java.lang.String contentType,
        byte[] body,
        boolean storeGzipped,
        long timeToLiveSeconds,
        java.util.Collection<Header<? extends java.io.Serializable>> headers,
        java.util.Collection<javax.servlet.http.Cookie> cookies,
        java.util.Map<java.lang.String,java.io.Serializable> requestAttributes)
         throws AlreadyGzippedException

Creates a PageInfo object representing the "page".

Parameters:

statusCode -

contentType -

cookies -

body -

storeGzipped - set this to false for images and page fragments which should never

timeToLiveSeconds - the time to Live in seconds. 0 means maximum, which is one year per RFC2616.

headers -

cookies -

requestAttributes -

Throws:

AlreadyGzippedException

Method Detail

setTimeToLiveWithCheckForNeverExpires

protected void setTimeToLiveWithCheckForNeverExpires(long ttlSeconds)

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. HTTP/1.1 servers SHOULD NOT send Expires dates more than one year in the future.

Parameters:

ttlSeconds - accepts 0, which means eternal. If the time is 0 or greater than one year, it is set to one year in accordance with the RFC.

Note: PageInfo does not hold a reference to the Element and therefore does not know what the Element ttl is. It would normally make most sense to set the TTL to the same as the element expiry.

gzip

protected byte[] gzip(byte[] ungzipped)
               throws java.io.IOException,
                      AlreadyGzippedException

Parameters:

ungzipped - the bytes to be gzipped

Returns:

gzipped bytes

Throws:

java.io.IOException

AlreadyGzippedException

isBodyParameterGzipped

protected boolean isBodyParameterGzipped()

The response body will be assumed to be gzipped if the GZIP header has been set.

Returns:

true if the body is gzipped

isGzipped

public static boolean isGzipped(byte[] candidate)

Checks the first two bytes of the candidate byte array for the magic number 0x677a. This magic number was obtained from /usr/share/file/magic. The line for gzip is:

14 beshort 0x677a (gzipped)

Parameters:

candidate - the byte array to check

Returns:

true if gzipped, false if null, less than two bytes or not gzipped

getContentType

public java.lang.String getContentType()

Returns:

the content type of the response.

getGzippedBody

public byte[] getGzippedBody()

Returns:

the gzipped version of the body if the content is storeGzipped, otherwise null

getHeaders

public java.util.List<Header<? extends java.io.Serializable>> getHeaders()

Returns:

All of the headers set on the page

getSerializableCookies

public java.util.List<SerializableCookie> getSerializableCookies()

Returns the cookies of the response.

Returns:

List of cookies

getStatusCode

public int getStatusCode()

Returns the status code of the response.

Returns:

status code

getUngzippedBody

public byte[] getUngzippedBody()
                        throws java.io.IOException

Returns:

the ungzipped version of the body. This gunzipped on demand when storedGzipped, otherwise the ungzipped body is returned.

Throws:

java.io.IOException - IOException

ungzip

protected byte[] ungzip(byte[] gzipped)
                 throws java.io.IOException

A highly performant ungzip implementation. Do not refactor this without taking new timings. See ElementTest for timings

Parameters:

gzipped - the gzipped content

Returns:

an ungzipped byte[]

Throws:

java.io.IOException - IOException

hasGzippedBody

public boolean hasGzippedBody()

Returns:

true if there is a non null gzipped body

hasUngzippedBody

public boolean hasUngzippedBody()

Returns:

true if there is a non null ungzipped body

isOk

public boolean isOk()

Returns true if the response is Ok.

Returns:

true if the response code is 200.

getCreated

public java.util.Date getCreated()

The Date this PageInfo object was created

getTimeToLiveSeconds

public long getTimeToLiveSeconds()

The time to live in seconds.

Returns:

the time to live, or 0 if the wrapping element is eternal

getRequestAttributes

public java.util.Map<java.lang.String,java.io.Serializable> getRequestAttributes()

getHeader

public java.lang.String getHeader(java.lang.String headerName)

getDateHeader

public long getDateHeader(java.lang.String headerName)

isModified

public boolean isModified(javax.servlet.http.HttpServletRequest request)

Returns true if the page's last-modified header indicates it is newer than the copy held by the client as indicated by the request's if-modified-since header.

isMatch

public boolean isMatch(javax.servlet.http.HttpServletRequest request)

Returns true if the page's etag header indicates it is the same as the copy held by the client as indicated by the request's if-none-match header.

getCacheDirectives

public java.util.Map<java.lang.String,java.lang.Object> getCacheDirectives()

setCacheableRequestAttributes

protected void setCacheableRequestAttributes(java.util.Map<java.lang.String,java.io.Serializable> attributes)

isInvalidObject

protected boolean isInvalidObject(java.lang.Object object)