Package org.exoplatform.services.jcr.ext.backup.server

Class HTTPBackupAgent

java.lang.Object
org.exoplatform.services.jcr.ext.backup.server.HTTPBackupAgent
All Implemented Interfaces:
org.exoplatform.services.rest.resource.ResourceContainer
public class HTTPBackupAgent extends Object implements org.exoplatform.services.rest.resource.ResourceContainer
Created by The eXo Platform SAS. HTTPBackupAgent is a RESTfull service on top of the BackupManager allowing to manage the backups and the restores.
Version:
$Id: BackupServer.java 111 2008-11-11 11:11:11Z rainf0x $
Author:
Alex Reshetnyak

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    HTTPBackupAgent.Constants
    Definition the constants.

  • Constructor Summary

    Constructors
    Constructor
    Description
    HTTPBackupAgent(org.exoplatform.services.jcr.RepositoryService repoService, BackupManager backupManager, SessionProviderService sessionProviderService)
    ReplicationTestService constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    javax.ws.rs.core.Response
    dropWorkspace(String repository, String workspace, Boolean forceSessionClose)
    Drops a given workspace.
    javax.ws.rs.core.Response
    getDefaultRepositoryConfig()
    Gives the default repository configuration.
    javax.ws.rs.core.Response
    getDefaultWorkspaceConfig()
    Gives the default workspace configuration.
    javax.ws.rs.core.Response
    info()
    Gives info about the backup service.
    javax.ws.rs.core.Response
    infoBackup()
    Gives info about all the current and completed backups.
    javax.ws.rs.core.Response
    infoBackupByRepository(String repository)
    Gives info about all the current and completed backups of a specific repository.
    javax.ws.rs.core.Response
    infoBackupByWorkspace(String repository, String workspace)
    Gives info about all the current and completed backups of a specific workspace.
    javax.ws.rs.core.Response
    infoBackupCompleted()
    Gives info about all the completed backups.
    javax.ws.rs.core.Response
    infoBackupCurrent()
    Gives info about all the current backups.
    javax.ws.rs.core.Response
    infoBackupId(String id)
    Gives full details about the current or completed backup corresponding to the given id.
    javax.ws.rs.core.Response
    infoBackupRepository()
    Gives info about all the current and completed repository backups .
    javax.ws.rs.core.Response
    infoBackupRepositoryCompleted()
    Gives info about all the completed repository backups.
    javax.ws.rs.core.Response
    infoBackupRepositoryCurrent()
    Gives info about all the current repository backups.
    javax.ws.rs.core.Response
    infoBackupRepositoryId(String id)
    Gives full details about the current or completed repository backup corresponding to the given id.
    javax.ws.rs.core.Response
    infoRestore(String repository, String workspace)
    Gives all details about the last restore of a specific workspace.
    javax.ws.rs.core.Response
    infoRestoreRepository(String repository)
    Gives all details about the last restore of a specific repository.
    javax.ws.rs.core.Response
    infoRestores()
    Gives all details about the last restores.
    javax.ws.rs.core.Response
    infoRestoresRepository()
    Gives all details about the last repository restores.
    javax.ws.rs.core.Response
    restore(String backupId, Boolean removeExisting)
    Restores the workspace with original configuration (this configuration was stored in backup chain log).
    javax.ws.rs.core.Response
    restore(org.exoplatform.services.jcr.config.WorkspaceEntry wEntry, String repository, String backupId)
    Restores a workspace.
    javax.ws.rs.core.Response
    restore(org.exoplatform.services.jcr.config.WorkspaceEntry wEntry, String repository, String backupId, Boolean removeExisting)
    Restores a workspace.
    javax.ws.rs.core.Response
    restoreBackupSet(org.exoplatform.services.jcr.config.WorkspaceEntry wEntry, String repository, String backupSetPathEncoded, Boolean removeExisting)
    Restores the workspace from backup set with changing configuration.
    javax.ws.rs.core.Response
    restoreFromBackupSet(String backupSetPathEncoded, Boolean removeExisting)
    Restores the workspace or repository with original configuration (this configuration was stored in backup log).
    javax.ws.rs.core.Response
    restoreRepository(String backupId, Boolean removeExisting)
    Restores a repository.
    javax.ws.rs.core.Response
    restoreRepository(org.exoplatform.services.jcr.config.RepositoryEntry rEntry, String backupId)
    Restores a repository.
    javax.ws.rs.core.Response
    restoreRepository(org.exoplatform.services.jcr.config.RepositoryEntry rEntry, String backupId, Boolean removeExisting)
    Restores a repository.
    javax.ws.rs.core.Response
    restoreRepositoryBackupSet(org.exoplatform.services.jcr.config.RepositoryEntry rEntry, String backupSetPathEncoded, Boolean removeExisting)
    Restores a repository from backup set with changing configuration.
    javax.ws.rs.core.Response
    start(BackupConfigBean bConfigBean, String repository, String workspace)
    Starts a backup on a given workspace.
    javax.ws.rs.core.Response
    startBackupRepository(BackupConfigBean bConfigBean, String repository)
    Starts a backup on a given repository.
    javax.ws.rs.core.Response
    stop(String backupId)
    Stops the backup corresponding to the given id.
    javax.ws.rs.core.Response
    stopBackupRepository(String backupId)
    Stops the repository backup corresponding to the given id.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • HTTPBackupAgent

      public HTTPBackupAgent(org.exoplatform.services.jcr.RepositoryService repoService, BackupManager backupManager, SessionProviderService sessionProviderService)
      ReplicationTestService constructor.
      Parameters:
      repoService - the RepositoryService
      backupManager - the BackupManager
      sessionProviderService - the SessionProviderService

  • Method Details

    • start

      @RolesAllowed("administrators") public javax.ws.rs.core.Response start(BackupConfigBean bConfigBean, String repository, String workspace)
      Starts a backup on a given workspace.
      Parameters:
      bConfigBean - the bean with backup configuration.
      repository - the name of the repository
      workspace - the name of the workspace
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo anchor for generated doc on REST API
      {code:json} { "backupType" : the backup type (full or full+incremental), "incrementalJobPeriod" : the incremental job period, "incrementalRepetitionNumber" : the incremental repetition number, "fullBackupJobConfig" : the BackupJobConfig to full backup, "incrementalBackupJobConfig" : the BackupJobConfig to incremental backup, "backupDir" : the folder for backup data }
      eXo response for generated doc on REST API
      {code:json} { "startedTime": the start time of backup, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of backup, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of backup, "repositoryName": the name of repository } {code}

    • startBackupRepository

      @RolesAllowed("administrators") public javax.ws.rs.core.Response startBackupRepository(BackupConfigBean bConfigBean, String repository)
      Starts a backup on a given repository.
      Parameters:
      bConfigBean - the bean with backup configuration.
      repository - the name of the repository
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo anchor for generated doc on REST API
      {code:json} { "backupType" : the backup type (full or full+incremental), "incrementalJobPeriod" : the incremental job period, "incrementalRepetitionNumber" : the incremental repetition number, "fullBackupJobConfig" : the BackupJobConfig to full backup, "incrementalBackupJobConfig" : the BackupJobConfig to incremental backup, "backupDir" : the folder for backup data }
      eXo response for generated doc on REST API
      {code:json} { "startedTime": the start time of backup, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of backup, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of backup, "repositoryName": the name of repository } {code}

    • dropWorkspace

      @RolesAllowed("administrators") public javax.ws.rs.core.Response dropWorkspace(String repository, String workspace, Boolean forceSessionClose)
      Drops a given workspace.
      Parameters:
      repository - the name of the repository
      workspace - the name of the workspace
      forceSessionClose - the flag indicating whether or not we need to force closing the current sessions
      Returns:
      Response return the response
      eXo level API
      Provisional

    • restore

      @RolesAllowed("administrators") public javax.ws.rs.core.Response restore(org.exoplatform.services.jcr.config.WorkspaceEntry wEntry, String repository, String backupId)
      Restores a workspace.
      Parameters:
      wEntry - the configuration of the workspace to restore
      repository - the name of the repository
      backupId - the identifier of the backup
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo anchor for generated doc on REST API
      {code:json} "wEntry" : the configuration of the workspace to restore. {code}
      eXo response for generated doc on REST API
      {code:json} { "startedTime": the start time of restore, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore) , "state": the state of restore, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of restore, "repositoryName": the name of repository } {code}

    • restore

      @RolesAllowed("administrators") public javax.ws.rs.core.Response restore(org.exoplatform.services.jcr.config.WorkspaceEntry wEntry, String repository, String backupId, Boolean removeExisting)
      Restores a workspace.
      Parameters:
      wEntry - the configuration of the workspace to restore
      repository - the name of the repository
      backupId - the identifier of the backup
      removeExisting - if 'true', it will remove fully (db, value storage, index) the existing workspace.
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo anchor for generated doc on REST API
      {code:json} "wEntry" : "the configuration of the workspace to restore. {code}
      eXo response for generated doc on REST API
      {code:json} { "startedTime": the start time of restore, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore) , "state": the state of restore, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of restore, "repositoryName": the name of repository } {code}

    • restoreBackupSet

      @RolesAllowed("administrators") public javax.ws.rs.core.Response restoreBackupSet(org.exoplatform.services.jcr.config.WorkspaceEntry wEntry, String repository, String backupSetPathEncoded, Boolean removeExisting)
      Restores the workspace from backup set with changing configuration.
      Parameters:
      wEntry - the configuration of the workspace to restore
      repository - the name of the repository
      backupSetPathEncoded - the path to backup set
      removeExisting - if 'true', it will remove fully (db, value storage, index) the existing workspace.
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo anchor for generated doc on REST API
      {code:json} "wEntry" : the configuration of the workspace to restore. {code}
      eXo response for generated doc on REST API
      {code:json} { "startedTime": the start time of restore, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of restore, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of restore, "repositoryName": the name of repository } {code}

    • restore

      @RolesAllowed("administrators") public javax.ws.rs.core.Response restore(String backupId, Boolean removeExisting)
      Restores the workspace with original configuration (this configuration was stored in backup chain log).
      Parameters:
      backupId - the identifier of the backup
      removeExisting - if 'true', it will be remove fully (db, value storage, index) the existing workspace.
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} { "startedTime": the start time of restore, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of restore, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of restore, "repositoryName": the name of repository } {code}

    • restoreFromBackupSet

      @RolesAllowed("administrators") public javax.ws.rs.core.Response restoreFromBackupSet(String backupSetPathEncoded, Boolean removeExisting)
      Restores the workspace or repository with original configuration (this configuration was stored in backup log).
      Parameters:
      backupSetPathEncoded - the path to backup set
      removeExisting - if 'true', it will remove fully (db, value storage, index) the existing workspace.
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} { "startedTime": the start time of restore, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of restore, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of restore, "repositoryName": the name of repository } {code}

    • restoreRepository

      @RolesAllowed("administrators") public javax.ws.rs.core.Response restoreRepository(org.exoplatform.services.jcr.config.RepositoryEntry rEntry, String backupId)
      Restores a repository.
      Parameters:
      rEntry - the configuration of the repository to restore
      backupId - the identifier of the backup
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo anchor for generated doc on REST API
      {code:json} { "rEntry" : the configuration of the repository to restore } {code}
      eXo response for generated doc on REST API
      {code:json} { "startedTime": the start time of restore, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of restore, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of restore, "repositoryName": the name of repository } {code}

    • restoreRepository

      @RolesAllowed("administrators") public javax.ws.rs.core.Response restoreRepository(org.exoplatform.services.jcr.config.RepositoryEntry rEntry, String backupId, Boolean removeExisting)
      Restores a repository.
      Parameters:
      rEntry - the configuration of the repository to restore
      backupId - the identifier of the backup
      removeExisting - if 'true', it will remove fully (db, value storage, index) the existing repository.
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo anchor for generated doc on REST API
      {code:json} { "rEntry" : the configuration of the repository to restore } {code}
      eXo response for generated doc on REST API
      {code:json} { "startedTime": the start time of restore, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of restore, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of restore, "repositoryName": the name of repository } {code}

    • restoreRepositoryBackupSet

      @RolesAllowed("administrators") public javax.ws.rs.core.Response restoreRepositoryBackupSet(org.exoplatform.services.jcr.config.RepositoryEntry rEntry, String backupSetPathEncoded, Boolean removeExisting)
      Restores a repository from backup set with changing configuration.
      Parameters:
      rEntry - the configuration of the repository to restore
      backupSetPathEncoded - the path to backup set
      removeExisting - if 'true', it will remove fully (db, value storage, index) the existing repository.
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo anchor for generated doc on REST API
      {code:json} { "rEntry" : the configuration of the repository to restore } {code}
      eXo response for generated doc on REST API
      {code:json} { "startedTime": the start time of restore, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of restore, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of restore, "repositoryName":the name of repository } {code}

    • restoreRepository

      @RolesAllowed("administrators") public javax.ws.rs.core.Response restoreRepository(String backupId, Boolean removeExisting)
      Restores a repository.
      Parameters:
      backupId - the identifier of the backup
      removeExisting - if 'true', it will remove fully (db, value storage, index) the existing repository.
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} { "startedTime": the start time of restore, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of restore, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of restore, "repositoryName": the name of repository } {code}

    • stop

      @RolesAllowed("administrators") public javax.ws.rs.core.Response stop(String backupId)
      Stops the backup corresponding to the given id.
      Parameters:
      backupId - the identifier of the backup
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} { "startedTime": the start time of backup, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of backup, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of backup, "repositoryName": the name of repository } {code}

    • stopBackupRepository

      @RolesAllowed("administrators") public javax.ws.rs.core.Response stopBackupRepository(String backupId)
      Stops the repository backup corresponding to the given id.
      Parameters:
      backupId - the identifier of the backup
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} { "startedTime": the start time of backup, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of backup, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of backup, "repositoryName": the name of repository } {code

    • info

      @RolesAllowed("administrators") public javax.ws.rs.core.Response info()
      Gives info about the backup service.
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} { "backupLogDir" : the path to backup log folder, "defaultIncrementalJobPeriod" : the default incremental job period, "fullBackupType" : the type of full backup, "incrementalBackupType" : the type of incremental backup } {code}

    • infoBackup

      @RolesAllowed("administrators") public javax.ws.rs.core.Response infoBackup()
      Gives info about all the current and completed backups.
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} { "startedTime": the start time of backup, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of backup, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of backup, "repositoryName": the name of repository } ] {code}

    • infoBackupRepository

      @RolesAllowed("administrators") public javax.ws.rs.core.Response infoBackupRepository()
      Gives info about all the current and completed repository backups .
      Returns:
      Response return the response
      eXo level API
      Provisional, Provisional
      eXo response for generated doc on REST API
      {code:json} [ { "startedTime": the start time of backup, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of backup, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of backup, "repositoryName": the name of repository } ] {code}

    • infoBackupId

      @RolesAllowed("administrators") public javax.ws.rs.core.Response infoBackupId(String id)
      Gives full details about the current or completed backup corresponding to the given id.
      Parameters:
      id - the identifier of the backup
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} { "backupType" : the backup type (full or full+incremental), "incrementalJobPeriod" : the incremental job period, "incrementalRepetitionNumber" : the incremental repetition number, "fullBackupJobConfig" : the BackupJobConfig to full backup, "incrementalBackupJobConfig" : the BackupJobConfig to incremental backup, "backupDir" : the folder for backup data}, "startedTime": the start time of backup, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of backup, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of backup, "repositoryName": the name of repository } {code}

    • infoBackupRepositoryId

      @RolesAllowed("administrators") public javax.ws.rs.core.Response infoBackupRepositoryId(String id)
      Gives full details about the current or completed repository backup corresponding to the given id.
      Parameters:
      id - the identifier of the repository backup
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} { "backupType" : the backup type (full or full+incremental), "incrementalJobPeriod" : the incremental job period, "incrementalRepetitionNumber" : the incremental repetition number, "fullBackupJobConfig" : the BackupJobConfig to full backup, "incrementalBackupJobConfig" : the BackupJobConfig to incremental backup, "backupDir" : the folder for backup data}, "startedTime": the start time of backup, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of backup, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of backup, "repositoryName": the name of repository } {code}

    • infoBackupCurrent

      @RolesAllowed("administrators") public javax.ws.rs.core.Response infoBackupCurrent()
      Gives info about all the current backups.
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} [ { "startedTime": the start time of backup, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of backup, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of backup, "repositoryName": the name of repository } ] {code}

    • infoBackupRepositoryCurrent

      @RolesAllowed("administrators") public javax.ws.rs.core.Response infoBackupRepositoryCurrent()
      Gives info about all the current repository backups.
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} [ { "startedTime": the start time of backup, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of backup, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of backup, "repositoryName": the name of repository } ] {code}

    • infoBackupCompleted

      @RolesAllowed("administrators") public javax.ws.rs.core.Response infoBackupCompleted()
      Gives info about all the completed backups.
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} [ { "startedTime": the start time of backup, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of backup, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of backup, "repositoryName": the name of repository } ] {code}

    • infoBackupRepositoryCompleted

      @RolesAllowed("administrators") public javax.ws.rs.core.Response infoBackupRepositoryCompleted()
      Gives info about all the completed repository backups.
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} [ { "startedTime": the start time of backup, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of backup, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of backup, "repositoryName": the name of repository } ] {code}

    • infoBackupByWorkspace

      @RolesAllowed("administrators") public javax.ws.rs.core.Response infoBackupByWorkspace(String repository, String workspace)
      Gives info about all the current and completed backups of a specific workspace.
      Parameters:
      repository - the name of the repository
      workspace - the name of the workspace
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} [ { "startedTime": the start time of backup, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of backup, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of backup, "repositoryName": the name of repository } ] {code}

    • infoBackupByRepository

      @RolesAllowed("administrators") public javax.ws.rs.core.Response infoBackupByRepository(String repository)
      Gives info about all the current and completed backups of a specific repository.
      Parameters:
      repository - the name of the repository
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} [ { "startedTime": the start time of backup, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of backup, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of backup, "repositoryName": the name of repository } ] {code}

    • infoRestore

      @RolesAllowed("administrators") public javax.ws.rs.core.Response infoRestore(String repository, String workspace)
      Gives all details about the last restore of a specific workspace.
      Parameters:
      repository - the name of the repository
      workspace - the name of the workspace
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} { { "backupType" : the backup type (full or full+incremental), "incrementalJobPeriod" : the incremental job period, "incrementalRepetitionNumber" : the incremental repetition number, "fullBackupJobConfig" : the BackupJobConfig to full backup, "incrementalBackupJobConfig" : the BackupJobConfig to incremental backup, "backupDir" : the folder for backup data}, "startedTime": the start time of restore, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of restore, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of restore, "repositoryName": the name of repository } {code}

    • infoRestoreRepository

      @RolesAllowed("administrators") public javax.ws.rs.core.Response infoRestoreRepository(String repository)
      Gives all details about the last restore of a specific repository.
      Parameters:
      repository - the name of the repository
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} { { "backupType" : the backup type (full or full+incremental), "incrementalJobPeriod" : the incremental job period, "incrementalRepetitionNumber" : the incremental repetition number, "fullBackupJobConfig" : the BackupJobConfig to full backup, "incrementalBackupJobConfig" : the BackupJobConfig to incremental backup, "backupDir" : the folder for backup data}, "startedTime": the start time of restore, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of restore, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of restore, "repositoryName": the name of repository } {code}

    • infoRestores

      @RolesAllowed("administrators") public javax.ws.rs.core.Response infoRestores()
      Gives all details about the last restores.
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} { "startedTime": the start time of restore, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of restore, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of restore, "repositoryName": the name of repository } } {code}

    • infoRestoresRepository

      @RolesAllowed("administrators") public javax.ws.rs.core.Response infoRestoresRepository()
      Gives all details about the last repository restores.
      Returns:
      Response return the response
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} [ { "startedTime": the start time of restore, "backupId": the backup identifier, "type": the type of ShortInfo (current, completed, restore), "state": the state of restore, "backupType": the backup type (full or full+incremental), "workspaceName": the name of workspace, "finishedTime": the finish time of restore, "repositoryName": the name of repository } ] {code}

    • getDefaultWorkspaceConfig

      @RolesAllowed("administrators") public javax.ws.rs.core.Response getDefaultWorkspaceConfig()
      Gives the default workspace configuration.
      Returns:
      Response return the JSON to WorkspaceEntry
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} { "wEntry" : the default workspace configuration. } {code}

    • getDefaultRepositoryConfig

      @RolesAllowed("administrators") public javax.ws.rs.core.Response getDefaultRepositoryConfig()
      Gives the default repository configuration.
      Returns:
      Response return the JSON to WorkspaceEntry
      eXo level API
      Provisional
      eXo response for generated doc on REST API
      {code:json} { "rEntry" : the default repository configuration. } {code}