Package org.apache.manifoldcf.crawler.connectors.webcrawler

Class CookieManager.CookiesDescription

  • All Implemented Interfaces:
    org.apache.manifoldcf.core.interfaces.ICacheDescription
    Enclosing class:
    CookieManager
    protected static class CookieManager.CookiesDescription
extends org.apache.manifoldcf.core.cachemanager.BaseDescription
    This is the object description for a session key object. This is the key that is used to look up cached data.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.apache.manifoldcf.core.cachemanager.BaseDescription

        org.apache.manifoldcf.core.cachemanager.BaseDescription.LocalCacheClass

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.apache.manifoldcf.core.interfaces.StringSet cacheKeys  
      protected java.lang.String criticalSectionName  
      protected java.lang.String sessionKey  

      • Fields inherited from class org.apache.manifoldcf.core.cachemanager.BaseDescription

        _rcsid, cacheClass, MAX_VALUE

    • Constructor Summary

      Constructors 
      Constructor Description
      CookiesDescription​(java.lang.String sessionKey, org.apache.manifoldcf.core.interfaces.StringSet invKeys)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      java.lang.String getCriticalSectionName()  
      org.apache.manifoldcf.core.interfaces.ICacheClass getObjectClass()
      Get the object class for an object.
      org.apache.manifoldcf.core.interfaces.StringSet getObjectKeys()
      Get the cache keys for an object (which may or may not exist yet in the cache).
      java.lang.String getSessionKey()  
      int hashCode()  

      • Methods inherited from class org.apache.manifoldcf.core.cachemanager.BaseDescription

        getObjectExpirationTime

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • sessionKey

        protected java.lang.String sessionKey

      • criticalSectionName

        protected java.lang.String criticalSectionName

      • cacheKeys

        protected org.apache.manifoldcf.core.interfaces.StringSet cacheKeys

    • Constructor Detail

      • CookiesDescription

        public CookiesDescription​(java.lang.String sessionKey,
                          org.apache.manifoldcf.core.interfaces.StringSet invKeys)

    • Method Detail

      • getSessionKey

        public java.lang.String getSessionKey()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • getCriticalSectionName

        public java.lang.String getCriticalSectionName()

      • getObjectKeys

        public org.apache.manifoldcf.core.interfaces.StringSet getObjectKeys()
        Get the cache keys for an object (which may or may not exist yet in the cache). This method is called in order for cache manager to throw the correct locks.
        Returns:
        the object's cache keys, or null if the object should not be cached.

      • getObjectClass

        public org.apache.manifoldcf.core.interfaces.ICacheClass getObjectClass()
        Get the object class for an object. The object class is used to determine the group of objects treated in the same LRU manner.
        Specified by:
        getObjectClass in interface org.apache.manifoldcf.core.interfaces.ICacheDescription
        Overrides:
        getObjectClass in class org.apache.manifoldcf.core.cachemanager.BaseDescription
        Returns:
        the newly created object's object class, or null if there is no such class, and LRU behavior is not desired.