org.hibernate.cache.infinispan.util

Interface CacheAdapter

All Known Implementing Classes:

CacheAdapterImpl

public interface CacheAdapter

Infinispan cache abstraction.

Since:

3.5

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(java.lang.Object listener) Add listener to this cache.
void	broadcastEvictAll() TODO
void	clear() Clear the cache.
boolean	containsKey(java.lang.Object key) Method to check whether a certain key exists in this cache.
void	evict(java.lang.Object key) Evict the given key from memory.
java.lang.Object	get(java.lang.Object key) Performs an get(Object) on the cache, wrapping any exception in a CacheException.
AddressAdapter	getAddress() Get local cluster address.
java.lang.Object	getAllowingTimeout(java.lang.Object key) Performs an get(Object) on the cache ignoring any TimeoutException and wrapping any other exception in a CacheException.
org.infinispan.Cache	getCache()
org.infinispan.config.Configuration	getConfiguration() Get cache configuration.
java.util.List<AddressAdapter>	getMembers() Get cluster members.
boolean	isClusteredInvalidation() Is this cache participating in a cluster with invalidation?
boolean	isClusteredReplication() Is this cache participating in a cluster with replication?
boolean	isSynchronous() Is this cache configured for synchronous communication?
java.util.Set	keySet() Set of keys of this cache.
void	put(java.lang.Object key, java.lang.Object value) Performs a put(Object, Object) on the cache, wrapping any exception in a CacheException.
void	putAllowingTimeout(java.lang.Object key, java.lang.Object value) Performs a put(Object, Object) on the cache ignoring any TimeoutException and wrapping any exception in a CacheException.
void	putForExternalRead(java.lang.Object key, java.lang.Object value) See Cache.putForExternalRead(Object, Object) for detailed documentation.
void	remove(java.lang.Object key) Performs a remove(Object), wrapping any exception in a CacheException.
void	removeListener(java.lang.Object listener) Remove listener from cache instance.
int	size() Size of cache.
void	stop() Stops the cache.
java.util.Map	toMap() This method returns a Map view of the cache.
CacheAdapter	withFlags(FlagAdapter... flagAdapters) A builder-style method that adds flags to any cache API call.
<T> T	withinTx(java.util.concurrent.Callable<T> c) TODO

Method Detail

isClusteredInvalidation

boolean isClusteredInvalidation()

Is this cache participating in a cluster with invalidation?

Returns:

true if the cache is configured for synchronous/asynchronous invalidation; false otherwise.

isClusteredReplication

boolean isClusteredReplication()

Is this cache participating in a cluster with replication?

Returns:

true if the cache is configured for synchronous/asynchronous invalidation; false otherwise.

isSynchronous

boolean isSynchronous()

Is this cache configured for synchronous communication?

Returns:

true if the cache is configured for synchronous communication; false otherwise.

keySet

java.util.Set keySet()

Set of keys of this cache.

Returns:

Set containing keys stored in this cache.

withFlags

CacheAdapter withFlags(FlagAdapter... flagAdapters)

A builder-style method that adds flags to any cache API call.

Parameters:

flagAdapters - a set of flags to apply. See the FlagAdapter documentation.

Returns:

a cache on which a real operation is to be invoked.

containsKey

boolean containsKey(java.lang.Object key)

Method to check whether a certain key exists in this cache.

Parameters:

key - key to look up.

Returns:

true if key is present, false otherwise.

get

java.lang.Object get(java.lang.Object key)
                     throws CacheException

Performs an get(Object) on the cache, wrapping any exception in a CacheException.

Parameters:

key - key to retrieve

Throws:

CacheException

getAllowingTimeout

java.lang.Object getAllowingTimeout(java.lang.Object key)
                                    throws CacheException

Performs an get(Object) on the cache ignoring any TimeoutException and wrapping any other exception in a CacheException.

Parameters:

key - key to retrieve

Throws:

CacheException

put

void put(java.lang.Object key,
       java.lang.Object value)
         throws CacheException

Performs a put(Object, Object) on the cache, wrapping any exception in a CacheException.

Parameters:

key - key whose value will be modified

value - data to store in the cache entry

Throws:

CacheException

putAllowingTimeout

void putAllowingTimeout(java.lang.Object key,
                      java.lang.Object value)
                        throws CacheException

Performs a put(Object, Object) on the cache ignoring any TimeoutException and wrapping any exception in a CacheException.

Parameters:

key - key whose value will be modified

value - data to store in the cache entry

Throws:

CacheException

putForExternalRead

void putForExternalRead(java.lang.Object key,
                      java.lang.Object value)
                        throws CacheException

See Cache.putForExternalRead(Object, Object) for detailed documentation.

Parameters:

key - key with which the specified value is to be associated.

value - value to be associated with the specified key.

Throws:

CacheException

remove

void remove(java.lang.Object key)
            throws CacheException

Performs a remove(Object), wrapping any exception in a CacheException.

Parameters:

key - key to be removed

Throws:

CacheException

evict

void evict(java.lang.Object key)
           throws CacheException

Evict the given key from memory.

Parameters:

key - to evict.

Throws:

CacheException

clear

void clear()
           throws CacheException

Clear the cache.

Throws:

CacheException

stop

void stop()

Stops the cache.

addListener

void addListener(java.lang.Object listener)

Add listener to this cache.

Parameters:

listener - to be added to cache.

getAddress

AddressAdapter getAddress()

Get local cluster address.

Returns:

Address representing local address.

getMembers

java.util.List<AddressAdapter> getMembers()

Get cluster members.

Returns:

List of cluster member Address instances

size

int size()

Size of cache.

Returns:

number of cache entries.

toMap

java.util.Map toMap()

This method returns a Map view of the cache.

Returns:

Map view of cache.

removeListener

void removeListener(java.lang.Object listener)

Remove listener from cache instance.

Parameters:

listener - to be removed.

getConfiguration

org.infinispan.config.Configuration getConfiguration()

Get cache configuration.

Returns:

Configuration instance associated with this cache.

broadcastEvictAll

void broadcastEvictAll()

TODO

withinTx

<T> T withinTx(java.util.concurrent.Callable<T> c)
           throws java.lang.Exception

TODO

Type Parameters:

T -

Parameters:

c -

Returns:

Throws:

java.lang.Exception

getCache

org.infinispan.Cache getCache()