net.anthavio.cache.Builders Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hatatitla Show documentation
Compact but tweakable REST client library you have been dreaming of
The newest version!
package net.anthavio.cache;

import java.util.concurrent.TimeUnit;

import net.anthavio.httl.util.Cutils;

/**
 * 
 * @author martin.vanek
 *
 */
public class Builders {

	/**
	 * Most base builder of all builders. Uses generic self trick.
	 * 
	 * @author martin.vanek
	 *
	 * @param 
	 */
	public static abstract class BaseCacheRequestBuilder> {

		protected String cacheKey;

		protected long softTtl; //seconds

		protected long hardTtl; //seconds

		/**
		 * return generic self 
		 */
		protected abstract S getSelf();

		/**
		 * Sets caching key
		 */
		public S cacheKey(String key) {
			if (Cutils.isBlank(key)) {
				throw new IllegalArgumentException("Blank cache key");
			}
			this.cacheKey = key;
			return getSelf();
		}

		/**
		 * Sets both hard and soft TTL
		 */
		public S cache(long evictTtl, long expiryTtl, TimeUnit unit) {
			if (expiryTtl > evictTtl) {
				throw new IllegalArgumentException("Hard TTL must be greater then Soft TTL");
			}
			expiryTtl(expiryTtl, unit);
			evictTtl(evictTtl, unit);
			return getSelf();
		}

		/**
		 * Sets hard TTL - How long to keep resource in cache
		 */
		public S evictTtl(long evictTtl, TimeUnit unit) {
			if (unit == null) {
				throw new IllegalArgumentException("Caching unit is null");
			}

			this.hardTtl = unit.toSeconds(evictTtl);

			if (this.hardTtl < 1) {
				throw new IllegalArgumentException("Evict TTL must be at least 1 second");
			}

			if (this.softTtl == 0) {//if unset yet
				this.softTtl = this.hardTtl;
			}

			return getSelf();
		}

		/**
		 * Sets soft TTL - Interval between resource freshness checks
		 */
		public S expiryTtl(long expiryTtl, TimeUnit unit) {
			if (unit == null) {
				throw new IllegalArgumentException("Caching unit is null");
			}

			this.softTtl = unit.toSeconds(expiryTtl);

			if (this.softTtl < 1) {
				throw new IllegalArgumentException("Expiry TTL must be at least 1 second");
			}

			if (this.hardTtl == 0) {
				this.hardTtl = this.softTtl;
			}

			return getSelf();
		}

		protected CachingSettings buildCachingSettings() {
			return new CachingSettings(cacheKey, hardTtl, softTtl, TimeUnit.SECONDS);
		}

		/**
		 * Sets both hard and soft TTL to same value
		public S hardExpire(long ttl, TimeUnit unit) {
			if (unit == null) {
				throw new IllegalArgumentException("Caching unit is null");
			}
			this.hardTtl = unit.toSeconds(ttl);
			if (this.hardTtl <= 1) {
				throw new IllegalArgumentException("TTL must be at least 1 second");
			}
			this.softTtl = hardTtl;

			return getSelf();
		}
		*/
	}

	/**
	 * Concrete builder for CacheRequest
	 * 
	 * @author martin.vanek
	 *
	 * @param 
	 */
	public static class CacheRequestLoaderBuilder extends BaseCacheRequestBuilder> {

		private CacheEntryLoader loader;

		private boolean missingLoadAsync = false;

		private boolean expiredLoadAsync = false;

		public CacheRequestLoaderBuilder(CacheEntryLoader loader) {
			if (loader == null) {
				throw new IllegalArgumentException("Null loader");
			}
			this.loader = loader;
		}

		public CacheRequestLoaderBuilder async(boolean onMissing, boolean onExpired) {
			this.missingLoadAsync = onMissing;
			this.expiredLoadAsync = onExpired;
			return getSelf();
		}

		protected LoadingSettings buildLoadingSettings() {
			return new LoadingSettings(loader, missingLoadAsync, expiredLoadAsync);
		}

		public CacheLoadRequest build() {
			CachingSettings ci = buildCachingSettings();
			LoadingSettings li = buildLoadingSettings();
			return new CacheLoadRequest(ci, li);
		}

		@Override
		protected CacheRequestLoaderBuilder getSelf() {
			return this;
		}
	}

	/**
	 * @author martin.vanek
	 *
	 * @param 
	 */
	public static class CacheReadyRequestLoaderBuilder extends CacheRequestLoaderBuilder {

		private final CacheBase cache;

		public CacheReadyRequestLoaderBuilder(CacheBase cacheBase, CacheEntryLoader loader) {
			super(loader);
			if (cacheBase == null) {
				throw new IllegalArgumentException("Null cache");
			}
			this.cache = cacheBase;

		}

		public CacheEntry get() {
			return cache.get(build());
		}

		@Override
		protected CacheReadyRequestLoaderBuilder getSelf() {
			return this;
		}
	}

}