com.SimplCache.Models

Class SimplCache<T>

java.lang.Object

com.SimplCache.Models.SimplCache<T>

public class SimplCache<T>
extends Object

Since:

24-06-2020

Author:

Lekhana Ganji

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimplCache.CACHE_TYPES
static class	SimplCache.EVICTION_TYPES
static class	SimplCache.MEMORY_TYPES
static class	SimplCache.POLICY_CONTROL
static class	SimplCache.SimplCacheBuilder<T>
static class	SimplCache.WRITE_BACK_TYPE
static class	SimplCache.WRITEBACKPARAMETER

Method Summary

Modifier and Type	Method and Description
static <T> SimplCache<T>	buildFromSaveState(String saveStateString, CacheDB<T> cacheDB, PersistentDB<T> persistentDB) This method is used to build the SimplCache object from the string returned by the save state function.
static <T> SimplCache<T>	buildFromSaveState(String saveStateString, CacheDB<T> cacheDB, PersistentDB<T> persistentDB, SimplCacheEncryptor simplCacheEncryptor) This method is used to build the SimplCache object from the string returned by the save state function.
void	close(SimplCache.WRITEBACKPARAMETER writebackparameter) This method is used to close all the threads started by the SimplCache object.
void	flush(SimplCache.WRITEBACKPARAMETER writebackparameter) This method is used to empty the cache.
T	get(String key) This method is used fetch the cache object from cache.
SimplCache.MEMORY_TYPES	getCacheMemoryType() This methods return the type of cache memory is used to maintain the cache.
Long	getCacheSize() This method return the maximum cache memory size set to the simplcache object.
Long	getCacheTimeLimit() This method return the time limit set on each cache item when the time eviction policy is enabled.
SimplCache.CACHE_TYPES	getCacheType() This method return the type of cache set to the simplcache object
Long	getCurrentCacheSize() This method return the current size of the cache.
SimplCache.EVICTION_TYPES	getEvictionType() This method return the type of eviction policy set to the simplcache object
void	put(String key, T object) This method is used to put the object in cache according to the cache type and eviction policies.
void	put(String key, T object, SimplCache.POLICY_CONTROL policy_control) This method is used to put the object in cache and also into the persistentDB according to the cache type and eviction policies.
String	saveState() This method is used to save the state of the keys present in the cache.
String	saveState(SimplCacheEncryptor simplCacheEncryptor) This method is used to save the state of the keys present in the cache.
void	writeBack() This method is used to write the cache items into persistentDB whenever required.

Methods inherited from class java.lang.Object

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

Method Detail

getCacheType

public SimplCache.CACHE_TYPES getCacheType()

This method return the type of cache set to the simplcache object

Returns:

See Also:

SimplCache.CACHE_TYPES

getEvictionType

public SimplCache.EVICTION_TYPES getEvictionType()

This method return the type of eviction policy set to the simplcache object

Returns:

See Also:

SimplCache.EVICTION_TYPES

getCacheMemoryType

public SimplCache.MEMORY_TYPES getCacheMemoryType()

This methods return the type of cache memory is used to maintain the cache.

Returns:

See Also:

SimplCache.MEMORY_TYPES

getCacheSize

public Long getCacheSize()

This method return the maximum cache memory size set to the simplcache object. It returns count if memory type is OBJECT_COUNT and Kilobytes if memory type is OBJECT_SIZE

Returns:

getCurrentCacheSize

public Long getCurrentCacheSize()

This method return the current size of the cache. For the object size option of memory type the javaagent vm option should be enabled

Returns:

long size in term of count or Kilo Bytes

getCacheTimeLimit

public Long getCacheTimeLimit()

This method return the time limit set on each cache item when the time eviction policy is enabled.

Returns:

long time limit

buildFromSaveState

public static <T> SimplCache<T> buildFromSaveState(String saveStateString,
                                                   CacheDB<T> cacheDB,
                                                   PersistentDB<T> persistentDB)

This method is used to build the SimplCache object from the string returned by the save state function. It is used to store the state of cache whenever required. It uses a basic encryptor which is the default encryptor Note: Default encryptor does not guarantee any security.

Type Parameters:

T -

Parameters:

saveStateString -

cacheDB -

persistentDB -

Returns:

buildFromSaveState

public static <T> SimplCache<T> buildFromSaveState(String saveStateString,
                                                   CacheDB<T> cacheDB,
                                                   PersistentDB<T> persistentDB,
                                                   SimplCacheEncryptor simplCacheEncryptor)

This method is used to build the SimplCache object from the string returned by the save state function. It is used to store the state of cache whenever required. This method accepts an implementation of SimplCacheEncryptor which has to overriden to provide encryption and decryption

Type Parameters:

T -

Parameters:

saveStateString -

cacheDB -

persistentDB -

Returns:

See Also:

SimplCacheEncryptor

put

public void put(String key,
                T object)

This method is used to put the object in cache according to the cache type and eviction policies.

Parameters:

key -

object -

put

public void put(String key,
                T object,
                SimplCache.POLICY_CONTROL policy_control)

This method is used to put the object in cache and also into the persistentDB according to the cache type and eviction policies.

Parameters:

key -

object -

policy_control -

get

public T get(String key)
      throws Exception

This method is used fetch the cache object from cache. If the object is not present the object is fetched from persistentDB

Parameters:

key -

Returns:

Throws:

Exception

writeBack

public void writeBack()

This method is used to write the cache items into persistentDB whenever required.

flush

public void flush(SimplCache.WRITEBACKPARAMETER writebackparameter)

This method is used to empty the cache. It takes write back parameter which as two options, WITH_WRITEBACK: this option writes into persistentdb before flushing the cache WITHOUT_WRITEBACK: this option does not write into persistentdb before flushing the cache

Parameters:

writebackparameter -

See Also:

SimplCache.WRITEBACKPARAMETER

close

public void close(SimplCache.WRITEBACKPARAMETER writebackparameter)

This method is used to close all the threads started by the SimplCache object. This methods also clears the cache and closes it and the Database connections can also be closed if the methods are overwritten in the CacheDB and PersistentDB interface.It takes write back parameter which as two options, WITH_WRITEBACK: this option writes into persistentdb before flushing the cache WITHOUT_WRITEBACK: this option does not write into persistentdb before flushing the cache

Parameters:

writebackparameter -

See Also:

SimplCache.WRITEBACKPARAMETER

saveState

public String saveState()

This method is used to save the state of the keys present in the cache. Only the keys and properties of the cache object are stored. After rebuilding the SimplCache object the actual cache objects are fetched automatically from persistentDB A default encryptor is used to encrypt the data. Note: Encryptor is very simple and does not guarantee any security.

Returns:

See Also:

is used to build the state of cache back.

saveState

public String saveState(SimplCacheEncryptor simplCacheEncryptor)

This method is used to save the state of the keys present in the cache. Only the keys and properties of the cache object are stored. After rebuilding the SimplCache object the actual cache objects are fetched automatically from persistentDB This method accepts an implementation of SimplCacheEncryptor which has to overriden to provide encryption and decryption

Returns:

See Also:

Note: Encryptor is very simple and does not guarantee any security., is used to build the state of cache back.