| /* |
| * 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 java.util.Set; |
| import org.apache.ignite.Ignite; |
| import org.apache.ignite.IgniteCheckedException; |
| import org.apache.ignite.IgniteException; |
| import org.apache.ignite.internal.processors.cache.distributed.near.GridNearTxLocal; |
| import org.apache.ignite.internal.util.GridLeanSet; |
| |
| import static org.apache.ignite.transactions.TransactionConcurrency.PESSIMISTIC; |
| import static org.apache.ignite.transactions.TransactionIsolation.REPEATABLE_READ; |
| |
| /** |
| * Implementation of READ_WRITE cache access strategy. |
| * <p> |
| * Configuration of L2 cache and per-entity cache access strategy can be set in the |
| * Hibernate configuration file: |
| * <pre name="code" class="xml"> |
| * <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> |
| * </pre> |
| * Also cache access strategy can be set using annotations: |
| * <pre name="code" class="java"> |
| * @javax.persistence.Entity |
| * @javax.persistence.Cacheable |
| * @org.hibernate.annotations.Cache(usage = CacheConcurrencyStrategy.READ_WRITE) |
| * public class Entity { ... } |
| * </pre> |
| */ |
| public class HibernateReadWriteAccessStrategy extends HibernateAccessStrategyAdapter { |
| /** */ |
| private final ThreadLocal<TxContext> txCtx; |
| |
| /** |
| * @param ignite Grid. |
| * @param cache Cache. |
| * @param txCtx Thread local instance used to track updates done during one Hibernate transaction. |
| * @param eConverter Exception converter. |
| */ |
| protected HibernateReadWriteAccessStrategy( |
| Ignite ignite, |
| HibernateCacheProxy cache, |
| ThreadLocal txCtx, |
| HibernateExceptionConverter eConverter) { |
| super(ignite, cache, eConverter); |
| |
| this.txCtx = (ThreadLocal<TxContext>)txCtx; |
| } |
| |
| /** {@inheritDoc} */ |
| @Override public Object get(Object key) { |
| boolean success = false; |
| |
| Object val = null; |
| |
| try { |
| val = cache.get(key); |
| |
| success = true; |
| |
| return val; |
| } |
| catch (IgniteCheckedException e) { |
| throw convertException(e); |
| } |
| finally { |
| if (!success) |
| rollbackCurrentTx(); |
| |
| if (log.isDebugEnabled()) { |
| log.debug("Get [cache=" + cache.name() + ", key=" + key + ", val=" + val + |
| ", success=" + success + ']'); |
| } |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| @Override public void putFromLoad(Object key, Object val) { |
| boolean success = false; |
| |
| try { |
| cache.put(key, val); |
| |
| success = true; |
| } |
| catch (IgniteCheckedException e) { |
| throw convertException(e); |
| } |
| finally { |
| if (!success) |
| rollbackCurrentTx(); |
| |
| if (log.isDebugEnabled()) { |
| log.debug("Put from load [cache=" + cache.name() + ", key=" + key + ", val=" + val + |
| ", success=" + success + ']'); |
| } |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| @Override public void lock(Object key) { |
| boolean success = false; |
| |
| try { |
| TxContext ctx = txCtx.get(); |
| |
| if (ctx == null) |
| txCtx.set(ctx = new TxContext()); |
| |
| lockKey(key); |
| |
| ctx.locked(key); |
| |
| success = true; |
| } |
| catch (IgniteCheckedException e) { |
| throw convertException(e); |
| } |
| finally { |
| if (!success) |
| rollbackCurrentTx(); |
| |
| if (log.isDebugEnabled()) |
| log.debug("Lock [cache=" + cache.name() + ", key=" + key + ", success=" + success + ']'); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| @Override public void unlock(Object key) { |
| boolean success = false; |
| |
| try { |
| TxContext ctx = txCtx.get(); |
| |
| if (ctx != null) |
| unlock(ctx, key); |
| |
| success = true; |
| } |
| catch (Exception e) { |
| throw convertException(e); |
| } |
| finally { |
| if (!success) |
| rollbackCurrentTx(); |
| |
| if (log.isDebugEnabled()) |
| log.debug("Unlock [cache=" + cache.name() + ", key=" + key + ", success=" + success + ']'); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| @Override public boolean update(Object key, Object val) { |
| return false; |
| } |
| |
| /** {@inheritDoc} */ |
| @Override public boolean afterUpdate(Object key, Object val) { |
| boolean success = false; |
| boolean res = false; |
| |
| try { |
| TxContext ctx = txCtx.get(); |
| |
| if (ctx != null) { |
| cache.put(key, val); |
| |
| unlock(ctx, key); |
| |
| res = true; |
| } |
| |
| success = true; |
| |
| return res; |
| } |
| catch (Exception e) { |
| throw convertException(e); |
| } |
| finally { |
| if (!success) |
| rollbackCurrentTx(); |
| |
| if (log.isDebugEnabled()) { |
| log.debug("Put after update [cache=" + cache.name() + ", key=" + key + ", val=" + val + |
| ", success=" + success + ']'); |
| } |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| @Override public boolean insert(Object key, Object val) { |
| return false; |
| } |
| |
| /** {@inheritDoc} */ |
| @Override public boolean afterInsert(Object key, Object val) { |
| boolean success = false; |
| |
| try { |
| cache.put(key, val); |
| |
| success = true; |
| |
| return true; |
| } |
| catch (IgniteCheckedException e) { |
| throw convertException(e); |
| } |
| finally { |
| if (!success) |
| rollbackCurrentTx(); |
| |
| if (log.isDebugEnabled()) { |
| log.debug("Put after insert [cache=" + cache.name() + ", key=" + key + ", val=" + val + |
| ", success=" + success + ']'); |
| } |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| @Override public void remove(Object key) { |
| boolean success = false; |
| |
| try { |
| TxContext ctx = txCtx.get(); |
| |
| if (ctx != null) |
| cache.remove(key); |
| |
| success = true; |
| } |
| catch (IgniteCheckedException e) { |
| throw convertException(e); |
| } |
| finally { |
| if (!success) |
| rollbackCurrentTx(); |
| |
| if (log.isDebugEnabled()) |
| log.debug("Remove [cache=" + cache.name() + ", key=" + key + ", success=" + success + ']'); |
| } |
| } |
| |
| /** |
| * |
| * @param ctx Transaction context. |
| * @param key Key. |
| */ |
| private void unlock(TxContext ctx, Object key) { |
| if (ctx.unlocked(key)) { // Finish transaction if last key is unlocked. |
| txCtx.remove(); |
| |
| GridNearTxLocal tx = cache.tx(); |
| |
| assert tx != null; |
| |
| try { |
| tx.proxy().commit(); |
| } |
| finally { |
| tx.proxy().close(); |
| } |
| |
| assert cache.tx() == null; |
| } |
| } |
| |
| /** |
| * Roll backs current transaction. |
| */ |
| private void rollbackCurrentTx() { |
| try { |
| TxContext ctx = txCtx.get(); |
| |
| if (ctx != null) { |
| txCtx.remove(); |
| |
| GridNearTxLocal tx = cache.tx(); |
| |
| if (tx != null) |
| tx.proxy().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<Object> locked = new GridLeanSet<>(); |
| |
| /** |
| * Marks key as locked. |
| * |
| * @param key Key. |
| */ |
| void locked(Object key) { |
| locked.add(key); |
| } |
| |
| /** |
| * Marks key as unlocked. |
| * |
| * @param key Key. |
| * @return {@code True} if last locked key was unlocked. |
| */ |
| boolean unlocked(Object key) { |
| locked.remove(key); |
| |
| return locked.isEmpty(); |
| } |
| } |
| } |