com.bankframe.ei.txnhandler.hostcache
Interface Cache

All Superinterfaces:

Profile

All Known Subinterfaces:

TimeoutCache

All Known Implementing Classes:

DataBaseCache, MemoryCache, MemoryCache2, SingleJvmCache, TimeoutMemoryCache

Deprecated. Use the com.bankframe.serives.cache package instead

public interface Cache

extends Profile

Caching interface for the host system requests.

Method Summary

boolean	checkPrimaryKeyInCache(DataPacket primaryKeyOfEntity, long timeOutValue) Deprecated. This method checks to see if the specified key is in the cache.
void	close() Deprecated. Closes the connection to the database.
void	open() Deprecated. Opens the connection to the database.
java.util.Vector	remove(java.util.Vector pkOfEntitiesToRemove) Deprecated. Equivalent to remove(pks, false)
java.util.Vector	remove(java.util.Vector pkOfEntitiesToRemove, boolean persistanceTableToo) Deprecated. Removes all the entries of the Vector in the Cache.
DataPacket	retrieve(DataPacket primaryKeyOfEntity) Deprecated. Retrieve a response from the cache by primary key.
void	store(java.util.Map pkOfEntitiesToDataPacketResponses) Deprecated. Equivalent to store(pk, false)
void	store(java.util.Map pkOfEntitiesToDataPacketResponses, boolean persistent) Deprecated. Store many entries in the cache at once.

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

maxDbCacheSize, maxMemCacheSize, numberEntriesInDbCache, numberEntriesInMemCache

Method Detail

checkPrimaryKeyInCache

public boolean checkPrimaryKeyInCache(DataPacket primaryKeyOfEntity,
                                      long timeOutValue)
                               throws ProcessingErrorException

Deprecated.

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

Parameters:

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

timeOutValue - The maximum time a cache entry can be valid.

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.

close

public void close()
           throws ProcessingErrorException

Deprecated.

Closes the connection to the database.

Throws:

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

open

public void open()
          throws ProcessingErrorException

Deprecated.

Opens the connection to the database.

Throws:

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

remove

public java.util.Vector remove(java.util.Vector pkOfEntitiesToRemove)
                        throws ProcessingErrorException

Deprecated.

Equivalent to remove(pks, false)

Parameters:

pkOfEntitiesToRemove - The entries to remove.

Returns:

A vector of the keys removed.

Throws:

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

remove

public java.util.Vector remove(java.util.Vector pkOfEntitiesToRemove,
                               boolean persistanceTableToo)
                        throws ProcessingErrorException

Deprecated.

Removes all the entries of the Vector in the Cache.

Parameters:

pkOfEntitiesToRemove - The entries to remove.

persistanceTableToo - If true the entry will be purged from the persistance table.

Returns:

A vector of the keys removed.

Throws:

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

retrieve

public DataPacket retrieve(DataPacket primaryKeyOfEntity)
                    throws ProcessingErrorException

Deprecated.

Retrieve a response from the cache by primary key.

Parameters:

primaryKeyOfEntity - The primary key of the cached entity to be retrieved.

Returns:

The cached response as a DataPacket. If the key doesn't exist or is invalid (due to a timeout, et cetera) this will return null.

Throws:

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

store

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

Deprecated.

Equivalent to store(pk, false)

Parameters:

pkOfEntitiesToDataPacketResponses - Self explanatory.

Throws:

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

store

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

Deprecated.

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

Parameters:

pkOfEntitiesToDataPacketResponses - Self explanitory.

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.