Index (Cache Manager 0.0.8.RELEASE API)

A C D E F G H I K N P R S T V

A

AbstractFileSystemCache<V> - Class in net.itrixlabs.cache.core: Extends the ApplicationCache contract providing base for using file system as storage for the cache.
AbstractFileSystemCache() - Constructor for class net.itrixlabs.cache.core.AbstractFileSystemCache: This constructor should not be used for invoking a cache.
AbstractFileSystemCache(CacheType) - Constructor for class net.itrixlabs.cache.core.AbstractFileSystemCache: Constructs an AbstractFileSystemCache with the given type of auth token.
AbstractFileSystemCache(CacheType, String, String) - Constructor for class net.itrixlabs.cache.core.AbstractFileSystemCache: Constructs an AbstractFileSystemCache with the given type of auth token, the cache storage directory and cache file name.
afterPropertiesSet() - Method in class net.itrixlabs.cache.core.AbstractFileSystemCache
afterPropertiesSet() - Method in class net.itrixlabs.cache.SerializableCacheManager
ApplicationCache<Key,V> - Interface in net.itrixlabs.cache.core: Primordial interface for maintaining application cache.
Assert - Class in net.itrixlabs.cache.util: Internal class for making application logic related assertions.
Assert() - Constructor for class net.itrixlabs.cache.util.Assert
assertEquals(Object, Object, String) - Static method in class net.itrixlabs.cache.util.Assert: Tests the given arguments for equality based upon the Object.equals(Object) method of the class in focus and throws an IllegalArgumentException with the provided message if the arguments are not equal.
assertEquals(Object, Object) - Static method in class net.itrixlabs.cache.util.Assert: Tests the given arguments for equality based upon the Object.equals(Object) method of the class in focus and throws an IllegalArgumentException with a default message if the arguments are not equal.
assertEquals(Object...) - Static method in class net.itrixlabs.cache.util.Assert: Tests the given arguments for equality based upon the Object.equals(Object) method of the class in focus and throws an IllegalArgumentException with a default message if the arguments are not equal.
assertNotEmpty(Object, String) - Static method in class net.itrixlabs.cache.util.Assert: Tests the given argument of type String, StringBuilder or StringBuffer for empty (but not null) value and throws an IllegalArgumentException with the provided message if the argument is an empty string literal or representation.
assertNotEmpty(Object) - Static method in class net.itrixlabs.cache.util.Assert: Tests the given argument of type String, StringBuilder or StringBuffer for empty (but not null) value and throws an IllegalArgumentException with a default message if the argument is an empty string literal or representation.
assertNotEmpty(Object...) - Static method in class net.itrixlabs.cache.util.Assert: Tests the given arguments of type String, StringBuilder or StringBuffer for empty (but not null) value and throws an IllegalArgumentException with a default message if any argument is an empty string literal or representation.
assertNotNull(Object, String) - Static method in class net.itrixlabs.cache.util.Assert: Tests the given argument for null identity and throws an IllegalArgumentException with the provided message if the argument is null.
assertNotNull(Object) - Static method in class net.itrixlabs.cache.util.Assert: Tests the given argument for null identity and throws an IllegalArgumentException with a default message if the argument is null.
assertNotNull(Object...) - Static method in class net.itrixlabs.cache.util.Assert: Tests the given arguments for null identity and throws an IllegalArgumentException with a default message if any argument is null.
assertTrue(boolean, String) - Static method in class net.itrixlabs.cache.util.Assert: Tests the given condition for truth and throws an IllegalArgumentException with the provided message if the condition is false.
assertTrue(boolean) - Static method in class net.itrixlabs.cache.util.Assert: Tests the given condition for truth and throws an IllegalArgumentException with a default message if the condition is false.
assertTrue(boolean...) - Static method in class net.itrixlabs.cache.util.Assert: Tests the given conditions for truth and throws an IllegalArgumentException with a default message if any condition is false.

C

cache - Variable in class net.itrixlabs.cache.core.AbstractFileSystemCache
CacheKey - Class in net.itrixlabs.cache.config: Implements Key interface to provide key management services mainly the management framework.
CacheKey() - Constructor for class net.itrixlabs.cache.config.CacheKey
CacheManager - Interface in net.itrixlabs.cache.core: Primary marker for cache management.
CacheType - Enum in net.itrixlabs.cache.config: Named constants describing the types of caches supported by the cache manager out of the box.

D

DEFAULT_CACHE_MAX_SIZE - Static variable in interface net.itrixlabs.cache.config.Key
DEFAULT_CREATION_TIME - Static variable in interface net.itrixlabs.cache.config.Key
DEFAULT_KEY_STRING - Static variable in interface net.itrixlabs.cache.config.Key
DEFAULT_TTL - Static variable in interface net.itrixlabs.cache.config.Key
DEFAULT_TTL_TIMEUNIT - Static variable in interface net.itrixlabs.cache.config.Key
destroy() - Method in class net.itrixlabs.cache.core.AbstractFileSystemCache
destroy() - Method in class net.itrixlabs.cache.SerializableCacheManager

E

equals(Object) - Method in class net.itrixlabs.cache.config.CacheKey
evictFromCache(Object) - Method in class net.itrixlabs.cache.auth.SerializableAuthCache
evictFromCache(Object) - Method in interface net.itrixlabs.cache.core.ApplicationCache: Removes the specified entry from the cache.
evictFromCache(Object) - Method in class net.itrixlabs.cache.csrf.SerializableCsrfCache
evictFromCache(Object) - Method in class net.itrixlabs.cache.generic.SerializableGenericCache
evictFromCache(Object) - Method in class net.itrixlabs.cache.user.SerializableUserCache

F

flush() - Method in class net.itrixlabs.cache.core.AbstractFileSystemCache
flush() - Method in interface net.itrixlabs.cache.core.ApplicationCache

G

generate(Object) - Method in class net.itrixlabs.cache.core.AbstractFileSystemCache: A native strategy to generate the cache key.
getCreationTime() - Method in class net.itrixlabs.cache.config.CacheKey
getCreationTime() - Method in interface net.itrixlabs.cache.config.Key: Returns the creation time for an entry in the cache.
getFromCache(Object) - Method in class net.itrixlabs.cache.auth.SerializableAuthCache
getFromCache(Object) - Method in interface net.itrixlabs.cache.core.ApplicationCache: Obtains a stored entry from the cache.
getFromCache(Object) - Method in class net.itrixlabs.cache.csrf.SerializableCsrfCache
getFromCache(Object) - Method in class net.itrixlabs.cache.generic.SerializableGenericCache
getFromCache(Object) - Method in class net.itrixlabs.cache.user.SerializableUserCache
getKey() - Method in class net.itrixlabs.cache.config.CacheKey
getKey() - Method in interface net.itrixlabs.cache.config.Key: Gets the key descriptor from the cache implementation.
getTtl() - Method in class net.itrixlabs.cache.core.AbstractFileSystemCache: Returns the set time-to-live for the entries in cache.
getTtlUnit() - Method in class net.itrixlabs.cache.core.AbstractFileSystemCache: Returns the set time-to-live time unit for the entries in cache.

H

hashCode() - Method in class net.itrixlabs.cache.config.CacheKey

I

initialize() - Method in class net.itrixlabs.cache.core.AbstractFileSystemCache
initialize() - Method in interface net.itrixlabs.cache.core.ApplicationCache: Initializes the application cache (doesn't create it).
isPresentInCache(Object) - Method in class net.itrixlabs.cache.core.AbstractFileSystemCache
isPresentInCache(Object) - Method in interface net.itrixlabs.cache.core.ApplicationCache: Checks the application cache on which the method is called for the specified key and returns true if the condition is true, else false.

K

Key - Interface in net.itrixlabs.cache.config: Primary contract for defining the key to an entry in the cache.

N

net.itrixlabs.cache - package net.itrixlabs.cache
net.itrixlabs.cache.auth - package net.itrixlabs.cache.auth
net.itrixlabs.cache.config - package net.itrixlabs.cache.config
net.itrixlabs.cache.core - package net.itrixlabs.cache.core
net.itrixlabs.cache.csrf - package net.itrixlabs.cache.csrf
net.itrixlabs.cache.generic - package net.itrixlabs.cache.generic
net.itrixlabs.cache.user - package net.itrixlabs.cache.user
net.itrixlabs.cache.util - package net.itrixlabs.cache.util

P

putInCache(Object, V) - Method in class net.itrixlabs.cache.auth.SerializableAuthCache
putInCache(Object, V) - Method in interface net.itrixlabs.cache.core.ApplicationCache: Places an entry in the cache.
putInCache(Object, V) - Method in class net.itrixlabs.cache.csrf.SerializableCsrfCache
putInCache(Object, V) - Method in class net.itrixlabs.cache.generic.SerializableGenericCache
putInCache(Object, V) - Method in class net.itrixlabs.cache.user.SerializableUserCache

R

run() - Method in class net.itrixlabs.cache.SerializableCacheManagementWorker

S

SerializableAuthCache<V> - Class in net.itrixlabs.cache.auth: Simple implementation of ApplicationCache for authorization sub-systems.
SerializableAuthCache() - Constructor for class net.itrixlabs.cache.auth.SerializableAuthCache: Constructs a SerializableAuthCache.
SerializableAuthCache(String, String) - Constructor for class net.itrixlabs.cache.auth.SerializableAuthCache: Constructs a SerializableAuthCache with the given type of auth token, the cache storage directory and cache file name.
SerializableCacheManagementWorker<U,A,C,G> - Class in net.itrixlabs.cache
SerializableCacheManager<U,A,C,G> - Class in net.itrixlabs.cache: Sets up a CacheManager for use with a definitive caching strategy.
SerializableCacheManager() - Constructor for class net.itrixlabs.cache.SerializableCacheManager: Constructs an instance of cache manager as SerializableCacheManager.
SerializableCsrfCache<V> - Class in net.itrixlabs.cache.csrf: Efficient implementation of ApplicationCache for CSRF Filters.
SerializableCsrfCache() - Constructor for class net.itrixlabs.cache.csrf.SerializableCsrfCache: Constructs a SerializableCsrfCache.
SerializableCsrfCache(String, String) - Constructor for class net.itrixlabs.cache.csrf.SerializableCsrfCache: Constructs a SerializableCsrfCache with the given type of auth token, the cache storage directory and cache file name.
SerializableGenericCache<V> - Class in net.itrixlabs.cache.generic: Efficient implementation of ApplicationCache for non-differential subsystems which are unknown to this API (better support for runtime resolution will be provided in future when out team gets the chance to look into this).
SerializableGenericCache() - Constructor for class net.itrixlabs.cache.generic.SerializableGenericCache: Constructs a SerializableGenericCache.
SerializableGenericCache(String, String) - Constructor for class net.itrixlabs.cache.generic.SerializableGenericCache: Constructs a SerializableGenericCache with the given type of referenced details, the cache storage directory and cache file name.
SerializableUserCache<V> - Class in net.itrixlabs.cache.user: Efficient implementation of ApplicationCache for authentication sub-systems.
SerializableUserCache() - Constructor for class net.itrixlabs.cache.user.SerializableUserCache: Constructs a SerializableUserCache.
SerializableUserCache(String, String) - Constructor for class net.itrixlabs.cache.user.SerializableUserCache: Constructs a SerializableUserCache with the given type of user details, the cache storage directory and cache file name.
setAuthCache(SerializableAuthCache<A>) - Method in class net.itrixlabs.cache.SerializableCacheManager: Registers the auth cache with the worker.
setCacheDir(String) - Method in class net.itrixlabs.cache.core.AbstractFileSystemCache: Sets the cache directory location to use with the particular type of cache in focus.
setCacheFile(String) - Method in class net.itrixlabs.cache.core.AbstractFileSystemCache: Sets the cache filename to use with the particular type of cache in focus.
setCreationTime(Long) - Method in class net.itrixlabs.cache.config.CacheKey
setCreationTime(Long) - Method in interface net.itrixlabs.cache.config.Key: Sets the creation time for an entry in the cache.
setCsrfCache(SerializableCsrfCache<C>) - Method in class net.itrixlabs.cache.SerializableCacheManager: Registers the csrf cache with the worker.
setGenericCache(SerializableGenericCache<G>) - Method in class net.itrixlabs.cache.SerializableCacheManager: Registers the generic cache with the worker.
setKey(Object) - Method in class net.itrixlabs.cache.config.CacheKey
setKey(Object) - Method in interface net.itrixlabs.cache.config.Key: Sets the key descriptor to the cache implementation.
setTtl(Long, TimeUnit) - Method in class net.itrixlabs.cache.core.AbstractFileSystemCache: Sets the time-to-live & the time unit for cache entry time-to-live strategy (applicable to each entry in the cache).
setUserCache(SerializableUserCache<U>) - Method in class net.itrixlabs.cache.SerializableCacheManager: Registers the user cache with the worker.

T

toString() - Method in enum net.itrixlabs.cache.config.CacheType
ttl - Variable in class net.itrixlabs.cache.core.AbstractFileSystemCache
ttlUnit - Variable in class net.itrixlabs.cache.core.AbstractFileSystemCache

V

valueOf(String) - Static method in enum net.itrixlabs.cache.config.CacheType: Returns the enum constant of this type with the specified name.
values() - Static method in enum net.itrixlabs.cache.config.CacheType: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G H I K N P R S T V