com.sun.appserv.web.cache.mapping

Class CacheMapping

java.lang.Object

com.sun.appserv.web.cache.mapping.CacheMapping

public class CacheMapping
extends Object

CacheMapping represents a cache target specified via servlet-name or a url-pattern, a timeout, allowed methods, a set of key fields to be used to construct the key into the cache, and a set of constraints on the field values.

Constructor Summary

Constructors

Constructor and Description
CacheMapping() default cache mapping

Method Summary

Modifier and Type	Method and Description
void	addConstraintField(ConstraintField field) add a constraint key field
void	addKeyField(Field field) add a key field
void	addMethod(String method) add an allowable HTTP method
boolean	findMethod(String method) Return true if the specified HTTP request method is allowed for caching
ConstraintField[]	getConstraintFields() get the constraint fields
String	getHelperNameRef() get helper-name-ref associated with this mapping
Field[]	getKeyFields() get the key fields
Field	getRefreshField() get the refresh field
String	getServletName() get the underlying servlet-name
int	getTimeout() get the timeout
Field	getTimeoutField() get the timeout field
String	getURLPattern() get the underlying url-pattern this mapping applicable
void	setHelperNameRef(String helperNameRef) set the helper name ref associated with this cache mapping
void	setMethods(String[] methods) set allowable HTTP methods
void	setRefreshField(Field field) set the refresh field
void	setServletName(String servletName) set the servlet-name this mapping applies
void	setTimeout(int timeout) set the timeout
void	setTimeoutField(Field field) set the timeout field
void	setURLPattern(String urlPattern) set the url-pattern this mapping applies

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheMapping

public CacheMapping()

default cache mapping

Method Detail

setHelperNameRef

public void setHelperNameRef(String helperNameRef)

set the helper name ref associated with this cache mapping

Parameters:

helperNameRef - helper name ref for this cache mapping

setServletName

public void setServletName(String servletName)

set the servlet-name this mapping applies

Parameters:

servletName - name of the servlet

setURLPattern

public void setURLPattern(String urlPattern)

set the url-pattern this mapping applies

Parameters:

urlPattern - url pattern this mapping applies

setTimeout

public void setTimeout(int timeout)

set the timeout

Parameters:

timeout - specific timeout of the cacheable entries

setTimeoutField

public void setTimeoutField(Field field)

set the timeout field

Parameters:

field - default timeout of the cacheable entries

setRefreshField

public void setRefreshField(Field field)

set the refresh field

Parameters:

field - Boolean field for controlling when a refresh is needed

getRefreshField

public Field getRefreshField()

get the refresh field

Returns:

Configured refresh field

setMethods

public void setMethods(String[] methods)

set allowable HTTP methods

Parameters:

methods - allowable methods

addMethod

public void addMethod(String method)

add an allowable HTTP method

Parameters:

method - allowable method

addKeyField

public void addKeyField(Field field)

add a key field

Parameters:

field - key Field to add

addConstraintField

public void addConstraintField(ConstraintField field)

add a constraint key field

Parameters:

field - ConstraintField to add

getHelperNameRef

public String getHelperNameRef()

get helper-name-ref associated with this mapping

Returns:

helper name associated

getServletName

public String getServletName()

get the underlying servlet-name

Returns:

servlet name

getURLPattern

public String getURLPattern()

get the underlying url-pattern this mapping applicable

Returns:

url-pattern string configured

findMethod

public boolean findMethod(String method)

Return true if the specified HTTP request method is allowed for caching

Parameters:

method - Request method to check

getTimeout

public int getTimeout()

get the timeout

Returns:

timeout value configured

getTimeoutField

public Field getTimeoutField()

get the timeout field

Returns:

timeout field configured

getKeyFields

public Field[] getKeyFields()

get the key fields

Returns:

key fields configured

getConstraintFields

public ConstraintField[] getConstraintFields()

get the constraint fields

Returns:

constraint fields configured