Package org.infinispan.registry

Interface InternalCacheRegistry

public interface InternalCacheRegistry

InternalCacheRegistry. Components which create caches for internal use should use this class to create/retrieve them

Since:

7.2

Author:

Tristan Tarrant

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	InternalCacheRegistry.Flag

Method Summary

Modifier and Type	Method	Description
void	filterPrivateCaches(Set<String> names)	Removes the private caches from the specified set of cache names
Set<String>	getInternalCacheNames()	Retrieves the names of all the internal caches
boolean	internalCacheHasFlag(String name, InternalCacheRegistry.Flag flag)	Returns whether a particular internal cache has a specific flag
boolean	isInternalCache(String name)	Returns whether the cache is internal, i.e.
boolean	isPrivateCache(String name)	Returns whether the cache is private, i.e.
void	registerInternalCache(String name, Configuration configuration)	Registers an internal cache.
void	registerInternalCache(String name, Configuration configuration, EnumSet<InternalCacheRegistry.Flag> flags)	Registers an internal cache with the specified flags.
void	unregisterInternalCache(String name)	Unregisters an internal cache

Method Detail

registerInternalCache

void registerInternalCache(String name,
                           Configuration configuration)

Registers an internal cache. The cache will be marked as private and volatile

Parameters:

name - The name of the cache

configuration - The configuration for the cache

registerInternalCache

void registerInternalCache(String name,
                           Configuration configuration,
                           EnumSet<InternalCacheRegistry.Flag> flags)

Registers an internal cache with the specified flags.

Parameters:

name - The name of the cache

configuration - The configuration for the cache

flags - The flags which determine the behaviour of the cache. See InternalCacheRegistry.Flag

unregisterInternalCache

void unregisterInternalCache(String name)

Unregisters an internal cache

Parameters:

name - The name of the cache

isInternalCache

boolean isInternalCache(String name)

Returns whether the cache is internal, i.e. it has been registered using the registerInternalCache(String, Configuration) method

isPrivateCache

boolean isPrivateCache(String name)

Returns whether the cache is private, i.e. it has been registered using the #registerInternalCache(String, Configuration, EnumSet) method without the InternalCacheRegistry.Flag.USER flag

getInternalCacheNames

Set<String> getInternalCacheNames()

Retrieves the names of all the internal caches

filterPrivateCaches

void filterPrivateCaches(Set<String> names)

Removes the private caches from the specified set of cache names

internalCacheHasFlag

boolean internalCacheHasFlag(String name,
                             InternalCacheRegistry.Flag flag)

Returns whether a particular internal cache has a specific flag

Parameters:

name - the name of the internal cache

flag - the flag to check

Returns:

true if the internal cache has the flag, false otherwise