com.ibm.websphere.cache

Interface Cache


  • Deprecated. 
    Use DistributedMap to store and manage objects in cache. DynamicCacheAccessor#getDistributedMap will return a DistributedMap for accessing base cache.

    public interface 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:
    DynamicCacheAccessor.getDistributedMap(), DistributedMap, DistributedObjectCache
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void clear()
      Deprecated. 
      Use DistributedMap to store and manage objects in cache.
      java.util.Collection getAllDependencyIds()
      Deprecated. 
      Use DistributedMap to store and manage objects in cache.
      java.util.Enumeration getAllIds()
      Deprecated. 
      Use DistributedMap to store and manage objects in cache.
      java.util.Collection getCacheIdsByDependency(java.lang.String dependency)
      Deprecated. 
      Use DistributedMap to store and manage objects in cache.
      java.util.Collection getCacheIdsByTemplate(java.lang.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(java.lang.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.
      java.lang.Object getValue(EntryInfo entryInfo, boolean askPermission)
      Deprecated. 
      Use DistributedMap to store and manage objects in cache.
      java.lang.Object getValue(java.lang.Object id, boolean askPermission)
      Deprecated. 
      Use DistributedMap to store and manage objects in cache.
      java.lang.Object getValue(java.lang.String id, boolean askPermission)
      Deprecated. 
      Use DistributedMap to store and manage objects in cache.
      void invalidateById(java.lang.String id, boolean waitOnInvalidation)
      Deprecated. 
      Use DistributedMap to store and manage objects in cache.
      void invalidateByTemplate(java.lang.String template, boolean waitOnInvalidation)
      Deprecated. 
      Use DistributedMap to store and manage objects in cache.
    • Method Detail

      • 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:
        DistributedMap, DistributedObjectCache
      • getEntry

        CacheEntry getEntry(java.lang.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:
        DistributedMap
      • getValue

        java.lang.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:
        DistributedMap
      • getValue

        java.lang.Object getValue(java.lang.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:
        DistributedMap
      • getValue

        java.lang.Object getValue(java.lang.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:
        DistributedMap
      • invalidateById

        void invalidateById(java.lang.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:
        DistributedMap
      • invalidateByTemplate

        void invalidateByTemplate(java.lang.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:
        DistributedMap
      • 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:
        DistributedMap
      • getAllIds

        java.util.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:
        DistributedMap
      • 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:
        DistributedMap
      • 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:
        DistributedMap
      • 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:
        DistributedMap
      • getAllDependencyIds

        java.util.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:
        DistributedMap
      • getCacheIdsByDependency

        java.util.Collection getCacheIdsByDependency(java.lang.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:
        DistributedMap
      • getCacheIdsByTemplate

        java.util.Collection getCacheIdsByTemplate(java.lang.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:
        DistributedMap
IBM WebSphere Application ServerTM
Release 8.5