Initial refactor of ServiceHelper and add helper methods to TaskMaster

Author: jonathanaustin

pom.xml

@@ -17,6 +17,7 @@
 
 	<properties>
 		<bt.qa.skip>false</bt.qa.skip>
+		<dependency-check.skip>true</dependency-check.skip>
 	</properties>
 
 	<description>
@@ -98,7 +99,7 @@
 			<dependency>
 				<groupId>org.ehcache</groupId>
 				<artifactId>ehcache</artifactId>
-				<version>3.7.1</version>
+				<version>3.6.3</version>
 			</dependency>
 
 			<!-- Common Lang3 -->

taskmaster-cache-ehcache/src/main/java/com/github/bordertech/taskmaster/ehcache/CachingHelperProviderEhCache.java

@@ -40,9 +40,8 @@ public CachingHelperProviderEhCache() {
 	}
 
 	@Override
-	protected synchronized <K, V> Cache<K, V> handleGetCache(final String name, final Class<K> keyClass,
-			final Class<V> valueClass) {
-		Cache<K, V> cache = super.handleGetCache(name, keyClass, valueClass);
+	public <K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass, final Class<V> valueClass) {
+		Cache<K, V> cache = super.getOrCreateCache(name, keyClass, valueClass);
 		if (!caches.containsKey(name)) {
 			configCachePropertyValues(name, cache);
 			caches.put(name, new ImmutableTriple(name, keyClass, valueClass));

taskmaster-cache-helper/src/main/java/com/github/bordertech/taskmaster/cache/CachingHelper.java

@@ -2,6 +2,9 @@
 
 import com.github.bordertech.didums.Didums;
 import com.github.bordertech.taskmaster.cache.impl.CachingHelperProviderDefault;
+import javax.cache.Cache;
+import javax.cache.configuration.Configuration;
+import javax.cache.expiry.Duration;
 
 /**
  * Caching helper based on JSR 107.
@@ -28,4 +31,55 @@ public static CachingHelperProvider getProvider() {
 		return PROVIDER;
 	}
 
+	/**
+	 * Close and release the cache resources.
+	 */
+	public static void closeCacheManager() {
+		PROVIDER.closeCacheManager();
+	}
+
+	/**
+	 * Create a cache with the default configuration.
+	 *
+	 * @param name the cache name
+	 * @param keyClass the key class type
+	 * @param valueClass the value class type
+	 * @param <K> the cache entry key type
+	 * @param <V> the cache entry value value
+	 * @return the cache instance
+	 */
+	public static <K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass, final Class<V> valueClass) {
+		return PROVIDER.getOrCreateCache(name, keyClass, valueClass);
+	}
+
+	/**
+	 * Create a cache with the specified duration.
+	 *
+	 * @param name the cache name
+	 * @param keyClass the key class type
+	 * @param valueClass the value class type
+	 * @param duration the cache entry duration
+	 * @param <K> the cache entry key type
+	 * @param <V> the cache entry value value
+	 * @return the cache instance
+	 */
+	public static <K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass, final Class<V> valueClass, final Duration duration) {
+		return PROVIDER.getOrCreateCache(name, keyClass, valueClass, duration);
+	}
+
+	/**
+	 * Create a cache with the specified configuration.
+	 *
+	 * @param <K> the cache entry key type
+	 * @param <V> the cache entry value value
+	 * @param name the cache name
+	 * @param keyClass the key class type
+	 * @param valueClass the value class type
+	 * @param config the cache configuration
+	 * @return the cache instance
+	 */
+	public static <K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass, final Class<V> valueClass, final Configuration<K, V> config) {
+		return PROVIDER.getOrCreateCache(name, keyClass, valueClass, config);
+	}
+
 }

taskmaster-cache-helper/src/main/java/com/github/bordertech/taskmaster/cache/CachingHelperProvider.java

@@ -19,6 +19,18 @@ public interface CachingHelperProvider {
 	 */
 	void closeCacheManager();
 
+	/**
+	 * Create a cache with the default configuration.
+	 *
+	 * @param name the cache name
+	 * @param keyClass the key class type
+	 * @param valueClass the value class type
+	 * @param <K> the cache entry key type
+	 * @param <V> the cache entry value value
+	 * @return the cache instance
+	 */
+	<K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass, final Class<V> valueClass);
+
 	/**
 	 * Create a cache with the specified duration.
 	 *

taskmaster-cache-helper/src/main/java/com/github/bordertech/taskmaster/cache/impl/CachingHelperProviderDefault.java

@@ -1,6 +1,8 @@
 package com.github.bordertech.taskmaster.cache.impl;
 
+import com.github.bordertech.config.Config;
 import com.github.bordertech.taskmaster.cache.CachingHelperProvider;
+import java.util.concurrent.TimeUnit;
 import javax.cache.Cache;
 import javax.cache.CacheManager;
 import javax.cache.Caching;
@@ -17,6 +19,30 @@
  */
 public class CachingHelperProviderDefault implements CachingHelperProvider {
 
+	private static final Duration DEFAULT_DURATION;
+
+	static {
+		Long interval = Config.getInstance().getLong("bordertech.taskmaster.caching.default.duration", Long.valueOf("1800"));
+		String unitType = Config.getInstance().getString("bordertech.taskmaster.caching.default.unit", "s");
+
+		// Get unit
+		TimeUnit unit;
+		switch (unitType.toLowerCase()) {
+			case "d":
+				unit = TimeUnit.DAYS;
+				break;
+			case "h":
+				unit = TimeUnit.HOURS;
+				break;
+			case "m":
+				unit = TimeUnit.MINUTES;
+				break;
+			default:
+				unit = TimeUnit.SECONDS;
+		}
+		DEFAULT_DURATION = new Duration(unit, interval);
+	}
+
 	@Override
 	public synchronized void closeCacheManager() {
 		CachingProvider provider = Caching.getCachingProvider();
@@ -25,6 +51,11 @@ public synchronized void closeCacheManager() {
 		}
 	}
 
+	@Override
+	public <K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass, final Class<V> valueClass) {
+		return getOrCreateCache(name, keyClass, valueClass, getDefaultDuration());
+	}
+
 	@Override
 	public synchronized <K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass,
 			final Class<V> valueClass, final Duration duration) {
@@ -50,4 +81,11 @@ public synchronized <K, V> Cache<K, V> getOrCreateCache(final String name, final
 		return cache;
 	}
 
+	/**
+	 * @return the default duration
+	 */
+	protected Duration getDefaultDuration() {
+		return DEFAULT_DURATION;
+	}
+
 }

taskmaster-cache-helper/src/main/java/com/github/bordertech/taskmaster/cache/impl/CachingHelperProviderXmlConfig.java

@@ -51,33 +51,24 @@ public synchronized void closeCacheManager() {
 		}
 	}
 
+	@Override
+	public <K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass, final Class<V> valueClass) {
+		// Return the pre configured cache
+		return MANAGER.getCache(name, keyClass, valueClass);
+	}
+
 	@Override
 	public synchronized <K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass,
 			final Class<V> valueClass, final Duration duration) {
 		// Ignore duration
-		return handleGetCache(name, keyClass, valueClass);
+		return getOrCreateCache(name, keyClass, valueClass);
 	}
 
 	@Override
 	public synchronized <K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass,
 			final Class<V> valueClass, final Configuration<K, V> config) {
 		// Ignore config
-		return handleGetCache(name, keyClass, valueClass);
-	}
-
-	/**
-	 * Get the pre-configured cache.
-	 *
-	 * @param name the cache name
-	 * @param keyClass the cache key class
-	 * @param valueClass the cache entry class
-	 * @return the cache instance
-	 * @param <K> the cache key type
-	 * @param <V> the cache entry type
-	 */
-	protected synchronized <K, V> Cache<K, V> handleGetCache(final String name, final Class<K> keyClass,
-			final Class<V> valueClass) {
-		return MANAGER.getCache(name, keyClass, valueClass);
+		return getOrCreateCache(name, keyClass, valueClass);
 	}
 
 	/**

taskmaster-cache-helper/src/main/java/com/github/bordertech/taskmaster/cache/servlet/CachingProviderListener.java

@@ -16,7 +16,7 @@ public void contextInitialized(final ServletContextEvent sce) {
 
 	@Override
 	public void contextDestroyed(final ServletContextEvent sce) {
-		CachingHelper.getProvider().closeCacheManager();
+		CachingHelper.closeCacheManager();
 	}
 
 }

taskmaster-core/src/main/java/com/github/bordertech/taskmaster/TaskMaster.java

@@ -1,6 +1,7 @@
 package com.github.bordertech.taskmaster;
 
 import com.github.bordertech.didums.Didums;
+import com.github.bordertech.taskmaster.exception.RejectedTaskException;
 import com.github.bordertech.taskmaster.impl.TaskMasterProviderExecutorService;
 
 /**
@@ -38,4 +39,56 @@ public static TaskMasterProvider getProvider() {
 		return PROVIDER;
 	}
 
+	/**
+	 * Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be
+	 * accepted. Invocation has no additional effect if already shut down.
+	 *
+	 * @throws SecurityException if a security manager exists and shutting down this ExecutorService may manipulate
+	 * threads that the caller is not permitted to modify because it does not hold permission
+	 */
+	public static void shutdown() {
+		PROVIDER.shutdown();
+	}
+
+	/**
+	 * Attempts to stop all actively executing tasks, halts the processing of waiting tasks.
+	 *
+	 * @throws SecurityException if a security manager exists and shutting down this ExecutorService may manipulate
+	 * threads that the caller is not permitted to modify because it does not hold permission
+	 */
+	public static void shutdownNow() {
+		PROVIDER.shutdownNow();
+	}
+
+	/**
+	 * Submits a Runnable task for execution and returns a Future representing that task. The Future's <tt>get</tt>
+	 * method will return the given result upon successful completion.
+	 * <p>
+	 * Uses the default thread pool.
+	 * </p>
+	 *
+	 * @param <T> the type for the future
+	 * @param task the task to submit
+	 * @param result the result to return
+	 * @return a Future representing pending completion of the task
+	 * @throws RejectedTaskException if the task cannot be scheduled for execution
+	 */
+	public static <T> TaskFuture<T> submit(final Runnable task, final T result) throws RejectedTaskException {
+		return PROVIDER.submit(task, result);
+	}
+
+	/**
+	 * Submits a Runnable task for execution and returns a Future representing that task. The Future's <tt>get</tt>
+	 * method will return the given result upon successful completion.
+	 *
+	 * @param <T> the type for the future
+	 * @param task the task to submit
+	 * @param result the result to return
+	 * @param pool the thread pool name, or null if no pool
+	 * @return a Future representing pending completion of the task
+	 * @throws RejectedTaskException if the task cannot be scheduled for execution
+	 */
+	public static <T> TaskFuture<T> submit(final Runnable task, final T result, final String pool) throws RejectedTaskException {
+		return PROVIDER.submit(task, result, pool);
+	}
 }

taskmaster-core/src/main/java/com/github/bordertech/taskmaster/impl/TaskFutureWrapper.java

@@ -39,7 +39,7 @@ public class TaskFutureWrapper<T> implements TaskFuture<T> {
 		config.setStoreByValue(false);
 
 		// Create Cache
-		CACHE = CachingHelper.getProvider().getOrCreateCache("bordertech-tm-future-task", String.class, Future.class, config);
+		CACHE = CachingHelper.getOrCreateCache("bordertech-tm-future-task", String.class, Future.class, config);
 	}
 
 	/**

taskmaster-core/src/main/java/com/github/bordertech/taskmaster/servlet/TaskContextListener.java

@@ -41,6 +41,6 @@ public void contextInitialized(final ServletContextEvent servletContextEvent) {
 	@Override
 	public void contextDestroyed(final ServletContextEvent servletContextEvent) {
 		// Shutdown the task master
-		TaskMaster.getProvider().shutdown();
+		TaskMaster.shutdown();
 	}
 }