Package net.sf.ehcache.hibernate.strategy

Class ReadWriteEhcacheCollectionRegionAccessStrategy

  • All Implemented Interfaces:
    org.hibernate.cache.access.CollectionRegionAccessStrategy
    public class ReadWriteEhcacheCollectionRegionAccessStrategy
extends java.lang.Object
implements org.hibernate.cache.access.CollectionRegionAccessStrategy
    Ehcache specific read/write collection region access strategy
    Author:
    Chris Dennis

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected T region
      The wrapped Hibernate cache region.
      protected org.hibernate.cfg.Settings settings
      The settings for this persistence unit.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void decrementLock​(java.lang.Object key, AbstractReadWriteEhcacheAccessStrategy.Lock lock)
      Unlock and re-put the given key, lock combination.
      void evict​(java.lang.Object key)
      Remove the given mapping without regard to transactional safety
      void evictAll()
      Remove all mappings without regard to transactional safety
      java.lang.Object get​(java.lang.Object key, long txTimestamp)
      Returns null if the item is not readable.
      org.hibernate.cache.CollectionRegion getRegion()
      protected void handleMissingLock​(java.lang.Object key, AbstractReadWriteEhcacheAccessStrategy.Lockable lock)
      Handle the timeout of a previous lock mapped to this key
      org.hibernate.cache.access.SoftLock lockItem​(java.lang.Object key, java.lang.Object version)
      Soft-lock a cache item.
      org.hibernate.cache.access.SoftLock lockRegion()
      Region locks are not supported.
      boolean putFromLoad​(java.lang.Object key, java.lang.Object value, long txTimestamp, java.lang.Object version)
      This method is a placeholder for method signatures supplied by interfaces pulled in further down the class hierarchy.
      boolean putFromLoad​(java.lang.Object key, java.lang.Object value, long txTimestamp, java.lang.Object version, boolean minimalPutOverride)
      Returns false and fails to put the value if there is an existing un-writeable item mapped to this key.
      void remove​(java.lang.Object key)
      A no-op since this is an asynchronous cache access strategy.
      void removeAll()
      Called to evict data from the entire region
      void unlockItem​(java.lang.Object key, org.hibernate.cache.access.SoftLock lock)
      Soft-unlock a cache item.
      void unlockRegion​(org.hibernate.cache.access.SoftLock lock)
      Region locks are not supported - perform a cache clear as a precaution.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.hibernate.cache.access.CollectionRegionAccessStrategy

        evict, evictAll, get, lockItem, lockRegion, putFromLoad, putFromLoad, remove, removeAll, unlockItem, unlockRegion

    • Field Detail

      • settings

        protected final org.hibernate.cfg.Settings settings
        The settings for this persistence unit.

    • Constructor Detail

      • ReadWriteEhcacheCollectionRegionAccessStrategy

        public ReadWriteEhcacheCollectionRegionAccessStrategy​(EhcacheCollectionRegion region,
                                                      org.hibernate.cfg.Settings settings)
        Create a read/write access strategy accessing the given collection region.

    • Method Detail

      • getRegion

        public org.hibernate.cache.CollectionRegion getRegion()
        Specified by:
        getRegion in interface org.hibernate.cache.access.CollectionRegionAccessStrategy

      • get

        public final java.lang.Object get​(java.lang.Object key,
                                  long txTimestamp)
                           throws org.hibernate.cache.CacheException
        Returns null if the item is not readable. Locked items are not readable, nor are items created after the start of this transaction.
        Throws:
        org.hibernate.cache.CacheException
        See Also:
        EntityRegionAccessStrategy.get(java.lang.Object, long), CollectionRegionAccessStrategy.get(java.lang.Object, long)

      • putFromLoad

        public final boolean putFromLoad​(java.lang.Object key,
                                 java.lang.Object value,
                                 long txTimestamp,
                                 java.lang.Object version,
                                 boolean minimalPutOverride)
                          throws org.hibernate.cache.CacheException
        Returns false and fails to put the value if there is an existing un-writeable item mapped to this key.
        Throws:
        org.hibernate.cache.CacheException
        See Also:
        EntityRegionAccessStrategy.putFromLoad(java.lang.Object, java.lang.Object, long, java.lang.Object, boolean), CollectionRegionAccessStrategy.putFromLoad(java.lang.Object, java.lang.Object, long, java.lang.Object, boolean)

      • lockItem

        public final org.hibernate.cache.access.SoftLock lockItem​(java.lang.Object key,
                                                          java.lang.Object version)
                                                   throws org.hibernate.cache.CacheException
        Soft-lock a cache item.
        Throws:
        org.hibernate.cache.CacheException
        See Also:
        EntityRegionAccessStrategy.lockItem(java.lang.Object, java.lang.Object), CollectionRegionAccessStrategy.lockItem(java.lang.Object, java.lang.Object)

      • unlockItem

        public final void unlockItem​(java.lang.Object key,
                             org.hibernate.cache.access.SoftLock lock)
                      throws org.hibernate.cache.CacheException
        Soft-unlock a cache item.
        Throws:
        org.hibernate.cache.CacheException
        See Also:
        EntityRegionAccessStrategy.unlockItem(java.lang.Object, org.hibernate.cache.access.SoftLock), CollectionRegionAccessStrategy.unlockItem(java.lang.Object, org.hibernate.cache.access.SoftLock)

      • putFromLoad

        public final boolean putFromLoad​(java.lang.Object key,
                                 java.lang.Object value,
                                 long txTimestamp,
                                 java.lang.Object version)
                          throws org.hibernate.cache.CacheException
        This method is a placeholder for method signatures supplied by interfaces pulled in further down the class hierarchy.
        Throws:
        org.hibernate.cache.CacheException
        See Also:
        EntityRegionAccessStrategy.putFromLoad(java.lang.Object, java.lang.Object, long, java.lang.Object), CollectionRegionAccessStrategy.putFromLoad(java.lang.Object, java.lang.Object, long, java.lang.Object)

      • lockRegion

        public final org.hibernate.cache.access.SoftLock lockRegion()
        Region locks are not supported.
        Returns:
        null
        See Also:
        EntityRegionAccessStrategy.lockRegion(), CollectionRegionAccessStrategy.lockRegion()

      • unlockRegion

        public final void unlockRegion​(org.hibernate.cache.access.SoftLock lock)
                        throws org.hibernate.cache.CacheException
        Region locks are not supported - perform a cache clear as a precaution.
        Throws:
        org.hibernate.cache.CacheException
        See Also:
        EntityRegionAccessStrategy.unlockRegion(org.hibernate.cache.access.SoftLock), CollectionRegionAccessStrategy.unlockRegion(org.hibernate.cache.access.SoftLock)

      • remove

        public void remove​(java.lang.Object key)
            throws org.hibernate.cache.CacheException
        A no-op since this is an asynchronous cache access strategy.
        Throws:
        org.hibernate.cache.CacheException
        See Also:
        EntityRegionAccessStrategy.remove(java.lang.Object), CollectionRegionAccessStrategy.remove(java.lang.Object)

      • removeAll

        public final void removeAll()
                     throws org.hibernate.cache.CacheException
        Called to evict data from the entire region
        Throws:
        org.hibernate.cache.CacheException - Propogated from underlying Region
        See Also:
        EntityRegionAccessStrategy.removeAll(), CollectionRegionAccessStrategy.removeAll()

      • evict

        public final void evict​(java.lang.Object key)
                 throws org.hibernate.cache.CacheException
        Remove the given mapping without regard to transactional safety
        Throws:
        org.hibernate.cache.CacheException
        See Also:
        EntityRegionAccessStrategy.evict(java.lang.Object), CollectionRegionAccessStrategy.evict(java.lang.Object)

      • evictAll

        public final void evictAll()
                    throws org.hibernate.cache.CacheException
        Remove all mappings without regard to transactional safety
        Throws:
        org.hibernate.cache.CacheException
        See Also:
        EntityRegionAccessStrategy.evictAll(), CollectionRegionAccessStrategy.evictAll()