Package org.infinispan.client.hotrod

Interface RemoteCacheManagerAdmin

All Superinterfaces:
org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>
All Known Implementing Classes:
RemoteCacheManagerAdminImpl
public interface RemoteCacheManagerAdmin extends org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>
Remote Administration operations
Since:
9.1
Author:
Tristan Tarrant

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.infinispan.commons.api.CacheContainerAdmin

    org.infinispan.commons.api.CacheContainerAdmin.AdminFlag

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    assignAlias(String aliasName, String cacheName)
    Assign an alias to a cache.
    <K, V> RemoteCache<K,V>
    createCache(String name, String template)
    Creates a cache on the remote server cluster using the specified template name.
    <K, V> RemoteCache<K,V>
    createCache(String name, DefaultTemplate template)
    Deprecated, for removal: This API element is subject to removal in a future version.
    use createCache(String, String) instead
    <K, V> RemoteCache<K,V>
    createCache(String name, org.infinispan.commons.configuration.BasicConfiguration configuration)
    Creates a cache on the remote server cluster using the specified configuration
    <K, V> RemoteCache<K,V>
    getOrCreateCache(String name, String template)
    Retrieves an existing cache on the remote server cluster.
    <K, V> RemoteCache<K,V>
    getOrCreateCache(String name, DefaultTemplate template)
    Deprecated, for removal: This API element is subject to removal in a future version.
    use getOrCreateCache(String, String) instead
    <K, V> RemoteCache<K,V>
    getOrCreateCache(String name, org.infinispan.commons.configuration.BasicConfiguration configuration)
    Retrieves an existing cache on the remote server cluster.
    void
    reindexCache(String name)
    Performs a mass reindexing of the specified cache.
    void
    removeCache(String name)
    Removes a cache from the remote server cluster.
    void
    updateConfigurationAttribute(String cacheName, String attribute, String value)
    Updates a mutable configuration attribute for the given cache.
    void
    updateIndexSchema(String cacheName)
    Updates the index schema state for the given cache, the cache engine is hot restarted so that index persisted or not persisted state will be preserved.

    Methods inherited from interface org.infinispan.commons.api.CacheContainerAdmin

    createTemplate, removeTemplate, withFlags, withFlags

  • Method Details

    • createCache

      <K, V> RemoteCache<K,V> createCache(String name, String template) throws HotRodClientException
      Creates a cache on the remote server cluster using the specified template name.
      Specified by:
      createCache in interface org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>
      Parameters:
      name - the name of the cache to create
      template - the template to use for the cache. If null, the configuration marked as default on the server will be used
      Returns:
      the cache
      Throws:
      HotRodClientException

    • createCache

      @Deprecated(forRemoval=true) <K, V> RemoteCache<K,V> createCache(String name, DefaultTemplate template) throws HotRodClientException
      Deprecated, for removal: This API element is subject to removal in a future version.
      use createCache(String, String) instead
      Creates a cache on the remote server cluster using the specified default configuration template present in the server.
      Parameters:
      name - the name of the cache to create
      template - DefaultTemplate enum
      Returns:
      the cache
      Throws:
      HotRodClientException

    • createCache

      <K, V> RemoteCache<K,V> createCache(String name, org.infinispan.commons.configuration.BasicConfiguration configuration) throws HotRodClientException
      Creates a cache on the remote server cluster using the specified configuration
      Specified by:
      createCache in interface org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>
      Parameters:
      name - the name of the cache to create
      configuration - a concrete cache configuration that will be sent to the server in one of the supported formats: XML, JSON, and YAML. The server detects the format automatically. The configuration must conform to the Infinispan embedded configuration schema version that is supported by the server.
      Returns:
      the cache
      Throws:
      HotRodClientException

    • getOrCreateCache

      <K, V> RemoteCache<K,V> getOrCreateCache(String name, String template) throws HotRodClientException
      Retrieves an existing cache on the remote server cluster. If it doesn't exist, it will be created using the specified template name.
      Specified by:
      getOrCreateCache in interface org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>
      Parameters:
      name - the name of the cache to create
      template - the template to use for the cache. If null, the configuration marked as default on the server will be used
      Returns:
      the cache
      Throws:
      HotRodClientException

    • getOrCreateCache

      @Deprecated(forRemoval=true) <K, V> RemoteCache<K,V> getOrCreateCache(String name, DefaultTemplate template) throws HotRodClientException
      Deprecated, for removal: This API element is subject to removal in a future version.
      use getOrCreateCache(String, String) instead
      Retrieves an existing cache on the remote server cluster. If it doesn't exist, it will be created using the specified default template that is present in the server.
      Parameters:
      name - the name of the cache to create
      template - DefaultTemplate enum
      Returns:
      the cache
      Throws:
      HotRodClientException

    • getOrCreateCache

      <K, V> RemoteCache<K,V> getOrCreateCache(String name, org.infinispan.commons.configuration.BasicConfiguration configuration) throws HotRodClientException
      Retrieves an existing cache on the remote server cluster. If it doesn't exist, it will be created using the specified configuration.
      Specified by:
      getOrCreateCache in interface org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>
      Parameters:
      name - the name of the cache to create
      configuration - a concrete cache configuration of that will be sent to the server in one of the supported formats: XML, JSON and YAML. The format will be detected automatically. The configuration must use the Infinispan embedded configuration schema in a version supported by the server.
      Returns:
      the cache
      Throws:
      HotRodClientException

    • removeCache

      void removeCache(String name) throws HotRodClientException
      Removes a cache from the remote server cluster.
      Specified by:
      removeCache in interface org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>
      Parameters:
      name - the name of the cache to remove
      Throws:
      HotRodClientException

    • reindexCache

      void reindexCache(String name) throws HotRodClientException
      Performs a mass reindexing of the specified cache. The command will return immediately and the reindexing will be performed asynchronously
      Parameters:
      name - the name of the cache to reindex
      Throws:
      HotRodClientException

    • updateIndexSchema

      void updateIndexSchema(String cacheName) throws HotRodClientException
      Updates the index schema state for the given cache, the cache engine is hot restarted so that index persisted or not persisted state will be preserved.
      Parameters:
      cacheName - the name of the cache on which the index schema will be updated
      Throws:
      HotRodClientException

    • updateConfigurationAttribute

      void updateConfigurationAttribute(String cacheName, String attribute, String value) throws HotRodClientException
      Updates a mutable configuration attribute for the given cache.
      Specified by:
      updateConfigurationAttribute in interface org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>
      Parameters:
      cacheName - the name of the cache on which the attribute will be updated
      attribute - the path of the attribute we want to change
      value - the new value to apply to the attribute
      Throws:
      HotRodClientException

    • assignAlias

      void assignAlias(String aliasName, String cacheName) throws HotRodClientException
      Assign an alias to a cache. If the alias was already associated with another cache, the association will be reassigned to the specified cache. If the alias was not associated with any cache, it is created and associated to the specified cache. If the alias was already associated with the specified cache, this operation does nothing.
      Specified by:
      assignAlias in interface org.infinispan.commons.api.CacheContainerAdmin<RemoteCacheManagerAdmin,org.infinispan.commons.configuration.BasicConfiguration>
      Parameters:
      aliasName - the name of the alias
      cacheName - the name of the cache to which the alias should be associated
      Throws:
      HotRodClientException