com.bankframe.ei.txnhandler.hostcache
Interface TimeoutCache

All Superinterfaces:

Cache, Profile

All Known Implementing Classes:

TimeoutMemoryCache

public interface TimeoutCache

extends Cache

Method Summary

boolean	checkPrimaryKeyInCache(DataPacket primaryKeyOfEntity) This method checks to see if the specified key is in the cache.
void	store(java.util.Map pkOfEntitiesToDataPacketResponses, long timeOut) This method is equivalent to store(pk,timeOut, false);
void	store(java.util.Map pkOfEntitiesToDataPacketResponses, long timeOut, boolean persistent) This method stores many entries in the cache at once.

Methods inherited from interface com.bankframe.ei.txnhandler.hostcache.Cache

checkPrimaryKeyInCache, close, open, remove, remove, retrieve, store, store

Methods inherited from interface com.bankframe.ei.txnhandler.hostcache.Profile

maxDbCacheSize, maxMemCacheSize, numberEntriesInDbCache, numberEntriesInMemCache

Method Detail

checkPrimaryKeyInCache

public boolean checkPrimaryKeyInCache(DataPacket primaryKeyOfEntity)
                               throws ProcessingErrorException

This method checks to see if the specified key is in the cache.

Parameters:

primaryKeyOfEntity - The primary key of the entity to check against.

Returns:

false if the entry is not in the cache or is timed out. Otherwise it returns true.

Throws:

ProcessingErrorException - If there was an exception thrown in the execution of the method.

store

public void store(java.util.Map pkOfEntitiesToDataPacketResponses,
                  long timeOut)
           throws ProcessingErrorException

This method is equivalent to store(pk,timeOut, false);

Parameters:

pkOfEntitiesToDataPacketResponses - Map containg key value pairs of primary key and entity DataPackets

timeOut - The length of time (in milliseconds) to cache the data.

Throws:

ProcessingErrorException - If there was an exception thrown in the execution of the method.

store

public void store(java.util.Map pkOfEntitiesToDataPacketResponses,
                  long timeOut,
                  boolean persistent)
           throws ProcessingErrorException

This method stores many entries in the cache at once. For each key, k the following must be true: encoder_.encode(k).length()

Parameters:

pkOfEntitiesToDataPacketResponses - Map containg key value pairs of primary key and entity DataPackets

timeOut - The length of time (in milliseconds) to cache the data.

persistent - If this is true the pair will be written to the database and upon restart it will be availiable again.

Throws:

ProcessingErrorException - If there was an exception thrown in the execution of the method.