Configuring cacheable objects with the cachespec.xml file

Use this task to define cacheable objects inside the cachespec.xml, found inside the web module WEB-INF or enterprise bean META-INF directory.

1. Develop a cachespec.xml file.
   1. Create a caching configuration file.

      In the <app_server_root>/properties directory, locate the cachespec.sample.xml file.

   2. Copy the cachespec.sample.xml file to cachespec.xml in web module WEB-INF or enterprise bean META-INF directory.
2. Define the cache-entry elements necessary to identify the cacheable objects. See the cachespec.xml file topic for a list of elements.
3. Develop cache ID rules.

   To cache an object, WebSphere® Application Server must know how to generate unique IDs for different invocations of that object. The <cache-id> element performs that task. Each cache entry can have multiple cache-ID rules that run in order until either a rule returns cache-ID that is not empty or no more rules remain to run. If no cache-ID generation rules produce a valid cache ID, then the object is not cached. Develop the cache IDs in one of two ways:

   • Use the <component> element defined in the cache policy of a cache entry (recommended). Refer to the cachespec_xml file topic for more information about the <component> element.
   • Write custom Java™ code to build the ID from input variables and system state. To configure the cache entry to use the ID generator, specify your IdGenerator in the XML file by using the <idgenerator> tag, for example:

   <cache-entry>
        <class>servlet</class>
        <name>/servlet/CommandProcessor</name>
   		<cache-id>
        	<idgenerator>com.mycompany.SampleIdGeneratorImpl</idgenerator>
        	<timeout>60</timeout>
   		</cache-id>
   </cache-entry>

4. Specify dependency ID rules.
   Use dependency ID elements to specify additional cache group identifiers that associate multiple cache entries to the same group identifier.

   The dependency ID is generated by concatenating the dependency ID base string with the values returned by its component elements. If a required component returns a null value, then the entire dependency ID does not generate and is not used. You can validate the dependency IDs explicitly through the dynamic cache API, or use another cache-entry <invalidation> element. Multiple dependency ID rules can exist per cache entry. All dependency ID rules run separately. See cachespec.xml file topic for a list of <component> elements.

5. Invalidate other cache entries as a side effect of this object start, if relevant.
   You can define invalidation rules in exactly the same manner as dependency IDs. However, the IDs that are generated by invalidation rules are used to invalidate cache entries that have those same dependency IDs.

   The invalidation ID is generated by concatenating the invalidation ID base string with the values returned by its component element. If a required component returns a null value, then the entire invalidation ID is not generated and no invalidation occurs. Multiple invalidation rules can exist per cache-entry. All invalidation rules run separately.

6. Ensure your cache policy is working correctly.
   You can modify the policies within the cachespec.xml file while your application is running. The dynamic cache reloads the updated file automatically. If you are caching static content and you are adding the cache policy to an application for the first time, you must restart the application. You do not need to restart the application server to activate the new cache policy. Refer to the Verifying the cacheable page topic for more information.