Configuration Properties

Author: jonathanaustin

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

@@ -8,7 +8,6 @@
 import java.util.Map;
 import javax.cache.Cache;
 import javax.inject.Singleton;
-import org.apache.commons.configuration.Configuration;
 import org.apache.commons.lang3.tuple.ImmutableTriple;
 import org.apache.commons.lang3.tuple.Triple;
 import org.apache.commons.logging.Log;
@@ -88,13 +87,6 @@ private synchronized <K, V> void configCachePropertyValues(final String name, fi
 
 	}
 
-	/**
-	 * @return the parameter configuration
-	 */
-	private Configuration getParams() {
-		return Config.getInstance();
-	}
-
 	/**
 	 * Get an integer cache property.
 	 *
@@ -104,7 +96,7 @@ private Configuration getParams() {
 	 */
 	private Integer getIntegerProperty(final String name, final String property) {
 		// Cache property then default
-		return getParams().getInteger(getKey(name, property), null);
+		return Config.getInstance().getInteger(getKey(name, property), null);
 	}
 
 	/**

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

@@ -29,8 +29,9 @@ public synchronized void closeCacheManager() {
 	public synchronized <K, V> Cache<K, V> getOrCreateCache(final String name, final Class<K> keyClass, final Class<V> valueClass) {
 		Cache<K, V> cache = Caching.getCache(name, keyClass, valueClass);
 		if (cache == null) {
+			// Get cache duration
 			Duration duration = CachingProperties.getCacheDuration(name);
-			cache = getOrCreateCache(name, keyClass, valueClass, duration);
+			cache = createCache(name, keyClass, valueClass, duration);
 		}
 		return cache;
 	}
@@ -40,11 +41,9 @@ public synchronized <K, V> Cache<K, V> getOrCreateCache(final String name, final
 			final Class<V> valueClass, final Duration duration) {
 		Cache<K, V> cache = Caching.getCache(name, keyClass, valueClass);
 		if (cache == null) {
-			final CacheManager mgr = Caching.getCachingProvider().getCacheManager();
-			MutableConfiguration<K, V> config = new MutableConfiguration<>();
-			config.setTypes(keyClass, valueClass);
-			config.setExpiryPolicyFactory(AccessedExpiryPolicy.factoryOf(duration));
-			cache = mgr.createCache(name, config);
+			// Check for duration override
+			Duration durationOverride = CachingProperties.getCacheDuration(name, duration);
+			cache = createCache(name, keyClass, valueClass, durationOverride);
 		}
 		return cache;
 	}
@@ -60,4 +59,24 @@ public synchronized <K, V> Cache<K, V> getOrCreateCache(final String name, final
 		return cache;
 	}
 
+	/**
+	 * Create a cache.
+	 *
+	 * @param <K> the key type
+	 * @param <V> the value type
+	 * @param name the cache name
+	 * @param keyClass the key class type
+	 * @param valueClass the value class type
+	 * @param duration the cache duration amount
+	 * @return the cache
+	 */
+	protected synchronized <K, V> Cache<K, V> createCache(final String name, final Class<K> keyClass,
+			final Class<V> valueClass, final Duration duration) {
+		final CacheManager mgr = Caching.getCachingProvider().getCacheManager();
+		MutableConfiguration<K, V> config = new MutableConfiguration<>();
+		config.setTypes(keyClass, valueClass);
+		config.setExpiryPolicyFactory(AccessedExpiryPolicy.factoryOf(duration));
+		return mgr.createCache(name, config);
+	}
+
 }

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

@@ -28,10 +28,8 @@ public class TaskFutureWrapper<T extends Serializable> implements TaskFuture<T>
 	private final String id = UUID.randomUUID().toString();
 
 	static {
-		// Get future task cache name
-		String name = TaskMasterProperties.getFutureTaskCacheName();
 
-		// Get cache duration
+		String cacheName = TaskMasterProperties.FUTURE_TASK_CACHE_NAME;
 		Duration duration = TaskMasterProperties.getFutureTaskCacheDuration();
 
 		// Setup cache config
@@ -42,7 +40,7 @@ public class TaskFutureWrapper<T extends Serializable> implements TaskFuture<T>
 		config.setStoreByValue(false);
 
 		// Create Cache
-		CACHE = CachingHelper.getOrCreateCache(name, String.class, Future.class, config);
+		CACHE = CachingHelper.getOrCreateCache(cacheName, String.class, Future.class, config);
 	}
 
 	/**

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

@@ -11,6 +11,12 @@
  */
 public final class TaskMasterProperties {
 
+	/**
+	 * Future task cache name.
+	 */
+	public static final String FUTURE_TASK_CACHE_NAME = "bordertech-tm-future-task";
+
+	private static final Duration FUTURE_TASK_CACHE_DURATION = new Duration(TimeUnit.SECONDS, Long.valueOf("300"));
 	private static final String TP_PARAM_PREFIX = "bordertech.taskmaster.pool.";
 	private static final int DEFAULT_MAX_THREADS = 20;
 	private static final int DEFAULT_QUEUE_LENGTH = 0;
@@ -22,19 +28,12 @@ private TaskMasterProperties() {
 		//No-impl
 	}
 
-	/**
-	 * @return the future task cache name
-	 */
-	public static String getFutureTaskCacheName() {
-		return "bordertech-tm-future-task";
-	}
-
 	/**
 	 * @return the future task cache duration
 	 */
 	public static Duration getFutureTaskCacheDuration() {
-		Duration defaultDuration = new Duration(TimeUnit.SECONDS, Long.valueOf("300"));
-		return CachingProperties.getCacheDuration(getFutureTaskCacheName(), defaultDuration);
+		// Check for override
+		return CachingProperties.getCacheDuration(FUTURE_TASK_CACHE_NAME, FUTURE_TASK_CACHE_DURATION);
 	}
 
 	/**

taskmaster-service-helper/src/main/java/com/github/bordertech/taskmaster/service/impl/ServiceHelperProperties.java

@@ -12,49 +12,39 @@
 public final class ServiceHelperProperties {
 
 	/**
-	 * Private constructor for static class.
+	 * Default result holder cache name.
 	 */
-	private ServiceHelperProperties() {
-		//No-impl
-	}
+	public static final String RESULT_HOLDER_CACHE_NAME = "taskmaster-resultholder";
 
 	/**
-	 * @return the default result holder cache name
+	 * In progress cache name.
 	 */
-	public static String getDefaultResultHolderCacheName() {
-		return "taskmaster-resultholder";
-	}
+	public static final String INPROGRESS_CACHE_NAME = "taskmaster-inprogress";
 
-	/**
-	 * @return the default result holder cache duration
-	 */
-	public static Duration getDefaultResultHolderCacheDuration() {
-		Duration defaultDuration = new Duration(TimeUnit.SECONDS, Long.valueOf("1800"));
-		return CachingProperties.getCacheDuration(getDefaultResultHolderCacheName(), defaultDuration);
-	}
+	private static final Duration RESULT_HOLDER_CACHE_DURATION = new Duration(TimeUnit.SECONDS, Long.valueOf("1800"));
+	private static final Duration INPROGRESS_CACHE_DURATION = new Duration(TimeUnit.SECONDS, Long.valueOf("300"));
 
 	/**
-	 * @param name the result holder cache name
-	 * @return the result holder cache duration
+	 * Private constructor for static class.
 	 */
-	public static Duration getResultHolderCacheDuration(final String name) {
-		Duration defaultDuration = getDefaultResultHolderCacheDuration();
-		return CachingProperties.getCacheDuration(name, defaultDuration);
+	private ServiceHelperProperties() {
+		//No-impl
 	}
 
 	/**
-	 * @return the in progress cache name
+	 * @return the default result holder cache duration
 	 */
-	public static String getInProgressCacheName() {
-		return "taskmaster-inprogress";
+	public static Duration getResultHolderCacheDuration() {
+		// Check for overrides
+		return CachingProperties.getCacheDuration(ServiceHelperProperties.RESULT_HOLDER_CACHE_NAME, RESULT_HOLDER_CACHE_DURATION);
 	}
 
 	/**
 	 * @return the in progress cache duration
 	 */
 	public static Duration getInProgressCacheDuration() {
-		Duration defaultDuration = new Duration(TimeUnit.SECONDS, Long.valueOf("300"));
-		return CachingProperties.getCacheDuration(getInProgressCacheName(), defaultDuration);
+		// Check for overrides
+		return CachingProperties.getCacheDuration(ServiceHelperProperties.INPROGRESS_CACHE_NAME, INPROGRESS_CACHE_DURATION);
 	}
 
 	/**

taskmaster-service-helper/src/main/java/com/github/bordertech/taskmaster/service/impl/ServiceHelperProviderDefault.java

@@ -28,10 +28,9 @@ public class ServiceHelperProviderDefault implements ServiceHelperProvider {
 
 	static {
 		if (IN_PROGRESS_ENABLED) {
-			String name = ServiceHelperProperties.getInProgressCacheName();
-			// Setup the cache for tracking in progress ASync Cached service calls
-			Duration duration = ServiceHelperProperties.getInProgressCacheDuration();
-			IN_PROGRESS_CACHE = CachingHelper.getOrCreateCache(name, String.class, Boolean.class, duration);
+			String cacheName = ServiceHelperProperties.INPROGRESS_CACHE_NAME;
+			Duration defaultDuration = ServiceHelperProperties.getInProgressCacheDuration();
+			IN_PROGRESS_CACHE = CachingHelper.getOrCreateCache(cacheName, String.class, Boolean.class, defaultDuration);
 		} else {
 			IN_PROGRESS_CACHE = null;
 		}
@@ -220,11 +219,10 @@ protected <S extends Serializable, T extends Serializable> ResultHolder<S, T> ch
 	}
 
 	/**
-	 * Flag if tracking in progress ASync cached service calls which helps avoid multiple calls for the same service
-	 * call.
+	 * Flag if tracking in progress ASync cached service calls which helps avoid multiple calls for the same service call.
 	 * <p>
-	 * It only makes sense to track cached ASync calls as cached results are expected to be called multiple times and
-	 * Sync calls require the result immediately anyway.
+	 * It only makes sense to track cached ASync calls as cached results are expected to be called multiple times and Sync calls require the result
+	 * immediately anyway.
 	 * </p>
 	 *
 	 * @return true if tracking in progress ASync cached service calls

taskmaster-service-helper/src/main/java/com/github/bordertech/taskmaster/service/util/ServiceCacheUtil.java

@@ -1,6 +1,7 @@
 package com.github.bordertech.taskmaster.service.util;
 
 import com.github.bordertech.taskmaster.cache.CachingHelper;
+import com.github.bordertech.taskmaster.cache.impl.CachingProperties;
 import com.github.bordertech.taskmaster.service.ResultHolder;
 import com.github.bordertech.taskmaster.service.impl.ServiceHelperProperties;
 import javax.cache.Cache;
@@ -11,6 +12,11 @@
  * <p>
  * This helper provides a default cache or projects can create caches with assigned names.
  * </p>
+ * <p>
+ * The duration of the caches can be overridden by setting the runtime properties for {@link CachingProperties}.
+ * </p>
+ *
+ * @see CachingProperties
  */
 public final class ServiceCacheUtil {
 
@@ -27,9 +33,7 @@ private ServiceCacheUtil() {
 	 * @return the default result holder cache instance
 	 */
 	public static Cache<String, ResultHolder> getDefaultResultHolderCache() {
-		String name = ServiceHelperProperties.getDefaultResultHolderCacheName();
-		Duration duration = ServiceHelperProperties.getDefaultResultHolderCacheDuration();
-		return getResultHolderCache(name, duration);
+		return getResultHolderCache(ServiceHelperProperties.RESULT_HOLDER_CACHE_NAME);
 	}
 
 	/**
@@ -39,8 +43,7 @@ public static Cache<String, ResultHolder> getDefaultResultHolderCache() {
 	 * @return the cache instance
 	 */
 	public static Cache<String, ResultHolder> getResultHolderCache(final String name) {
-		Duration duration = ServiceHelperProperties.getResultHolderCacheDuration(name);
-		return getResultHolderCache(name, duration);
+		return getResultHolderCache(name, ServiceHelperProperties.getResultHolderCacheDuration());
 	}
 
 	/**