CacheVariable Definition

CacheVariable

A cache variable setting for id generation.

Attributes Summary

type Only one option may be chosen.

id The name of the variable.

method String, only available if Type is "Request Attribute" or "Session Parameter".

required Whether this variable's presence in the request/session is required to cache an invocation of this servlet.

dataId The data id string combines with the value of this variable to form a group id; thus, cache entries that have the same value for this variable will all be part of the same group.

invalidate Works just like data ids, except all members of the group generated will be removed from the cache.

Attribute Details

type
Only one option may be chosen. Type can either be "Request Parameter", "Request Attribute", or "Session Parameter". User data from an HTML form would be a Request Parameter, while a <jsp:useBean /> tag could be either a Request Attribute or a Session Parameter.

Data type: CacheVariableKind
Default value: unspecified
Allowed Values: REQUEST_PARAMETER REQUEST_ATTRIBUTE SESSION_PARAMETER COOKIE

id
The name of the variable. Equivalent to the "id" attribute in a <jsp:useBean />.

Data type: String
Default value: unspecified

method
String, only available if Type is "Request Attribute" or "Session Parameter". Defaults to toString. Request Attributes and Session Parameters are actually Java objects, so a method must be called on that object to retrieve data for the cache to use. Only used if the type is REQUEST_ATTRIBUTE or SESSION_PARAMETER.

Data type: String
Default value: unspecified

required
Whether this variable's presence in the request/session is required to cache an invocation of this servlet.

Data type: Boolean
Default value: unspecified

dataId
The data id string combines with the value of this variable to form a group id; thus, cache entries that have the same value for this variable will all be part of the same group. This group can then be invalidated all at once.

Data type: String
Default value: unspecified

invalidate
Works just like data ids, except all members of the group generated will be removed from the cache.

Data type: String
Default value: unspecified

Attributes Summary
type	Only one option may be chosen.
id	The name of the variable.
method	String, only available if Type is "Request Attribute" or "Session Parameter".
required	Whether this variable's presence in the request/session is required to cache an invocation of this servlet.
dataId	The data id string combines with the value of this variable to form a group id; thus, cache entries that have the same value for this variable will all be part of the same group.
invalidate	Works just like data ids, except all members of the group generated will be removed from the cache.