com.ibm.websphere.servlet.cache
Interface IdGenerator


public interface IdGenerator

One IdGenerator instance will exist for each cacheable servlet identified in WebSphere. When implementing this interface, be aware that multiple threads may be using the same IdGenerator concurrently.

The IdGenerator normally is responsible for generating cache entry ids and data ids, and invalidating data ids.


Method Summary
 java.lang.String getId(ServletCacheRequest request)
          This method is called once on every request for a cacheable servlet.
 int getSharingPolicy(ServletCacheRequest request)
          This method is included for forward compatibility with later versions of WebSphere which will allow sharing of cache entries among different application servers.
 void initialize(CacheConfig cc)
          This method is called once on servlet initialization, and should take configuration values from its CacheConfig argurment and store them locally.
 

Method Detail

initialize

public void initialize(CacheConfig cc)
This method is called once on servlet initialization, and should take configuration values from its CacheConfig argurment and store them locally. Additional config information from user applications or other sources may be read here as well.

getId

public java.lang.String getId(ServletCacheRequest request)
This method is called once on every request for a cacheable servlet. It generates the id that is used as a key by the cache to identify the output of the servlet.
Returns:
a String uniquely identifying this invocation of a cacheable servlet.

getSharingPolicy

public int getSharingPolicy(ServletCacheRequest request)
This method is included for forward compatibility with later versions of WebSphere which will allow sharing of cache entries among different application servers. Since distributed caching is not currently available, it should return EntryInfo.NOT_SHARED, and do nothing else.
Returns:
the Sharing Policy of this cache entry