com.trivago.triava.tcache

Class TCacheFactory

java.lang.Object

com.trivago.triava.tcache.TCacheFactory

All Implemented Interfaces:

Closeable, AutoCloseable, javax.cache.CacheManager

public class TCacheFactory
extends Object
implements Closeable, javax.cache.CacheManager

The TCacheFactory allows to create Cache instances via calls to builder(), and also supplies administrative methods for the managed caches, like shutting down all registered Caches. The preferred way of obtaining a TCacheFactory instance for application code is a call to standardFactory(). Library code should instantiate a new TCacheFactory instance, so it can manage its own Cache collection. An alternative way is to use the JCache API, and obtain an instance via CachingProvider.getCacheManager() calls.

Since:

2015-03-10

Author:

cesken

Constructor Summary

Constructors

Constructor and Description
TCacheFactory() Creates a TCacheFactory with default parameters.
TCacheFactory(URI uri, ClassLoader classLoader, Properties properties, TCacheProvider cachingProvider)
TCacheFactory(URI uri, ClassLoader classLoader, TCacheProvider cachingProvider)

Method Summary

Modifier and Type	Method and Description
<K,V> Builder<K,V>	builder() Returns a Builder
void	close() Closes the TCacheFactory.
<K,V,C extends javax.cache.configuration.Configuration<K,V>> javax.cache.Cache<K,V>	createCache(String cacheName, C configuration)
void	destroyCache(String cacheName)
void	enableManagement(String cacheName, boolean enable)
void	enableStatistics(String cacheName, boolean enable)
boolean	equals(Object obj)
<K,V> javax.cache.Cache<K,V>	getCache(String cacheName)
<K,V> javax.cache.Cache<K,V>	getCache(String cacheName, Class<K> keyClass, Class<V> valueClass)
Iterable<String>	getCacheNames()
javax.cache.spi.CachingProvider	getCachingProvider()
ClassLoader	getClassLoader()
Properties	getProperties()
Cache<?,?>	getTCache(String cacheName)
URI	getURI()
int	hashCode()
List<Cache<?,?>>	instances() Returns the list of Caches that have been registered via registerCache(Cache).
boolean	isClosed()
void	registerCache(Cache<?,?> cache) Registers a Cache to this factory.
Map<String,CacheSizeInfo>	reportAllCacheSizes(ObjectSizeCalculatorInterface objectSizeCalculator) Reports size of all Cache instances, which were registered via registerCache(Cache).
static TCacheFactory	standardFactory() Returns the standard factory.
<T> T	unwrap(Class<T> clazz)

Methods inherited from class java.lang.Object

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

Constructor Detail

TCacheFactory

public TCacheFactory()

Creates a TCacheFactory with default parameters.

JCache (JSR107) compatibility note. The TCacheFactory is a JSR107 CacheManager, but it is standalone and will not be registered in any CacheProvider. If you require this, retrieve an instance via the other constructors or the JSR107 CacheProvider instead.

TCacheFactory

public TCacheFactory(URI uri,
                     ClassLoader classLoader,
                     TCacheProvider cachingProvider)

TCacheFactory

public TCacheFactory(URI uri,
                     ClassLoader classLoader,
                     Properties properties,
                     TCacheProvider cachingProvider)

Method Detail

standardFactory

public static TCacheFactory standardFactory()

Returns the standard factory. The factory can produce Builder instances via builder().
Library code should not use this method, but create a new TCacheFactory instance for managing its own Cache collection.

Returns:

The standard cache factory.

builder

public <K,V> Builder<K,V> builder()

Returns a Builder

Type Parameters:

K - The Key type

V - The Value type

Returns:

A Builder

registerCache

public void registerCache(Cache<?,?> cache)

Registers a Cache to this factory. Registered caches will be used for bulk operations like close().

Parameters:

cache - The Cache to register

Throws:

IllegalStateException - If a cache with the same id is already registered in this factory.

destroyCache

public void destroyCache(String cacheName)

Specified by:

destroyCache in interface javax.cache.CacheManager

getURI

public URI getURI()

Specified by:

getURI in interface javax.cache.CacheManager

getClassLoader

public ClassLoader getClassLoader()

Specified by:

getClassLoader in interface javax.cache.CacheManager

getProperties

public Properties getProperties()

Specified by:

getProperties in interface javax.cache.CacheManager

close

public void close()

Closes the TCacheFactory.

For each Cache managed by the TCacheFactory, the Cache#close() method will be invoked, in no guaranteed order.

If a Cache#close() call throws an exception, the exception will be ignored.

After executing this method, the isClosed() method will return true.

All attempts to close a previously closed TCacheFactory will be ignored.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface javax.cache.CacheManager

Throws:

SecurityException - when the operation could not be performed due to the current security settings

isClosed

public boolean isClosed()

Specified by:

isClosed in interface javax.cache.CacheManager

reportAllCacheSizes

public Map<String,CacheSizeInfo> reportAllCacheSizes(ObjectSizeCalculatorInterface objectSizeCalculator)

Reports size of all Cache instances, which were registered via registerCache(Cache). Using this method can create high load, and may require particular permissions, depending on the used object size calculator.

USE WITH CARE!!!

Parameters:

objectSizeCalculator - An implementation that can calculate the deep size of an Object tree

Returns:

A map with the cacheName as key and the CacheSizeInfo as value

instances

public List<Cache<?,?>> instances()

Returns the list of Caches that have been registered via registerCache(Cache).

Returns:

The cache list

createCache

public <K,V,C extends javax.cache.configuration.Configuration<K,V>> javax.cache.Cache<K,V> createCache(String cacheName,
                                                                                                       C configuration)
                                                                                                throws IllegalArgumentException

Specified by:

createCache in interface javax.cache.CacheManager

Throws:

IllegalArgumentException

enableManagement

public void enableManagement(String cacheName,
                             boolean enable)

Specified by:

enableManagement in interface javax.cache.CacheManager

enableStatistics

public void enableStatistics(String cacheName,
                             boolean enable)

Specified by:

enableStatistics in interface javax.cache.CacheManager

getTCache

public Cache<?,?> getTCache(String cacheName)

getCache

public <K,V> javax.cache.Cache<K,V> getCache(String cacheName,
                                             Class<K> keyClass,
                                             Class<V> valueClass)

Specified by:

getCache in interface javax.cache.CacheManager

getCache

public <K,V> javax.cache.Cache<K,V> getCache(String cacheName)

Specified by:

getCache in interface javax.cache.CacheManager

getCacheNames

public Iterable<String> getCacheNames()

Specified by:

getCacheNames in interface javax.cache.CacheManager

getCachingProvider

public javax.cache.spi.CachingProvider getCachingProvider()

Specified by:

getCachingProvider in interface javax.cache.CacheManager

unwrap

public <T> T unwrap(Class<T> clazz)

Specified by:

unwrap in interface javax.cache.CacheManager

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object