Package org.infinispan.manager

Class DefaultCacheManagerAdmin

java.lang.Object
org.infinispan.manager.DefaultCacheManagerAdmin
All Implemented Interfaces:
org.infinispan.commons.api.CacheContainerAdmin<EmbeddedCacheManagerAdmin,Configuration>, EmbeddedCacheManagerAdmin
public class DefaultCacheManagerAdmin extends Object implements EmbeddedCacheManagerAdmin
The default implementation of EmbeddedCacheManagerAdmin
Since:
9.2
Author:
Tristan Tarrant

  • Method Details

    • createCache

      public <K, V> Cache<K,V> createCache(String cacheName, Configuration configuration)
      Description copied from interface: EmbeddedCacheManagerAdmin
      Creates a cache across the cluster. The cache will survive topology changes, e.g. when a new node joins the cluster, it will automatically be created there. This method will wait for the cache to be created on all nodes before returning.
      Specified by:
      createCache in interface org.infinispan.commons.api.CacheContainerAdmin<EmbeddedCacheManagerAdmin,Configuration>
      Specified by:
      createCache in interface EmbeddedCacheManagerAdmin
      Type Parameters:
      K - the generic type of the key
      V - the generic type of the value
      Parameters:
      cacheName - the name of the cache
      configuration - the configuration to use. It must be a clustered configuration (e.g. distributed)
      Returns:
      the cache

    • getOrCreateCache

      public <K, V> Cache<K,V> getOrCreateCache(String cacheName, Configuration configuration)
      Description copied from interface: EmbeddedCacheManagerAdmin
      Retrieves an existing cache or creates one across the cluster using the specified configuration. The cache will survive topology changes, e.g. when a new node joins the cluster, it will automatically be created there. This method will wait for the cache to be created on all nodes before returning.
      Specified by:
      getOrCreateCache in interface org.infinispan.commons.api.CacheContainerAdmin<EmbeddedCacheManagerAdmin,Configuration>
      Specified by:
      getOrCreateCache in interface EmbeddedCacheManagerAdmin
      Type Parameters:
      K - the generic type of the key
      V - the generic type of the value
      Parameters:
      cacheName - the name of the cache
      configuration - the configuration to use. It must be a clustered configuration (e.g. distributed)
      Returns:
      the cache

    • createCache

      public <K, V> Cache<K,V> createCache(String cacheName, String template)
      Description copied from interface: EmbeddedCacheManagerAdmin
      Creates a cache on the container using the specified template.
      Specified by:
      createCache in interface org.infinispan.commons.api.CacheContainerAdmin<EmbeddedCacheManagerAdmin,Configuration>
      Specified by:
      createCache in interface EmbeddedCacheManagerAdmin
      Parameters:
      cacheName - the name of the cache to create
      template - the template to use for the cache. If null, the configuration marked as default on the container will be used
      Returns:
      the cache

    • getOrCreateCache

      public <K, V> Cache<K,V> getOrCreateCache(String cacheName, String template)
      Description copied from interface: EmbeddedCacheManagerAdmin
      Retrieves an existing cache or creates one using the specified template if it doesn't exist
      Specified by:
      getOrCreateCache in interface org.infinispan.commons.api.CacheContainerAdmin<EmbeddedCacheManagerAdmin,Configuration>
      Specified by:
      getOrCreateCache in interface EmbeddedCacheManagerAdmin
      Parameters:
      cacheName - the name of the cache to create
      template - the template to use for the cache. If null, the configuration marked as default on the container will be used
      Returns:
      the cache

    • createTemplate

      public void createTemplate(String name, Configuration configuration)
      Description copied from interface: EmbeddedCacheManagerAdmin
      Creates a template that is replicated across the cluster using the specified configuration. The template will survive topology changes, e.g. when a new node joins the cluster, it will automatically be created there. This method will wait for the template to be created on all nodes before returning.
      Specified by:
      createTemplate in interface org.infinispan.commons.api.CacheContainerAdmin<EmbeddedCacheManagerAdmin,Configuration>
      Specified by:
      createTemplate in interface EmbeddedCacheManagerAdmin
      Parameters:
      name - the name of the template
      configuration - the configuration to use. It must be a clustered configuration (e.g. distributed)

    • getOrCreateTemplate

      public Configuration getOrCreateTemplate(String name, Configuration configuration)
      Description copied from interface: EmbeddedCacheManagerAdmin
      Retrieves an existing template or creates one across the cluster using the specified configuration. The template will survive topology changes, e.g. when a new node joins the cluster, it will automatically be created there. This method will wait for the template to be created on all nodes before returning.
      Specified by:
      getOrCreateTemplate in interface EmbeddedCacheManagerAdmin
      Parameters:
      name - the name of the template
      configuration - the configuration to use. It must be a clustered configuration (e.g. distributed)
      Returns:
      the template configuration

    • removeTemplate

      public void removeTemplate(String name)
      Description copied from interface: EmbeddedCacheManagerAdmin
      Removes a template from the cache container. Any persisted data will be cleared.
      Specified by:
      removeTemplate in interface org.infinispan.commons.api.CacheContainerAdmin<EmbeddedCacheManagerAdmin,Configuration>
      Specified by:
      removeTemplate in interface EmbeddedCacheManagerAdmin
      Parameters:
      name - the name of the template to remove

    • removeCache

      public void removeCache(String cacheName)
      Specified by:
      removeCache in interface org.infinispan.commons.api.CacheContainerAdmin<EmbeddedCacheManagerAdmin,Configuration>

    • withFlags

      public EmbeddedCacheManagerAdmin withFlags(org.infinispan.commons.api.CacheContainerAdmin.AdminFlag... flags)
      Specified by:
      withFlags in interface org.infinispan.commons.api.CacheContainerAdmin<EmbeddedCacheManagerAdmin,Configuration>

    • withFlags

      public EmbeddedCacheManagerAdmin withFlags(EnumSet<org.infinispan.commons.api.CacheContainerAdmin.AdminFlag> flags)
      Specified by:
      withFlags in interface org.infinispan.commons.api.CacheContainerAdmin<EmbeddedCacheManagerAdmin,Configuration>

    • withSubject

      public EmbeddedCacheManagerAdmin withSubject(Subject subject)
      Description copied from interface: EmbeddedCacheManagerAdmin
      Performs any cache manager operations using the specified Subject. Only applies to cache managers with authorization enabled (see GlobalConfigurationBuilder.security().
      Specified by:
      withSubject in interface EmbeddedCacheManagerAdmin
      Parameters:
      subject -
      Returns:
      an EmbeddedCacheManagerAdmin instance on which a real operation is to be invoked, using the specified subject