org.ldaptive.cache

Class LRUCache<Q extends SearchRequest>

java.lang.Object

org.ldaptive.cache.LRUCache<Q>

Type Parameters:

Q - type of search request

All Implemented Interfaces:

Cache<Q>

public class LRUCache<Q extends SearchRequest>
extends java.lang.Object
implements Cache<Q>

Least-Recently-Used cache implementation. Leverages a LinkedHashMap.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	LRUCache.Item Container for data related to cached ldap results.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<Q,LRUCache.Item>	cache Map to cache search results.
private java.util.concurrent.ScheduledExecutorService	executor Executor for performing eviction.
private static int	INITIAL_CAPACITY Initial capacity of the hash map.
private static float	LOAD_FACTOR Load factor of the hash map.

Constructor Summary

Constructors

Constructor and Description
LRUCache(int size, long timeToLive, long interval) Creates a new LRU cache.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all data from this cache.
void	close() Frees any resources associated with this cache.
SearchResult	get(Q request) Returns the ldap result for the supplied request.
void	put(Q request, SearchResult result) Stores the ldap result for the supplied request.
int	size() Returns the number of items in this cache.

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL_CAPACITY

private static final int INITIAL_CAPACITY

Initial capacity of the hash map.

See Also:

Constant Field Values

LOAD_FACTOR

private static final float LOAD_FACTOR

Load factor of the hash map.

See Also:

Constant Field Values

cache

private java.util.Map<Q extends SearchRequest,LRUCache.Item> cache

Map to cache search results.

executor

private final java.util.concurrent.ScheduledExecutorService executor

Executor for performing eviction.

Constructor Detail

LRUCache

public LRUCache(int size,
                long timeToLive,
                long interval)

Creates a new LRU cache.

Parameters:

size - number of results to cache

timeToLive - in seconds that results should stay in the cache

interval - in seconds to enforce timeToLive

Method Detail

clear

public void clear()

Removes all data from this cache.

get

public SearchResult get(Q request)

Description copied from interface: Cache

Returns the ldap result for the supplied request.

Specified by:

get in interface Cache<Q extends SearchRequest>

Parameters:

request - to find ldap result with

Returns:

ldap result

put

public void put(Q request,
                SearchResult result)

Description copied from interface: Cache

Stores the ldap result for the supplied request.

Specified by:

put in interface Cache<Q extends SearchRequest>

Parameters:

request - used to find ldap result

result - found with request

size

public int size()

Returns the number of items in this cache.

Returns:

size of this cache

close

public void close()

Frees any resources associated with this cache.