org.hibernate.cache.redis.hibernate4.regions.RedisDataRegion Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-redis Show documentation
Hibernate 2nd cache provider with Redis
There is a newer version: 2.3.2
/*
 * Copyright (c) 2016. Sunghyouk Bae 
 * Licensed 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.hibernate.cache.redis.hibernate4.regions;

import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import org.hibernate.cache.CacheException;
import org.hibernate.cache.redis.client.RedisClient;
import org.hibernate.cache.redis.hibernate4.ConfigurableRedisRegionFactory;
import org.hibernate.cache.redis.hibernate4.strategy.RedisAccessStrategyFactory;
import org.hibernate.cache.redis.util.CacheTimestamper;
import org.hibernate.cache.redis.util.RedisCacheUtil;
import org.hibernate.cache.spi.Region;

import java.util.Collections;
import java.util.Map;
import java.util.Properties;

/**
 * Base DataRegion using Redis
 *
 * @author [email protected]
 * @since 13. 4. 5. 오후 8:48
 */
@Slf4j
public abstract class RedisDataRegion implements Region {

  @Getter
  protected final RedisAccessStrategyFactory accessStrategyFactory;

  /**
   * Region name
   */
  private final String name;

  /**
   * Redis client instance deal hibernate data region.
   */
  @Getter
  protected final RedisClient redis;

  private final CacheTimestamper cacheTimestamper;

  @Getter
  private final int cacheLockTimeout; // milliseconds
  @Getter
  private final int expiryInSeconds;  // seconds

  protected RedisDataRegion(RedisAccessStrategyFactory accessStrategyFactory,
                            RedisClient redis, ConfigurableRedisRegionFactory configurableRedisRegionFactory,
                            String regionName,
                            Properties props) {
    this.accessStrategyFactory = accessStrategyFactory;
    this.redis = redis;
    this.name = regionName;
    this.cacheTimestamper = configurableRedisRegionFactory.createCacheTimestamper(redis, regionName);

    this.cacheLockTimeout = 0;
    this.expiryInSeconds = RedisCacheUtil.getExpiryInSeconds(name);
    log.debug("redis region={}, expiryInSeconds={}", regionName, expiryInSeconds);
  }

  /**
   * Region name
   *
   * @return region name
   */
  public String getName() {
    return name;
  }

  /**
   * delete region
   */
  @Override
  public void destroy() throws CacheException {
    // NOTE: No need to delete region in HA mode
  }

  /**
   * confirm the specified key exists in current region
   *
   * @param key cache key
   * @return if cache key is exists in current region return true, else return false
   */
  @Override
  public boolean contains(Object key) {
    try {
      boolean exists = redis.exists(name, key);
      log.trace("cache contains items? region=[{}], key=[{}], contains=[{}]", name, key, exists);
      return exists;
    } catch (Throwable ignored) {
      log.warn("Fail to check contains key... region=" + name, ignored);
      return false;
    }
  }

  @Override
  public long getSizeInMemory() {
    try {
      return redis.dbSize();
    } catch (Throwable ignored) {
      log.warn("Fail to get count of cache items. region=" + name, ignored);
      return -1;
    }
  }

  @Override
  public long getElementCountInMemory() {
    try {
      return redis.keySizeInRegion(name);
    } catch (Throwable ignored) {
      log.warn("Fail to get count of cache items. region=" + name, ignored);
      return -1;
    }
  }

  @Override
  public long getElementCountOnDisk() {
    return -1;
  }

  @SuppressWarnings("unchecked")
  @Override
  public Map toMap() {
    try {
      return redis.getAll(name);
    } catch (Throwable e) {
      log.warn("Fail to build CacheEntry. return EmptyMap.", e);
      return Collections.emptyMap();
    }
  }

  @Override
  public long nextTimestamp() {
    return cacheTimestamper.next();
  }

  @Override
  public int getTimeout() {
    return cacheLockTimeout;
  }
}