org.infinispan.client.rest.RestCacheManagerClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of infinispan-client-rest-jakarta Show documentation
Infinispan REST Client Jakarta
The newest version!
package org.infinispan.client.rest;

import java.io.File;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletionStage;

import org.infinispan.commons.dataconversion.MediaType;

/**
 * @author Tristan Tarrant <[email protected]>
 * @since 10.0
 **/
public interface RestCacheManagerClient {
   String name();

   default CompletionStage globalConfiguration() {
      return globalConfiguration(MediaType.APPLICATION_JSON_TYPE);
   }

   CompletionStage globalConfiguration(String mediaType);

   CompletionStage cacheConfigurations();

   CompletionStage cacheConfigurations(String mediaType);

   CompletionStage info();

   CompletionStage health(boolean skipBody);

   default CompletionStage health() {
      return health(false);
   }

   CompletionStage templates(String mediaType);

   CompletionStage healthStatus();

   CompletionStage stats();

   CompletionStage backupStatuses();

   CompletionStage backupStatus(String site);

   CompletionStage bringBackupOnline(String backup);

   CompletionStage takeOffline(String backup);

   CompletionStage pushSiteState(String backup);

   CompletionStage cancelPushState(String backup);

   CompletionStage caches();

   /**
    * Creates a backup file containing all resources in this container.
    */
   default CompletionStage createBackup(String name) {
      return createBackup(name, null);
   }

   /**
    * Creates a backup file containing only the resources specified in the provided {@link Map}.
    *
    * @param resources a map of BackupManager.Resources.Type with the names of the resources to backup. If the provided
    *                  list only contains "*" then all available resources of that type are backed up.
    */
   default CompletionStage createBackup(String name, Map> resources) {
      return createBackup(name, null, resources);
   }

   /**
    * Creates a backup file containing only the resources specified in the provided {@link Map}.
    *
    * @param workingDir the path of the server directory to be used to create the backup content and store the final
    *                   backup file. A null value indicates that the server default should be used.
    * @param resources  a map of BackupManager.Resources.Type with the names of the resources to backup. If the provided
    *                   list only contains "*" then all available resources of that type are backed up. A null value
    *                   indicates that all resources should be included in the backup.
    */
   CompletionStage createBackup(String name, String workingDir, Map> resources);

   /**
    * Retrieves a backup file with the given name from the server.
    *
    * @param name     the name of the backup.
    * @param skipBody if true, then a HEAD request is issued to the server and only the HTTP headers are returned.
    */
   CompletionStage getBackup(String name, boolean skipBody);

   /**
    * @return the names of all backups.
    */
   CompletionStage getBackupNames();

   /**
    * Deletes a backup file from the server.
    *
    * @param name the name of the backup.
    */
   CompletionStage deleteBackup(String name);

   /**
    * Restores all content associated with this containers name contained within the provided backup file. The backup
    * file is uploaded via the server endpoint for processing, returning once the restoration has completed.
    *
    * @param name a unique name to identify the restore request.
    * @param backup the backup {@link File} containing the data to be restored.
    */
   default CompletionStage restore(String name, File backup) {
      return restore(name, backup, null);
   }

   /**
    * Restores the specified content from the backup file that's associated with this container's name.
    *
    * @param name a unique name to identify the restore request.
    * @param backup    the backup {@link File} containing the data to be restored.
    * @param resources a map of BackupManager.Resources.Type with the names of the resources to backup. If the provided
    *                  list only contains "*" then all available resources of that type are restored. A null value
    *                  indicates that all resources in the backup should be restored.
    */
   CompletionStage restore(String name, File backup, Map> resources);

   /**
    * Restores the specified content from the backup file that's associated with this container's name.
    *
    * @param name a unique name to identify the restore request.
    * @param backupLocation the path of the backup file already located on the server.
    * @param resources      a map of BackupManager.Resources.Type with the names of the resources to backup. If the
    *                       provided list only contains "*" then all available resources of that type are restored. A
    *                       null value indicates that all resources in the backup should be restored.
    */
   CompletionStage restore(String name, String backupLocation, Map> resources);

   /**
    * 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.
    *
    * @param name the name of the restore.
    */
   CompletionStage getRestore(String name);

   /**
    * @return the names of all restores.
    */
   CompletionStage getRestoreNames();

   /**
    * Deletes a restore request from the server. Container content is not affected.
    *
    * @param name the name of the restore.
    */
   CompletionStage deleteRestore(String name);

   /**
    * Globally enables automatic rebalancing.
    */
   CompletionStage enableRebalancing();

   /**
    * Globally disables automatic rebalancing.
    */
   CompletionStage disableRebalancing();
}