HHH-10770 JCache 2nd-level cache

* Provider and CacheManager creation
* Caches creation
* Region class hierarchy
* Different access strategies

Author: alexsnaps

hibernate-jcache/hibernate-jcache.gradle

@@ -0,0 +1,20 @@
+dependencies {
+    compile project( ':hibernate-core' )
+    compile( libraries.jcache )
+
+    testCompile project( ':hibernate-testing' )
+    testCompile( libraries.mockito )
+    testRuntime( libraries.ehcache3 )
+}
+
+def pomName() {
+    return 'Hibernate/JCache Integration'
+}
+
+def pomDescription() {
+    return 'Integration for javax.cache into Hibernate as a second-level caching service'
+}
+
+def osgiDescription() {
+    return pomDescription()
+}

hibernate-jcache/src/main/java/org/hibernate/cache/jcache/JCacheCollectionRegion.java

@@ -0,0 +1,45 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.cache.jcache;
+
+import javax.cache.Cache;
+import org.hibernate.boot.spi.SessionFactoryOptions;
+
+import org.hibernate.cache.CacheException;
+import org.hibernate.cache.jcache.access.NonStrictCollectionRegionAccessStrategy;
+import org.hibernate.cache.jcache.access.ReadOnlyCollectionRegionAccessStrategy;
+import org.hibernate.cache.jcache.access.ReadWriteCollectionRegionAccessStrategy;
+import org.hibernate.cache.spi.CacheDataDescription;
+import org.hibernate.cache.spi.CollectionRegion;
+import org.hibernate.cache.spi.access.AccessType;
+import org.hibernate.cache.spi.access.CollectionRegionAccessStrategy;
+
+/**
+ * @author Alex Snaps
+ */
+public class JCacheCollectionRegion extends JCacheTransactionalDataRegion implements CollectionRegion {
+
+	public JCacheCollectionRegion(Cache<Object, Object> cache, CacheDataDescription metadata, SessionFactoryOptions options) {
+		super( cache, metadata, options );
+	}
+
+	@Override
+	public CollectionRegionAccessStrategy buildAccessStrategy(AccessType accessType) throws CacheException {
+		switch ( accessType ) {
+			case READ_ONLY:
+				return new ReadOnlyCollectionRegionAccessStrategy( this );
+			case NONSTRICT_READ_WRITE:
+				return new NonStrictCollectionRegionAccessStrategy( this );
+			case READ_WRITE:
+				return new ReadWriteCollectionRegionAccessStrategy( this );
+			case TRANSACTIONAL:
+				throw new UnsupportedOperationException( "Implement me!" );
+			default:
+				throw new UnsupportedOperationException( "Unknown AccessType: " + accessType.name() );
+		}
+	}
+}

hibernate-jcache/src/main/java/org/hibernate/cache/jcache/JCacheEntityRegion.java

@@ -0,0 +1,50 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.cache.jcache;
+
+import javax.cache.Cache;
+
+import org.hibernate.boot.spi.SessionFactoryOptions;
+import org.hibernate.cache.CacheException;
+import org.hibernate.cache.jcache.access.NonStrictEntityRegionAccessStrategy;
+import org.hibernate.cache.jcache.access.ReadOnlyEntityRegionAccessStrategy;
+import org.hibernate.cache.jcache.access.ReadWriteEntityRegionAccessStrategy;
+import org.hibernate.cache.spi.CacheDataDescription;
+import org.hibernate.cache.spi.EntityRegion;
+import org.hibernate.cache.spi.access.AccessType;
+import org.hibernate.cache.spi.access.EntityRegionAccessStrategy;
+
+/**
+ * @author Alex Snaps
+ */
+public class JCacheEntityRegion extends JCacheTransactionalDataRegion implements EntityRegion {
+
+	public JCacheEntityRegion(Cache<Object, Object> cache, CacheDataDescription metadata, SessionFactoryOptions options) {
+		super( cache, metadata, options );
+	}
+
+	@Override
+	public EntityRegionAccessStrategy buildAccessStrategy(AccessType accessType) throws CacheException {
+		throwIfAccessTypeUnsupported( accessType );
+		switch ( accessType ) {
+			case READ_ONLY:
+				return new ReadOnlyEntityRegionAccessStrategy( this );
+			case NONSTRICT_READ_WRITE:
+				return new NonStrictEntityRegionAccessStrategy( this );
+			case READ_WRITE:
+				return new ReadWriteEntityRegionAccessStrategy( this );
+			case TRANSACTIONAL:
+				return createTransactionalEntityRegionAccessStrategy();
+			default:
+				throw new IllegalArgumentException( "Unknown AccessType: " + accessType );
+		}
+	}
+
+	protected EntityRegionAccessStrategy createTransactionalEntityRegionAccessStrategy() {
+		throw new UnsupportedOperationException("No org.hibernate.cache.spi.access.AccessType.TRANSACTIONAL support");
+	}
+}

hibernate-jcache/src/main/java/org/hibernate/cache/jcache/JCacheGeneralDataRegion.java

@@ -0,0 +1,44 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.cache.jcache;
+
+import javax.cache.Cache;
+
+import org.hibernate.cache.CacheException;
+import org.hibernate.cache.spi.GeneralDataRegion;
+import org.hibernate.engine.spi.SharedSessionContractImplementor;
+
+/**
+ * @author Alex Snaps
+ */
+public class JCacheGeneralDataRegion extends JCacheRegion implements GeneralDataRegion {
+
+	public JCacheGeneralDataRegion(Cache<Object, Object> cache) {
+		super( cache );
+	}
+
+	@Override
+	public Object get(SharedSessionContractImplementor session, Object key) throws CacheException {
+		return cache.get( key );
+	}
+
+	@Override
+	public void put(SharedSessionContractImplementor session, Object key, Object value) throws CacheException {
+		cache.put( key, value );
+	}
+
+	@Override
+	public void evict(Object key) throws CacheException {
+		cache.remove( key );
+	}
+
+	@Override
+	public void evictAll() throws CacheException {
+		cache.removeAll();
+	}
+
+}

hibernate-jcache/src/main/java/org/hibernate/cache/jcache/JCacheMessageLogger.java

@@ -0,0 +1,39 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.cache.jcache;
+
+import org.jboss.logging.annotations.LogMessage;
+import org.jboss.logging.annotations.Message;
+import org.jboss.logging.annotations.MessageLogger;
+
+import org.hibernate.internal.CoreMessageLogger;
+
+import static org.jboss.logging.Logger.Level.WARN;
+
+/**
+ * @author Alex Snaps
+ */
+@MessageLogger(projectCode = "HHH")
+public interface JCacheMessageLogger extends CoreMessageLogger {
+
+	static final int NAMESPACE = 40000;
+
+	@LogMessage(level = WARN)
+	@Message(
+			value = "Attempt to restart an already started JCacheRegionFactory.  Use sessionFactory.close() between " +
+					"repeated calls to buildSessionFactory. Using previously created JCacheRegionFactory.",
+			id = NAMESPACE + 1
+	)
+	void attemptToRestartAlreadyStartedJCacheProvider();
+
+	@LogMessage(level = WARN)
+	@Message(
+			value = "Attempt to restop an already stopped JCacheRegionFactory.",
+			id = NAMESPACE + 2
+	)
+	void attemptToRestopAlreadyStoppedJCacheProvider();
+}

hibernate-jcache/src/main/java/org/hibernate/cache/jcache/JCacheNaturalIdRegion.java

@@ -0,0 +1,45 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.cache.jcache;
+
+import javax.cache.Cache;
+
+import org.hibernate.boot.spi.SessionFactoryOptions;
+import org.hibernate.cache.CacheException;
+import org.hibernate.cache.jcache.access.NonStrictNaturalIdRegionAccessStrategy;
+import org.hibernate.cache.jcache.access.ReadOnlyNaturalIdRegionAccessStrategy;
+import org.hibernate.cache.jcache.access.ReadWriteNaturalIdRegionAccessStrategy;
+import org.hibernate.cache.spi.CacheDataDescription;
+import org.hibernate.cache.spi.NaturalIdRegion;
+import org.hibernate.cache.spi.access.AccessType;
+import org.hibernate.cache.spi.access.NaturalIdRegionAccessStrategy;
+
+/**
+ * @author Alex Snaps
+ */
+public class JCacheNaturalIdRegion extends JCacheTransactionalDataRegion implements NaturalIdRegion {
+
+	public JCacheNaturalIdRegion(Cache<Object, Object> cache, CacheDataDescription metadata, SessionFactoryOptions options) {
+		super( cache, metadata, options );
+	}
+
+	@Override
+	public NaturalIdRegionAccessStrategy buildAccessStrategy(AccessType accessType) throws CacheException {
+		switch ( accessType ) {
+			case READ_ONLY:
+				return new ReadOnlyNaturalIdRegionAccessStrategy( this );
+			case NONSTRICT_READ_WRITE:
+				return new NonStrictNaturalIdRegionAccessStrategy( this );
+			case READ_WRITE:
+				return new ReadWriteNaturalIdRegionAccessStrategy( this );
+			case TRANSACTIONAL:
+				throw new UnsupportedOperationException( "Implement me!" );
+			default:
+				throw new UnsupportedOperationException( "Unknown AccessType: " + accessType.name() );
+		}
+	}
+}

hibernate-jcache/src/main/java/org/hibernate/cache/jcache/JCacheQueryResultsRegion.java

@@ -0,0 +1,22 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.cache.jcache;
+
+import javax.cache.Cache;
+
+import org.hibernate.cache.spi.QueryResultsRegion;
+
+/**
+ * @author Alex Snaps
+ */
+public class JCacheQueryResultsRegion extends JCacheGeneralDataRegion implements QueryResultsRegion {
+
+	public JCacheQueryResultsRegion(Cache<Object, Object> cache) {
+		super( cache );
+	}
+
+}

hibernate-jcache/src/main/java/org/hibernate/cache/jcache/JCacheRegion.java

@@ -0,0 +1,73 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.cache.jcache;
+
+import java.util.HashMap;
+import java.util.Map;
+import javax.cache.Cache;
+
+import org.hibernate.cache.CacheException;
+import org.hibernate.cache.spi.Region;
+
+/**
+ * @author Alex Snaps
+ */
+public class JCacheRegion implements Region {
+
+	protected final Cache<Object, Object> cache;
+
+	public JCacheRegion(Cache<Object, Object> cache) {
+		if(cache == null) {
+			throw new NullPointerException("JCacheRegion requires a Cache!");
+		}
+		this.cache = cache;
+	}
+
+	public String getName() {
+		return cache.getName();
+	}
+
+	public void destroy() throws CacheException {
+		cache.getCacheManager().destroyCache( cache.getName() );
+	}
+
+	public boolean contains(Object key) {
+		return cache.containsKey( key );
+	}
+
+	public long getSizeInMemory() {
+		return -1;
+	}
+
+	public long getElementCountInMemory() {
+		return -1;
+	}
+
+	public long getElementCountOnDisk() {
+		return -1;
+	}
+
+	public Map toMap() {
+		final Map<Object, Object> map = new HashMap<Object, Object>();
+		for ( Cache.Entry<Object, Object> entry : cache ) {
+			map.put( entry.getKey(), entry.getValue() );
+		}
+		return map;
+	}
+
+	public long nextTimestamp() {
+		return JCacheRegionFactory.nextTS();
+	}
+
+	public int getTimeout() {
+		return JCacheRegionFactory.timeOut();
+	}
+
+	Cache<Object, Object> getCache() {
+		return cache;
+	}
+}