sun-web.xml Visual Editor: Cache Helpers

See Also

The sun-web.xml visual editor lets you edit the platform-specific web deployment descriptor for Sun Java System Application Server. You open the visual editor by expanding your project's Configuration Files node in the Projects window and double-clicking the sun-web.xml file. A web application only contains a sun-web.xml deployment descriptor if its target server is the Sun Java System Application Server.

The Cache Helpers tab lets you configure a web application's default cache helper properties and cache helper definitions. The cache helper class is used by Application Server to determine caching criteria programmatically.

Default Helper Properties

Use the Default Helper properties panel to set the property of the built-in default cache-helper class.

Name Description
cacheKeyGeneratorAttrName

The servlet context attribute name containing the custom cache key generator class name.

The caching engine looks in the ServletContext for an attribute with a name equal to the value specified for this property to determine whether a customized CacheKeyGenerator implementation is used. An application may provide a customized key generator rather than using the default helper.

This property uses the built-in default cache-helper key generation, which concatenates the servlet path with key-field values, if any.

Cache Helper Properties

Use the Cache Helper properties panel to specify a class that implements the CacheHelper interface.

Name Description
name

Specify a unique valid Java identifier for the helper class, which is referenced in the cache-mapping element.

Class Name Type a fully qualified class name. It must extend the com.sun.appserv.web.CacheHelper class.
See Also
About Deployment Descriptors
Editing a Web Application's Deployment Descriptors
Changing the Target Server
sun-web.xml Visual Editor:
         General
         Session
         Messages
         Locale
         Cache Mappings
         Web Service Descriptor

Legal Notices