com.threecrickets.prudence.util

Class CacheControlFilter

java.lang.Object

org.restlet.Restlet

org.restlet.routing.Filter

com.threecrickets.prudence.util.CacheControlFilter

All Implemented Interfaces:

Uniform

public class CacheControlFilter
extends Filter

A Filter that adds cache control directives to responses.

Author:

Tal Liron

Field Summary

Fields

Modifier and Type	Field and Description
static int	FAR_FUTURE A far future max age (10 years)

Fields inherited from class org.restlet.routing.Filter

CONTINUE, SKIP, STOP

Constructor Summary

Constructors

Constructor and Description
CacheControlFilter(Context context) Construction with a default max age of -1 (meaning: do nothing).
CacheControlFilter(Context context, int defaultMaxAge) Construction with specific default max age.
CacheControlFilter(Context context, Restlet next) Construction with a default max age of -1 (meaning: do nothing).
CacheControlFilter(Context context, Restlet next, int defaultMaxAge) Construction with specific default max age.

Method Summary

Modifier and Type	Method and Description
protected void	afterHandle(Request request, Response response)
int	getDefaultMaxAge()
Map<MediaType,Number>	getMaxAgeForMediaType()
void	setDefaultMaxAge(int defaultMaxAge)
String	toString()

Methods inherited from class org.restlet.routing.Filter

beforeHandle, doHandle, getNext, handle, hasNext, setNext, setNext, start, stop

Methods inherited from class org.restlet.Restlet

createFinder, finalize, getApplication, getAuthor, getContext, getDescription, getFinderClass, getLogger, getName, getOwner, handle, handle, handle, isStarted, isStopped, setAuthor, setContext, setDescription, setFinderClass, setName, setOwner

Methods inherited from class java.lang.Object

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

Field Detail

FAR_FUTURE

public static int FAR_FUTURE

A far future max age (10 years)

Constructor Detail

CacheControlFilter

public CacheControlFilter(Context context)

Construction with a default max age of -1 (meaning: do nothing).

Parameters:

context - The context

CacheControlFilter

public CacheControlFilter(Context context,
                          Restlet next)

Construction with a default max age of -1 (meaning: do nothing).

Parameters:

context - The context

next - The next restlet

CacheControlFilter

public CacheControlFilter(Context context,
                          int defaultMaxAge)

Construction with specific default max age.

Parameters:

context - The context

defaultMaxAge - The default max age, in seconds, or a 0 to signify "no-cache", or a negative number to do nothing

CacheControlFilter

public CacheControlFilter(Context context,
                          Restlet next,
                          int defaultMaxAge)

Construction with specific default max age.

Parameters:

context - The context

next - The next restlet

defaultMaxAge - The default max age, in seconds, or a 0 to signify "no-cache", or a negative number to do nothing

Method Detail

getMaxAgeForMediaType

public Map<MediaType,Number> getMaxAgeForMediaType()

Returns:

A map of media types to their max age, in seconds, or a 0 to signify "no-cache"

getDefaultMaxAge

public int getDefaultMaxAge()

Returns:

The default max age, in seconds, or a 0 to signify "no-cache", or a negative number to do nothing

See Also:

setDefaultMaxAge(int)

setDefaultMaxAge

public void setDefaultMaxAge(int defaultMaxAge)

Parameters:

defaultMaxAge - The default max age, in seconds, or a 0 to signify "no-cache", or a negative number to do nothing

See Also:

getDefaultMaxAge()

afterHandle

protected void afterHandle(Request request,
                           Response response)

Overrides:

afterHandle in class Filter

toString

public String toString()

Overrides:

toString in class Object