In progress functionality

Author: jonathanaustin

pom.xml

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

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

@@ -40,7 +40,7 @@ public CachingHelperProviderEhCache() {
 	}
 
 	@Override
-	public <K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass, final Class<V> valueClass) {
+	public synchronized <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);

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

@@ -29,7 +29,7 @@ public interface CachingHelperProvider {
 	 * @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);
+	<K, V> Cache<K, V> getOrCreateCache(String name, Class<K> keyClass, Class<V> valueClass);
 
 	/**
 	 * Create a cache with the specified duration.
@@ -42,7 +42,7 @@ public interface CachingHelperProvider {
 	 * @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, final Duration duration);
+	<K, V> Cache<K, V> getOrCreateCache(String name, Class<K> keyClass, Class<V> valueClass, Duration duration);
 
 	/**
 	 * Create a cache with the specified configuration.
@@ -55,6 +55,6 @@ public interface CachingHelperProvider {
 	 * @param config the cache configuration
 	 * @return the cache instance
 	 */
-	<K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass, final Class<V> valueClass, final Configuration<K, V> config);
+	<K, V> Cache<K, V> getOrCreateCache(String name, Class<K> keyClass, Class<V> valueClass, Configuration<K, V> config);
 
 }

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

@@ -27,7 +27,7 @@ public class CachingHelperProviderDefault implements CachingHelperProvider {
 
 		// Get unit
 		TimeUnit unit;
-		switch (unitType.toLowerCase()) {
+		switch (unitType) {
 			case "d":
 				unit = TimeUnit.DAYS;
 				break;
@@ -52,7 +52,7 @@ public synchronized void closeCacheManager() {
 	}
 
 	@Override
-	public <K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass, final Class<V> valueClass) {
+	public synchronized <K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass, final Class<V> valueClass) {
 		return getOrCreateCache(name, keyClass, valueClass, getDefaultDuration());
 	}
 

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

@@ -52,7 +52,7 @@ public synchronized void closeCacheManager() {
 	}
 
 	@Override
-	public <K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass, final Class<V> valueClass) {
+	public synchronized <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);
 	}

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

@@ -4,13 +4,12 @@
 import java.util.concurrent.Future;
 
 /**
- * Web applications require a {@link Future} implementation that can be serializable to allow the user session to be
- * serialized.
+ * Web applications require a {@link Future} implementation that can be serializable to allow the user session to be serialized.
  *
  * @param <T> the future get result type
  * @author Jonathan Austin
  * @since 1.0.0
  */
-public interface TaskFuture<T> extends Future<T>, Serializable {
+public interface TaskFuture<T extends Serializable> extends Future<T>, Serializable {
 
 }

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

@@ -3,20 +3,20 @@
 import com.github.bordertech.didums.Didums;
 import com.github.bordertech.taskmaster.exception.RejectedTaskException;
 import com.github.bordertech.taskmaster.impl.TaskMasterProviderExecutorService;
+import java.io.Serializable;
 
 /**
  * TaskMaster helps projects run ASYNC tasks.
  *
  * <p>
- * TaskMaster allows a Runnable task to be submitted for execution and returns a Future representing that task. The
- * Future's get method will return the given result upon successful completion.
+ * TaskMaster allows a Runnable task to be submitted for execution and returns a Future representing that task. The Future's get method will return
+ * the given result upon successful completion.
  * </p>
  * <p>
- * As Web applications require a Future implementation that can be serializable, the TaskMaster has a custom interface
- * TaskFuture that implements both Future and Serializable. It does not make sense for a Future to be Serializable as it
- * is running on a specific thread on a particular server. To allow a Web Application to keep a reference to the Future,
- * the default implementation of TaskFuture (ie TaskFutureWrapper) wraps the future by putting the Future on a cache and
- * holding onto the cache key that is serializable.
+ * As Web applications require a Future implementation that can be serializable, the TaskMaster has a custom interface TaskFuture that implements both
+ * Future and Serializable. It does not make sense for a Future to be Serializable as it is running on a specific thread on a particular server. To
+ * allow a Web Application to keep a reference to the Future, the default implementation of TaskFuture (ie TaskFutureWrapper) wraps the future by
+ * putting the Future on a cache and holding onto the cache key that is serializable.
  * </p>
  *
  * @author Jonathan Austin
@@ -40,11 +40,11 @@ public static TaskMasterProvider getProvider() {
 	}
 
 	/**
-	 * 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.
+	 * 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
+	 * @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();
@@ -53,8 +53,8 @@ public static void 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
+	 * @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();
@@ -73,7 +73,7 @@ public static void shutdownNow() {
 	 * @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 {
+	public static <T extends Serializable> TaskFuture<T> submit(final Runnable task, final T result) throws RejectedTaskException {
 		return PROVIDER.submit(task, result);
 	}
 
@@ -88,7 +88,7 @@ public static <T> TaskFuture<T> submit(final Runnable task, final T result) thro
 	 * @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 {
+	public static <T extends Serializable> 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/TaskMasterProvider.java

@@ -1,6 +1,7 @@
 package com.github.bordertech.taskmaster;
 
 import com.github.bordertech.taskmaster.exception.RejectedTaskException;
+import java.io.Serializable;
 
 /**
  * TaskMasterProvider helps projects run ASYNC tasks.
@@ -11,19 +12,19 @@
 public interface TaskMasterProvider {
 
 	/**
-	 * 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.
+	 * 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
+	 * @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
 	 */
 	void 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
+	 * @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
 	 */
 	void shutdownNow();
 
@@ -40,7 +41,7 @@ public interface TaskMasterProvider {
 	 * @return a Future representing pending completion of the task
 	 * @throws RejectedTaskException if the task cannot be scheduled for execution
 	 */
-	<T> TaskFuture<T> submit(final Runnable task, final T result) throws RejectedTaskException;
+	<T extends Serializable> TaskFuture<T> submit(Runnable task, T result) throws RejectedTaskException;
 
 	/**
 	 * Submits a Runnable task for execution and returns a Future representing that task. The Future's <tt>get</tt>
@@ -53,6 +54,6 @@ public interface TaskMasterProvider {
 	 * @return a Future representing pending completion of the task
 	 * @throws RejectedTaskException if the task cannot be scheduled for execution
 	 */
-	<T> TaskFuture<T> submit(final Runnable task, final T result, final String pool) throws RejectedTaskException;
+	<T extends Serializable> TaskFuture<T> submit(Runnable task, T result, String pool) throws RejectedTaskException;
 
 }

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

@@ -2,6 +2,7 @@
 
 import com.github.bordertech.taskmaster.TaskFuture;
 import com.github.bordertech.taskmaster.exception.TaskMasterException;
+import java.io.Serializable;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
@@ -14,7 +15,7 @@
  * @author Jonathan Austin
  * @since 1.0.0
  */
-public class TaskFutureResult<T> implements TaskFuture<T> {
+public class TaskFutureResult<T extends Serializable> implements TaskFuture<T> {
 
 	private final T result;
 
@@ -42,16 +43,24 @@ public boolean isDone() {
 
 	@Override
 	public T get() throws InterruptedException, ExecutionException {
-		if (result instanceof TaskMasterException) {
-			TaskMasterException excp = (TaskMasterException) result;
+		T res = getResult();
+		if (res instanceof TaskMasterException) {
+			TaskMasterException excp = (TaskMasterException) res;
 			throw new ExecutionException("Error processing future. " + excp.getMessage(), excp);
 		}
-		return result;
+		return res;
 	}
 
 	@Override
 	public T get(final long timeout, final TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException {
 		return get();
 	}
 
+	/**
+	 * @return the result
+	 */
+	protected T getResult() {
+		return result;
+	}
+
 }

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

@@ -4,6 +4,7 @@
 import com.github.bordertech.taskmaster.TaskFuture;
 import com.github.bordertech.taskmaster.cache.CachingHelper;
 import com.github.bordertech.taskmaster.exception.TaskMasterException;
+import java.io.Serializable;
 import java.util.UUID;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Future;
@@ -21,7 +22,7 @@
  * @author Jonathan Austin
  * @since 1.0.0
  */
-public class TaskFutureWrapper<T> implements TaskFuture<T> {
+public class TaskFutureWrapper<T extends Serializable> implements TaskFuture<T> {
 
 	private static final Cache<String, Future> CACHE;