net.anthavio.cache.CachingSettings 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;

/**
 * TODO shorter name
 * 
 * @author martin.vanek
 *
 */
public class CachingSettings {

	private final K userKey;

	private final long hardTtl; //seconds

	private final long softTtl; //seconds

	/**
	 * @param userKey - user provided cache key
	 * @param hardTtl - cache entry expiry time 
	 * @param softTtl - cache entry refresh time
	 * @param unit - time unit of ttl
	 * 
	 */
	public CachingSettings(K userKey, long hardTtl, long softTtl, TimeUnit unit) {
		if (userKey == null) {
			throw new IllegalArgumentException("Cache key is null");
		}
		this.userKey = userKey;

		hardTtl = unit.toSeconds(hardTtl);
		if (hardTtl <= 0) {
			throw new IllegalArgumentException("hardTtl " + hardTtl + " must be >= 1 second ");
		}
		this.hardTtl = hardTtl;

		softTtl = unit.toSeconds(softTtl);
		if (hardTtl < softTtl) {
			throw new IllegalArgumentException("hardTtl " + hardTtl + " must be >= softTtl " + softTtl);
		}
		this.softTtl = softTtl;
	}

	public K getUserKey() {
		return userKey;
	}

	public long getHardTtl() {
		return hardTtl;
	}

	protected long getHardExpire(long lastRefresh) {
		return lastRefresh + (hardTtl * 1000);
	}

	public long getSoftTtl() {
		return softTtl;
	}

	protected long getSoftExpire(long lastRefresh) {
		return lastRefresh + (softTtl * 1000);
	}

	@Override
	public String toString() {
		return "CachingSettings [userKey=" + userKey + ", hardTtl=" + hardTtl + ", softTtl=" + softTtl + "]";
	}

}