cache-mapping (Sun GlassFish Communications Server 2.0 Application Deployment Guide)

Sun GlassFish Communications Server 2.0 Application Deployment Guide

cache-mapping

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

cache (sun-web.xml)

The following table describes subelements for the cache-mapping element.

Table A–15 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 `dispatcher`, `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.
dispatcher	zero or one if `cache-helper-ref` is not used	Contains a comma-separated list of `RequestDispatcher` methods for which caching is enabled.
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 a 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`.