Package com.ibm.websphere.servlet.cache

Interface IdGenerator

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

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.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getId(ServletCacheRequest request)
    This method is called once on every request for a cacheable servlet.
    int
    getSharingPolicy(ServletCacheRequest request)
    Deprecated. 
    void
    initialize(CacheConfig cc)
    Deprecated.
    This method is called once on servlet initialization, and should take configuration values from its CacheConfig argurment and store them locally.

  • Method Details

    • initialize

      void initialize(CacheConfig cc)
      Deprecated.
      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

      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.
      Parameters:
      request - The request object being used for this invocation
      Returns:
      a String uniquely identifying this invocation of a cacheable servlet.

    • getSharingPolicy

      int getSharingPolicy(ServletCacheRequest request)
      Deprecated.
      Returns:
      the Sharing Policy of this cache entry