public class CarbonCacheManager extends Object implements CacheManager
Constructor and Description |
---|
CarbonCacheManager(String name,
CacheManagerFactoryImpl cacheManagerFactory) |
Modifier and Type | Method and Description |
---|---|
<K,V> CacheBuilder<K,V> |
createCacheBuilder(String cacheName)
Creates a new
CacheBuilder for the named cache to be managed by this cache manager. |
boolean |
equals(Object o) |
<K,V> Cache<K,V> |
getCache(String cacheName)
Looks up a named cache.
|
Iterable<Cache<?,?>> |
getCaches()
Returns an Iterable over the caches managed by this CacheManager.
|
String |
getName()
Get the name of this cache manager
|
int |
getOwnerTenantId() |
Status |
getStatus()
Returns the status of this CacheManager.
|
UserTransaction |
getUserTransaction()
This method will return a UserTransaction.
|
int |
hashCode() |
boolean |
isSupported(OptionalFeature optionalFeature)
Indicates whether a optional feature is supported by this CacheManager.
|
boolean |
removeCache(String cacheName)
Remove a cache from the CacheManager.
|
void |
shutdown()
Shuts down the CacheManager.
|
<T> T |
unwrap(Class<T> cls)
Return an object of the specified type to allow access to the provider-specific API.
|
public CarbonCacheManager(String name, CacheManagerFactoryImpl cacheManagerFactory)
public int getOwnerTenantId()
public String getName()
CacheManager
getName
in interface CacheManager
public Status getStatus()
CacheManager
getStatus
in interface CacheManager
Status
public <K,V> CacheBuilder<K,V> createCacheBuilder(String cacheName)
CacheManager
CacheBuilder
for the named cache to be managed by this cache manager.
An example which creates a cache using default cache configuration is:
Cache<Integer, Date> myCache2 = cacheManager. <Integer, Date>createCacheBuilder("myCache2"). build();An example usage which programmatically sets many parameters of
CacheConfiguration
,
specifies a CacheLoader
and registrs listeners is:
Cache<Integer, String> myCache1 = cacheManager. <Integer, String>createCacheBuilder("myCache1"). setCacheLoader(cl). setStoreByValue(true). setReadThrough(true). setWriteThrough(false). setStatisticsEnabled(true). setTransactionEnabled(false). registerCacheEntryListener(listener1, NotificationScope.LOCAL, false). registerCacheEntryListener(listener2, NotificationScope.LOCAL, false). build();The returned CacheBuilder is associated with this CacheManager. The Cache will be created, added to the caches controlled by this CacheManager and started when
CacheBuilder.build()
is called.
If there is an existing Cache of the same name associated with this CacheManager when build is invoked,
an exception is thrown.createCacheBuilder
in interface CacheManager
cacheName
- the name of the cache to build. A cache name must consist of at least one non-whitespace character.public <K,V> Cache<K,V> getCache(String cacheName)
CacheManager
getCache
in interface CacheManager
cacheName
- the name of the cache to look forpublic Iterable<Cache<?,?>> getCaches()
CacheManager
getCaches
in interface CacheManager
public boolean removeCache(String cacheName)
CacheManager
removeCache
in interface CacheManager
cacheName
- the cache namepublic UserTransaction getUserTransaction()
CacheManager
getUserTransaction
in interface CacheManager
public boolean isSupported(OptionalFeature optionalFeature)
CacheManager
isSupported
in interface CacheManager
optionalFeature
- the feature to check forpublic void shutdown()
CacheManager
CacheLifecycle.stop()
method will be invoked, in no guaranteed order.
If the stop throws an exception, the exception is ignored.
Calls to CacheManager.getStatus()
will block until shutdown completes.
On completion the CacheManager's status is changed to Status.STOPPED
,
and the manager's owned caches will be empty and CacheManager.getCaches()
will return an empty collection.
A given CacheManager instance cannot be restarted after it has been stopped. A new one must be created.shutdown
in interface CacheManager
public <T> T unwrap(Class<T> cls)
CacheManager
IllegalArgumentException
is thrown.unwrap
in interface CacheManager
cls
- the class of the object to be returned. This is normally either the
underlying implementation class or an interface that it implements.Copyright © 2015 WSO2 Inc. All rights reserved.