org.apache.ignite.cache.hibernate.HibernateReadWriteAccessStrategy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ignite-hibernate Show documentation
Java-based middleware for in-memory processing of big data in a distributed environment.
There is a newer version: 1.2.0-incubating
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.ignite.cache.hibernate;

import org.apache.ignite.*;
import org.apache.ignite.cache.*;
import org.apache.ignite.internal.util.*;
import org.apache.ignite.transactions.*;
import org.hibernate.cache.*;
import org.hibernate.cache.spi.access.*;

import java.util.*;

import static org.apache.ignite.transactions.TransactionConcurrency.*;
import static org.apache.ignite.transactions.TransactionIsolation.*;

/**
 * Implementation of {@link AccessType#READ_WRITE} cache access strategy.
 * 
 * Configuration of L2 cache and per-entity cache access strategy can be set in the
 * Hibernate configuration file:
 * 
 * <hibernate-configuration>
 *     <!-- Enable L2 cache. -->
 *     <property name="cache.use_second_level_cache">true</property>
 *
 *     <!-- Use Ignite as L2 cache provider. -->
 *     <property name="cache.region.factory_class">org.apache.ignite.cache.hibernate.HibernateRegionFactory</property>
 *
 *     <!-- Specify entity. -->
 *     <mapping class="com.example.Entity"/>
 *
 *     <!-- Enable L2 cache with read-write access strategy for entity. -->
 *     <class-cache class="com.example.Entity" usage="read-write"/>
 * </hibernate-configuration>
 * 
 * Also cache access strategy can be set using annotations:
 *  * @javax.persistence.Entity
 * @javax.persistence.Cacheable
 * @org.hibernate.annotations.Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
 * public class Entity { ... }
 * 
 */
public class HibernateReadWriteAccessStrategy extends HibernateAccessStrategyAdapter {
    /** */
    private final ThreadLocal txCtx;

    /**
     * @param ignite Grid.
     * @param cache Cache.
     * @param txCtx Thread local instance used to track updates done during one Hibernate transaction.
     */
    protected HibernateReadWriteAccessStrategy(Ignite ignite, GridCache cache, ThreadLocal txCtx) {
        super(ignite, cache);

        this.txCtx = (ThreadLocal)txCtx;
    }

    /** {@inheritDoc} */
    @Override protected Object get(Object key) throws CacheException {
        boolean success = false;
        
        try {
            Object o = cache.get(key);
            
            success = true;
            
            return o;
        }
        catch (IgniteCheckedException e) {
            throw new CacheException(e);
        }
        finally {
            if (!success)
                rollbackCurrentTx();
        }
    }

    /** {@inheritDoc} */
    @Override protected void putFromLoad(Object key, Object val) throws CacheException {
        boolean success = false;
        
        try {
            cache.putx(key, val);
            
            success = true;
        }
        catch (IgniteCheckedException e) {
            throw new CacheException(e);
        }
        finally {
            if (!success)
                rollbackCurrentTx();
        }
    }

    /** {@inheritDoc} */
    @Override protected SoftLock lock(Object key) throws CacheException {
        boolean success = false;
        
        try {
            TxContext ctx = txCtx.get();

            if (ctx == null)
                txCtx.set(ctx = new TxContext());

            lockKey(key);

            ctx.locked(key);
            
            success = true;

            return null;
        }
        catch (IgniteCheckedException e) {
            throw new CacheException(e);
        }
        finally {
            if (!success)
                rollbackCurrentTx();
        }
    }

    /** {@inheritDoc} */
    @Override protected void unlock(Object key, SoftLock lock) throws CacheException {
        boolean success = false;
        
        try {
            TxContext ctx = txCtx.get();

            if (ctx != null)
                unlock(ctx, key);
            
            success = true;
        }
        catch (Exception e) {
            throw new CacheException(e);
        }
        finally {
            if (!success)
                rollbackCurrentTx();
        }
    }

    /** {@inheritDoc} */
    @Override protected boolean update(Object key, Object val) throws CacheException {
        return false;
    }

    /** {@inheritDoc} */
    @Override protected boolean afterUpdate(Object key, Object val, SoftLock lock) throws CacheException {
        boolean success = false;
        boolean res = false;
        
        try {
            TxContext ctx = txCtx.get();

            if (ctx != null) {
                cache.putx(key, val);

                unlock(ctx, key);
                
                res = true;
            }
            
            success = true;

            return res;
        }
        catch (Exception e) {
            throw new CacheException(e);
        }
        finally {
            if (!success)
                rollbackCurrentTx();
        }
    }

    /** {@inheritDoc} */
    @Override protected boolean insert(Object key, Object val) throws CacheException {
        return false;
    }

    /** {@inheritDoc} */
    @Override protected boolean afterInsert(Object key, Object val) throws CacheException {
        boolean success = false;
        
        try {
            cache.putx(key, val);

            success = true;
            
            return true;
        }
        catch (IgniteCheckedException e) {
            throw new CacheException(e);
        }
        finally {
            if (!success)
                rollbackCurrentTx();
        }
    }

    /** {@inheritDoc} */
    @Override protected void remove(Object key) throws CacheException {
        boolean success = false;
        
        try {
            TxContext ctx = txCtx.get();

            if (ctx != null)
                cache.removex(key);
            
            success = true;
        }
        catch (IgniteCheckedException e) {
            throw new CacheException(e);
        }
        finally {
            if (!success)
                rollbackCurrentTx();
        }
    }

    /**
     *
     * @param ctx Transaction context.
     * @param key Key.
     * @throws CacheException If failed.
     */
    private void unlock(TxContext ctx, Object key) throws CacheException {
        if (ctx.unlocked(key)) { // Finish transaction if last key is unlocked.
            txCtx.remove();

            Transaction tx = cache.tx();

            assert tx != null;

            try {
                tx.commit();
            }
            finally {
                tx.close();
            }

            assert cache.tx() == null;
        }
    }

    /**
     * Roll backs current transaction.
     */
    private void rollbackCurrentTx() {
        try {
            TxContext ctx = txCtx.get();

            if (ctx != null) {
                txCtx.remove();

                Transaction tx = cache.tx();

                if (tx != null)
                    tx.rollback();
            }
        }
        catch (IgniteException e) {
            log.error("Failed to rollback cache transaction.", e);
        }
    }

    /**
     * @param key Key.
     * @throws IgniteCheckedException If failed.
     */
    private void lockKey(Object key) throws IgniteCheckedException {
        if (cache.tx() == null)
            cache.txStart(PESSIMISTIC, REPEATABLE_READ);

        cache.get(key); // Acquire distributed lock.
    }

    /**
     * Information about updates done during single database transaction.
     */
    @SuppressWarnings("TypeMayBeWeakened")
    private static class TxContext {
        /** */
        private Set