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
    • Method Detail

      • registerInternalCache

        void registerInternalCache​(java.lang.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​(java.lang.String name,
                                   Configuration configuration,
                                   java.util.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​(java.lang.String name)
        Unregisters an internal cache
        Parameters:
        name - The name of the cache
      • isPrivateCache

        boolean isPrivateCache​(java.lang.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

        java.util.Set<java.lang.String> getInternalCacheNames()
        Retrieves the names of all the internal caches
      • filterPrivateCaches

        void filterPrivateCaches​(java.util.Set<java.lang.String> names)
        Removes the private caches from the specified set of cache names
      • internalCacheHasFlag

        boolean internalCacheHasFlag​(java.lang.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