Package org.infinispan.client.rest

Interface RestClusterClient

All Known Implementing Classes:
RestClusterClientOkHttp
public interface RestClusterClient
Since:
10.0
Author:
Tristan Tarrant <tristan@infinispan.org>

  • Method Details

    • stop

      CompletionStage<RestResponse> stop()
      Shuts down the cluster

    • stop

      CompletionStage<RestResponse> stop(List<String> server)
      Shuts down the specified servers

    • createBackup

      CompletionStage<RestResponse> createBackup(String name)
      Creates a backup file containing the content of all containers in the cluster.
      Parameters:
      name - the name of the backup.

    • getBackup

      CompletionStage<RestResponse> getBackup(String name, boolean skipBody)
      Retrieves a backup file with the given name from the server.
      Parameters:
      name - the name of the backup.
      skipBody - if true, then a HEAD request is issued to the server and only the HTTP headers are returned.

    • getBackupNames

      CompletionStage<RestResponse> getBackupNames()
      Returns:
      the names of all backups.

    • deleteBackup

      CompletionStage<RestResponse> deleteBackup(String name)
      Deletes a backup file from the server.
      Parameters:
      name - the name of the backup.

    • restore

      CompletionStage<RestResponse> restore(String name, File backup)
      Restores all content from a backup file, by uploading the file to the server endpoint for processing, returning once the restoration has completed.
      Parameters:
      name - a unique name to identify the restore request.
      backup - the backup File containing the data to be restored.

    • restore

      CompletionStage<RestResponse> restore(String name, String backupLocation)
      Restores all content from a backup file available to the server instance.
      Parameters:
      name - a unique name to identify the restore request.
      backupLocation - the path of the backup file already located on the server.

    • getRestore

      CompletionStage<RestResponse> getRestore(String name)
      Polls a restore request progress with the given name. 201 indicates that the request has completed, 202 that it's in progress and 404 that it can't be found.
      Parameters:
      name - the name of the restore.

    • getRestoreNames

      CompletionStage<RestResponse> getRestoreNames()
      Returns:
      the names of all restores.

    • deleteRestore

      CompletionStage<RestResponse> deleteRestore(String name)
      Deletes a restore request from the server. Container content is not affected.
      Parameters:
      name - the name of the restore.

    • distribution

      CompletionStage<RestResponse> distribution()
      Returns:
      The cluster distribution information.