net.ossindex.common

Interface IOssIndexCache

All Known Implementing Classes:

MapDbCache, MemoryCache

public interface IOssIndexCache

Load on the server is reduced by caching data wherever possible. This interface allows for multiple cache implementations, depending on the use case.

Author:

Ken Duck

Method Summary

Modifier and Type	Method and Description
void	cache(String requestString, String json) Cache the specified query
void	close() Ensure that the cache persists if required
void	commit() Commit any recent changes into the cache
String	get(String requestString) Get cached results, if they are available
String	get(String requestString, long delay) Return the cached value if the elapsed time is not passed.

Method Detail

cache

void cache(String requestString,
           String json)

Cache the specified query

Parameters:

requestString - Request that is being cached

json - Response to request

get

String get(String requestString)

Get cached results, if they are available

Parameters:

requestString - Request that was cached

Returns:

Response to request

get

String get(String requestString,
           long delay)

Return the cached value if the elapsed time is not passed. A delay of < 0 indicates that we should just use the cached value

Parameters:

requestString - Request that is being cached

delay - Elapsed time before we ignore the cached value

Returns:

Response to request

commit

void commit()

Commit any recent changes into the cache

close

void close()

Ensure that the cache persists if required