org.apache.archiva.components.cache.hashmap

Class HashMapCache<V,T>

java.lang.Object

org.apache.archiva.components.cache.AbstractCache<V,T>

org.apache.archiva.components.cache.hashmap.HashMapCache<V,T>

All Implemented Interfaces:

Cache<V,T>

@Service(value="cache#hashmap")
public class HashMapCache<V,T>
extends AbstractCache<V,T>
implements Cache<V,T>

HashMapCache - this is a Cache implementation taken from the Archiva project.

Original class written by Edwin Punzalan for purposes of addressing the jira ticket MRM-39

Configure the refreshTime in seconds value configure a ttl of object life in cache. Object get( Object key ) :

• < 0 : method will always return null (no cache)
• = 0 : first stored object will be return (infinite life in the cache)
• > 0 : after a live (stored time) of refreshTime the object will be remove from the cache and a no object will be returned by the method

Author:

Edwin Punzalan, Joakim Erdfelt

Constructor Summary

Constructors

Constructor and Description
HashMapCache()

Method Summary

Modifier and Type	Method and Description
void	clear() Empty the cache and reset the cache hit rate
T	get(V key) Check for a cached object and return it if it exists.
double	getCacheHitRatio()
int	getCacheMaxSize()
int	getRefreshTime()
CacheStatistics	getStatistics() Obtain a set of Statistics about the performance of the cache.
org.apache.archiva.components.cache.hashmap.HashMapCache.Stats	getStats()
boolean	hasKey(V key) Check if the specified key is already mapped to an object.
void	initialize()
protected boolean	isCacheAvailable()
protected boolean	needRefresh(CacheableWrapper cacheableWrapper)
T	put(V key, T value) Cache the given value and map it using the given key
void	register(V key, T value) Cache the given value and map it using the given key
T	remove(V key) Remove the specified key and value from the cache.
void	setCacheHitRatio(double cacheHitRatio)
void	setCacheMaxSize(int cacheMaxSize)
void	setRefreshTime(int refreshTime)

Methods inherited from class org.apache.archiva.components.cache.AbstractCache

getMaxElementsInMemory, getMaxElementsOnDisk, getTimeToIdleSeconds, getTimeToLiveSeconds, setMaxElementsInMemory, setMaxElementsOnDisk, setTimeToIdleSeconds, setTimeToLiveSeconds

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.archiva.components.cache.Cache

getMaxElementsInMemory, getMaxElementsOnDisk, getTimeToIdleSeconds, getTimeToLiveSeconds, setMaxElementsInMemory, setMaxElementsOnDisk, setTimeToIdleSeconds, setTimeToLiveSeconds

Constructor Detail

HashMapCache

public HashMapCache()

Method Detail

clear

public void clear()

Empty the cache and reset the cache hit rate

Specified by:

clear in interface Cache<V,T>

get

public T get(V key)

Check for a cached object and return it if it exists. Returns null when the keyed object is not found

Specified by:

get in interface Cache<V,T>

Parameters:

key - the key used to map the cached object

Returns:

the object mapped to the given key, or null if no cache object is mapped to the given key

needRefresh

protected boolean needRefresh(CacheableWrapper cacheableWrapper)

getStatistics

public CacheStatistics getStatistics()

Description copied from interface: Cache

Obtain a set of Statistics about the performance of the cache.

Specified by:

getStatistics in interface Cache<V,T>

Returns:

the cache statistics.

hasKey

public boolean hasKey(V key)

Check if the specified key is already mapped to an object.

Specified by:

hasKey in interface Cache<V,T>

Parameters:

key - the key used to map the cached object

Returns:

true if the cache contains an object associated with the given key

initialize

@PostConstruct
public void initialize()

put

public T put(V key,
             T value)

Cache the given value and map it using the given key

Specified by:

put in interface Cache<V,T>

Parameters:

key - the object to map the valued object

value - the object to cache

Returns:

the previous value for the key, or null if the key contained no value.

register

public void register(V key,
                     T value)

Cache the given value and map it using the given key

Specified by:

register in interface Cache<V,T>

Parameters:

key - the object to map the valued object

value - the object to cache

remove

public T remove(V key)

Description copied from interface: Cache

Remove the specified key and value from the cache.

Specified by:

remove in interface Cache<V,T>

Parameters:

key - the key to the value to remove.

Returns:

the value of the key that was removed.

getRefreshTime

public int getRefreshTime()

setRefreshTime

public void setRefreshTime(int refreshTime)

isCacheAvailable

protected boolean isCacheAvailable()

Returns:

true, if the cache is available, otherwise false

getCacheHitRatio

public double getCacheHitRatio()

setCacheHitRatio

public void setCacheHitRatio(double cacheHitRatio)

getCacheMaxSize

public int getCacheMaxSize()

setCacheMaxSize

public void setCacheMaxSize(int cacheMaxSize)

getStats

public org.apache.archiva.components.cache.hashmap.HashMapCache.Stats getStats()