Interface IDataProtect

@Path("/dataprotect") public interface IDataProtect

  • Method Details

    • getAvailableGenerations

      @GET @Path("generations") List<DataProtectGeneration> getAvailableGenerations() throws net.bluemind.core.api.fault.ServerFault
      Returns all protected generations, ordered from oldest to most recent
      Returns:
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • getContent

      @POST @Path("_content/{partGen}") TaskRef getContent(@PathParam("partGen") String partGenerationId) throws net.bluemind.core.api.fault.ServerFault
      Loads an index of protected datas with possible restore actions.
      Parameters:
      partGenerationId - the part generation identifier
      Returns:
      GenerationContent XML from TaskStatus result
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • getRestoreCapabilities

      @GET @Path("restore/_capabilities") List<RestoreOperation> getRestoreCapabilities() throws net.bluemind.core.api.fault.ServerFault
      Returns infos about the restore operations that the core provides
      Returns:
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • getRestoreCapabilitiesByTags

      @GET @Path("restore/_capabilities_by_tags") List<RestoreOperation> getRestoreCapabilitiesByTags(List<String> tags) throws net.bluemind.core.api.fault.ServerFault
      * Returns infos about the restore operations that the core provides (filtered by tags)
      Parameters:
      tags -
      Returns:
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • run

      @POST @Path("restore") TaskRef run(RestoreDefinition restoreDefinition) throws net.bluemind.core.api.fault.ServerFault
      Executes a restore operation on the given Restorable item using data from a DataProtectGeneration
      Parameters:
      restoreDefinition -
      Returns:
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • forget

      @DELETE @Path("generations") TaskRef forget(@QueryParam("generationId") int generationId) throws net.bluemind.core.api.fault.ServerFault
      Removes protected data
      Parameters:
      generationId - the generation identifier to remove
      Returns:
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • getRetentionPolicy

      @GET @Path("policy") RetentionPolicy getRetentionPolicy() throws net.bluemind.core.api.fault.ServerFault
      Returns the RetentionPolicy used for backup automatic removals. Never returns null.
      Returns:
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • updatePolicy

      @POST @Path("policy") void updatePolicy(RetentionPolicy rp) throws net.bluemind.core.api.fault.ServerFault
      creates or updates the RetentionPolicy.
      Parameters:
      rp -
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • syncWithFilesystem

      @POST @Path("_syncfs") void syncWithFilesystem() throws net.bluemind.core.api.fault.ServerFault
      Re-creates the in-database metadata using the generations.xml index from the data protect spool on the filesystem. This is used for re-creating a blue mind server using backups. This must be used when /var/backups/bluemind becomes inconsistent with the database content (eg. after a TINA restore of /var/backups/bluemind)
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • saveAll

      @POST @Path("_backup") TaskRef saveAll() throws net.bluemind.core.api.fault.ServerFault
      Run the incremental dataprotect backup process. Only one backup runs at a time: a cancelled backup still counts as running until it has stopped.
      Returns:
      the backup task
      Throws:
      net.bluemind.core.api.fault.ServerFault - if a backup is already running