cache-mapping (Sun Java System Web Server 6.1 SP7 Programmer's Guide to Web Applications)

Sun Java System Web Server 6.1 SP7 Programmer's Guide to Web Applications

cache-mapping

Maps a URL pattern or a servlet name to its cacheability constraints.

Subelements

The following table describes subelements for the cache-mapping element. The left column lists the subelement name, the middle column indicates the requirement rule, and the right column describes what the element does.

Table 6–33 cache-mapping Subelements


Element	Required	Description
servlet-name	requires one `servlet-name` or `url-pattern`	Contains the name of a servlet.
url-pattern	requires one `servlet-name` or `url-pattern`	Contains a servlet URL pattern for which caching is enabled.
cache-helper-ref	required if `timeout`, `refresh-field,http-method`, `key-field`, and `constraint-field` are not used	Contains the name of the `cache-helper` used by the parent `cache-mapping` element.
timeout	zero or one if `cache-helper-ref` is not used	Contains the `cache-mapping` specific maximum amount of time in seconds that an entry can remain in the cache after it is created or refreshed
refresh-field	zero or one if `cache-helper-ref` is not used	Specifies a field that gives the application component, programmatic way to refresh a cached entry.
http-method	zero or more if `cache-helper-ref` is not used	Contains an HTTP method that is eligible for caching.
key-field	zero or more if `cache-helper-ref` is not used	Specifies a component of the key used to look up and extract cache entries.
constraint-field	zero or more if `cache-helper-ref` is not used	Specifies a cacheability constraint for the given `url-pattern` or `servlet-name`.

Attributes

none