org.exoplatform.jcr.backupconsole
Interface BackupClient

All Known Implementing Classes:

BackupClientImpl

public interface BackupClient

Created by The eXo Platform SAS.
Date:

Version:

$Id: BackupClient.java 111 2008-11-11 11:11:11Z serg $

Author:

Karpenko Sergiy

Method Summary

String	drop(boolean forceClose, String repositoryName, String workspaceName) Drop workspace or repository.
String	info() Get information about backup service.
String	list() Get information about the current backups (in progress).
String	listCompleted() Get information about the completed (ready to restore) backups.
String	restore(String repositoryName, String workspaceName, String backupId, InputStream config, String backupSetPath, boolean removeExosts) Restore repository or workspace from backup file.
String	restores(String repositoryName, String workspaceName) Get information about current restores of repository or workspace.
String	startBackUp(String repositoryName, String workspaceName, String backupDir) Start backup of repository or workspace.
String	startIncrementalBackUp(String repositoryName, String workspaceName, String backupDir, long incr) Start Incremental Backup of repository or workspace.
String	status(String backupId) Get Status of backup.
String	stop(String backupId) Stop backup.

Method Detail

startBackUp

String startBackUp(String repositoryName,
                   String workspaceName,
                   String backupDir)
                   throws IOException,
                          BackupExecuteException

Start backup of repository or workspace. If workspaceName is 'null', then repository backup will be started.

Parameters:

repositoryName - String, the repository name.

workspaceName - String, the workspace name.

backupDir - path to backup folder on remote server

Returns:

String result

Throws:

IOException - transport exception.

BackupExecuteException - backup client internal exception.

startIncrementalBackUp

String startIncrementalBackUp(String repositoryName,
                              String workspaceName,
                              String backupDir,
                              long incr)
                              throws IOException,
                                     BackupExecuteException

Start Incremental Backup of repository or workspace. If workspaceName is 'null', then repository backup will be started.

Parameters:

repositoryName - String, the repository name

workspaceName - String, the workspace name

incr - incremental job period.

backupDir - path to backup folder on remote server

Returns:

String result

Throws:

IOException - transport exception

BackupExecuteException - backup client internal exception

status

String status(String backupId)
              throws IOException,
                     BackupExecuteException

Get Status of backup.

Parameters:

backupId - the backup identifier.

Returns:

String result.

Throws:

IOException - transport exception.

BackupExecuteException - backup client internal exception.

info

String info()
            throws IOException,
                   BackupExecuteException

Get information about backup service.

Returns:

String result

Throws:

IOException - transport exception

BackupExecuteException - backup client internal exception

restores

String restores(String repositoryName,
                String workspaceName)
                throws IOException,
                       BackupExecuteException

Get information about current restores of repository or workspace. If workspaceName is 'null', then will be get status of repository backup.

Parameters:

repositoryName - String, the repository name

workspaceName - String, the workspace name

Returns:

String result

Throws:

IOException - transport exception

BackupExecuteException - backup client internal exception

restore

String restore(String repositoryName,
               String workspaceName,
               String backupId,
               InputStream config,
               String backupSetPath,
               boolean removeExosts)
               throws IOException,
                      BackupExecuteException

Restore repository or workspace from backup file. If workspaceName is 'null', then will be run restore of repository.

Parameters:

repositoryName - String, the repository name

workspaceName - String, the workspace name

backupId - the backup identifier

config - InputStream contains workspace configuration

backupSetPath - String, path to backup set directory on server side

removeExosts - boolean. if 'true' then will be removed(clean db, value storage, index) existed repository/workspace.

Returns:

String result

Throws:

IOException - transport exception

BackupExecuteException - backup client internal exception

stop

String stop(String backupId)
            throws IOException,
                   BackupExecuteException

Stop backup.

Parameters:

backupId - the backup identifier

Returns:

String result

Throws:

IOException - transport exception

BackupExecuteException - backup client internal exception

drop

String drop(boolean forceClose,
            String repositoryName,
            String workspaceName)
            throws IOException,
                   BackupExecuteException

Drop workspace or repository. If workspaceName is 'null', then repository will be dropped.

Parameters:

forceClose - force sessions close on repository or workspace

repositoryName - String, the repository name

workspaceName - String, the workspace name

Returns:

String result

Throws:

IOException - transport exception

BackupExecuteException - backup client internal exception

list

String list()
            throws IOException,
                   BackupExecuteException

Get information about the current backups (in progress).

Returns:

String result

Throws:

IOException - transport exception

BackupExecuteException - backup client internal exception

listCompleted

String listCompleted()
                     throws IOException,
                            BackupExecuteException

Get information about the completed (ready to restore) backups.

Returns:

String result

Throws:

IOException - transport exception

BackupExecuteException - backup client internal exception