Package com.ibm.websphere.cache

Interface Cache

public interface Cache
Deprecated.
Use DistributedMap to store and manage objects in cache. DynamicCacheAccessor#getDistributedMap will return a DistributedMap for accessing base cache.
This is the underlying cache mechanism that is used by the servlet, JSP, webservices, command cache. It contains the methods used to inspect and manage the current state of the cache.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Deprecated.
    Use DistributedMap to store and manage objects in cache.
    Collection
    getAllDependencyIds()
    Deprecated.
    Use DistributedMap to store and manage objects in cache.
    Enumeration
    getAllIds()
    Deprecated.
    Use DistributedMap to store and manage objects in cache.
    Collection
    getCacheIdsByDependency(String dependency)
    Deprecated.
    Use DistributedMap to store and manage objects in cache.
    Collection
    getCacheIdsByTemplate(String template)
    Deprecated.
    Use DistributedMap to store and manage objects in cache.
    int
    getDefaultPriority()
    Deprecated.
    Use DistributedMap to store and manage objects in cache.
    CacheEntry
    getEntry(EntryInfo entryInfo)
    Deprecated.
    Use DistributedMap to store and manage objects in cache.
    CacheEntry
    getEntry(String id)
    Deprecated.
    Use DistributedMap to store and manage objects in cache.
    int
    getMaxNumberCacheEntries()
    Deprecated.
    Use DistributedMap to store and manage objects in cache.
    int
    getNumberCacheEntries()
    Deprecated.
    Use DistributedMap to store and manage objects in cache.
    Object
    getValue(EntryInfo entryInfo, boolean askPermission)
    Deprecated.
    Use DistributedMap to store and manage objects in cache.
    Object
    getValue(Object id, boolean askPermission)
    Deprecated.
    Use DistributedMap to store and manage objects in cache.
    Object
    getValue(String id, boolean askPermission)
    Deprecated.
    Use DistributedMap to store and manage objects in cache.
    void
    invalidateById(String id, boolean waitOnInvalidation)
    Deprecated.
    Use DistributedMap to store and manage objects in cache.
    void
    invalidateByTemplate(String template, boolean waitOnInvalidation)
    Deprecated.
    Use DistributedMap to store and manage objects in cache.

  • Method Details

    • getEntry

      CacheEntry getEntry(EntryInfo entryInfo)
      Deprecated.
      Use DistributedMap to store and manage objects in cache.
      This returns the cache entry identified by the specified entry info. It returns null if not in the cache.
      Parameters:
      entryInfo - The entry info object for the entry to be found. It cannot be null.
      Returns:
      The entry indentified by the cache id.
      See Also:

    • getEntry

      CacheEntry getEntry(String id)
      Deprecated.
      Use DistributedMap to store and manage objects in cache.
      This returns the cache entry identified by the specified cache id. It returns null if not in the cache.
      Parameters:
      id - The cache id object for the entry to be found. It cannot be null.
      Returns:
      The entry indentified by the cache id.
      See Also:

    • getValue

      Object getValue(EntryInfo entryInfo, boolean askPermission)
      Deprecated.
      Use DistributedMap to store and manage objects in cache.
      This tries to find a value in the cache. If it is not there, it will try to execute it.
      Parameters:
      entryInfo - The entry info object for the entry to be found. It cannot be null.
      askPermission - True implies that execution must ask the coordinating CacheUnit for permission.
      Returns:
      Value of the cache entry idetified by the entry info.
      See Also:

    • getValue

      Object getValue(String id, boolean askPermission)
      Deprecated.
      Use DistributedMap to store and manage objects in cache.
      This method tries to find a value in the cache. If it is not there, it will try to execute it.
      Parameters:
      id - The cache id for the entry to be found. It cannot be null.
      askPermission - True implies that execution must ask the coordinating CacheUnit for permission.
      See Also:

    • getValue

      Object getValue(Object id, boolean askPermission)
      Deprecated.
      Use DistributedMap to store and manage objects in cache.
      This method tries to find a value in the cache. If it is not there, it will try to execute it.
      Parameters:
      id - The cache id for the entry to be found. It cannot be null.
      askPermission - True implies that execution must ask the coordinating CacheUnit for permission.
      See Also:

    • invalidateById

      void invalidateById(String id, boolean waitOnInvalidation)
      Deprecated.
      Use DistributedMap to store and manage objects in cache.
      This method invalidates in all caches all entries dependent on the specified id.
      Parameters:
      id - The cache id or data id.
      waitOnInvalidation - True indicates that this method should not return until the invalidations have taken effect on all caches. False indicates that the invalidations will be queued for later batch processing.
      See Also:

    • invalidateByTemplate

      void invalidateByTemplate(String template, boolean waitOnInvalidation)
      Deprecated.
      Use DistributedMap to store and manage objects in cache.
      This method invalidates in all caches all entries dependent on the specified template.
      Parameters:
      template - The template name.
      waitOnInvalidation - True indicates that this method should not return until the invalidations have taken effect on all caches. False indicates that the invalidations will be queued for later batch processing.
      See Also:

    • clear

      void clear()
      Deprecated.
      Use DistributedMap to store and manage objects in cache.
      This method clears everything from the cache, so that it is just like when it was instantiated.
      See Also:

    • getAllIds

      Enumeration getAllIds()
      Deprecated.
      Use DistributedMap to store and manage objects in cache.
      This method returns the cache ids for all cache entries.
      Returns:
      The Enumeration of cache ids.
      See Also:

    • getMaxNumberCacheEntries

      int getMaxNumberCacheEntries()
      Deprecated.
      Use DistributedMap to store and manage objects in cache.
      This method gets the maximum number of cache entries.
      Returns:
      The maximum number of cache entries.
      See Also:

    • getNumberCacheEntries

      int getNumberCacheEntries()
      Deprecated.
      Use DistributedMap to store and manage objects in cache.
      This method gets the current number of cache entries.
      Returns:
      The current number of cache entries.
      See Also:

    • getDefaultPriority

      int getDefaultPriority()
      Deprecated.
      Use DistributedMap to store and manage objects in cache.
      This method gets the default priority value as set in the Admin GUI/dynacache.xml file.
      Returns:
      The default priority for this appserver.
      See Also:

    • getAllDependencyIds

      Collection getAllDependencyIds()
      Deprecated.
      Use DistributedMap to store and manage objects in cache.
      This method returns the dependency ids for all cache entries.
      Returns:
      A Collection of dependency ids.
      See Also:

    • getCacheIdsByDependency

      Collection getCacheIdsByDependency(String dependency)
      Deprecated.
      Use DistributedMap to store and manage objects in cache.
      This method returns the cache ids of the entries dependent on the dependency id passed as a parameter or null if no entry depends on it.
      Parameters:
      dependency - ID for which Cache IDs are needed.
      Returns:
      A Collection of cache IDs or null.
      See Also:

    • getCacheIdsByTemplate

      Collection getCacheIdsByTemplate(String template)
      Deprecated.
      Use DistributedMap to store and manage objects in cache.
      This method returns the cache ids of the entries that have the template passed as a parameter or null if no entry has this template.
      Parameters:
      template - for which Cache IDs are needed.
      Returns:
      A Collection of cache IDs or null.
      See Also: