Interface ServerManagement

All Known Implementing Classes:
BaseServerManagement
public interface ServerManagement
Provides management operations and metadata for an Infinispan server instance.
Since:
10.0

  • Field Details

  • Method Details

    • getStatus

      ComponentStatus getStatus()
      Returns the current status of the server.

    • serializeConfiguration

      void serializeConfiguration(ConfigurationWriter writer)
      Serializes the server configuration using the provided writer.

    • serverStop

      void serverStop(List<String> servers)
      Stops the specified servers.
      Parameters:
      servers - the list of server names to stop.

    • clusterStop

      void clusterStop()
      Stops the entire cluster.

    • containerStop

      void containerStop()
      Stops the container (cache manager and all associated services).

    • getCacheManager

      @Deprecated(forRemoval=true, since="13.0") default DefaultCacheManager getCacheManager(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Multiple Cache Managers are not supported in the server. Use getCacheManager() instead.

    • getCacheManager

      DefaultCacheManager getCacheManager()
      Returns the server's DefaultCacheManager.

    • getServerStateManager

      ServerStateManager getServerStateManager()
      Returns the ServerStateManager responsible for managing cluster-wide server state such as ignored caches, connector status, and IP filters.

    • getLoginConfiguration

      Map<String,String> getLoginConfiguration(ProtocolServer protocolServer)
      Returns the login configuration for the given protocol server, including authentication mode, URL, realm, and client ID.
      Parameters:
      protocolServer - the protocol server to retrieve login configuration for.

    • getProtocolServers

      Map<String, ProtocolServer> getProtocolServers()
      Returns all registered protocol servers, keyed by their name.

    • getTaskManager

      org.infinispan.tasks.manager.TaskManager getTaskManager()
      Returns the TaskManager for managing server tasks.

    • getServerReport

      CompletionStage<Path> getServerReport()
      Generates a diagnostic server report.
      Returns:
      a CompletionStage that completes with the path to the generated report file.

    • getBackupManager

      BackupManager getBackupManager()
      Returns the BackupManager for managing cluster backup and restore operations.

    • getDataSources

      Map<String, DataSource> getDataSources()
      Returns all configured data sources, keyed by their JNDI name.

    • getServerDataPath

      Path getServerDataPath()
      Returns the path to the server's data directory.

    • getUsers

      Map<String, List<Principal>> getUsers()
      Returns all users grouped by security realm.

    • flushSecurityCaches

      CompletionStage<Void> flushSecurityCaches()
      Flushes all security caches across the cluster, including authorization and realm caches.

    • overviewReport

      Json overviewReport()
      Generates a JSON overview report of the server, including cluster topology, cache features, encodings, persistence stores, and connected clients.

    • securityOverviewReport

      Json securityOverviewReport()
      Generates a JSON security overview report of the server, including configured security realms and their authentication mechanisms.

    • getClassLoader

      ClassLoader getClassLoader()
      Returns the class loader used by this server instance.

    • isManaged

      default boolean isManaged()
      Returns whether this server is running in a managed environment, such as a Kubernetes or OpenShift cluster managed by the Infinispan Operator.
      Returns:
      true if the server is managed by an operator, false otherwise.
      Since:
      16.3