org.exoplatform.services.jcr.ext.backup
Interface BackupManager

All Known Subinterfaces:

ExtendedBackupManager

All Known Implementing Classes:

BackupManagerImpl

public interface BackupManager

Created by The eXo Platform SARL .

Version:

$Id: $

Author:

Gennady Azarenkov

Field Summary

static int	FULL_AND_INCREMENTAL The full and incremental backup the type of backup.
static int	FULL_BACKUP_ONLY The full backup only the type of backup.

Method Summary

BackupChain	findBackup(String backupId) Finding current backup by identifier.
BackupChain	findBackup(String reposytore, String workspace) Finding current backup by repository and workspace.
RepositoryBackupChain	findRepositoryBackup(String repository) Finding current backup by repository.
RepositoryBackupChain	findRepositoryBackupId(String id) Finding current backup by id.
File	getBackupDirectory() Getting backup directory.
BackupChainLog[]	getBackupsLogs() Getting all backup logs .
Set<BackupChain>	getCurrentBackups() Getting current backups.
Set<RepositoryBackupChain>	getCurrentRepositoryBackups() Getting current repository backups.
long	getDefaultIncrementalJobPeriod() Getting default incremental job period.
String	getFullBackupType() Getting full backup type.
String	getIncrementalBackupType() Getting incremental backup type.
JobRepositoryRestore	getLastRepositoryRestore(String repositoryName) Getting last repository restore by repository name.
JobWorkspaceRestore	getLastRestore(String repositoryName, String workspaceName) Getting last restore by repository and workspace name.
BackupMessage[]	getMessages() Getting the backup messages.
RepositoryBackupChainLog[]	getRepositoryBackupsLogs() Getting all repository backup logs.
List<JobRepositoryRestore>	getRepositoryRestores() Getting list of repository restores.
List<JobWorkspaceRestore>	getRestores() Getting list of restores.
void	restore(BackupChainLog log, String repositoryName, WorkspaceEntry workspaceEntry, boolean asynchronous) Restore from backup.
void	restore(RepositoryBackupChainLog log, RepositoryEntry repositoryEntry, boolean asynchronous) Repository restore from backup.
void	restore(RepositoryBackupChainLog log, RepositoryEntry repositoryEntry, boolean asynchronous, boolean removeJobOnceOver) Repository restore from backup.
void	restore(RepositoryBackupChainLog log, RepositoryEntry repositoryEntry, Map<String,String> workspaceNamesCorrespondMap, boolean asynchronous) Repository restore from backup.
BackupChain	startBackup(BackupConfig config) Starting backup.
RepositoryBackupChain	startBackup(RepositoryBackupConfig config) Starting repository backup.
void	stopBackup(BackupChain backup) Stop backup.
void	stopBackup(RepositoryBackupChain backup) Stop backup.

Field Detail

FULL_BACKUP_ONLY

static final int FULL_BACKUP_ONLY

The full backup only the type of backup.

See Also:

Constant Field Values

FULL_AND_INCREMENTAL

static final int FULL_AND_INCREMENTAL

The full and incremental backup the type of backup.

See Also:

Constant Field Values

Method Detail

getCurrentBackups

Set<BackupChain> getCurrentBackups()

Getting current backups.

Returns:

Set return the set of current backups

getCurrentRepositoryBackups

Set<RepositoryBackupChain> getCurrentRepositoryBackups()

Getting current repository backups.

Returns:

Set return the set of current backups

getRestores

List<JobWorkspaceRestore> getRestores()

Getting list of restores.

Returns:

List return the list of backups

getLastRestore

JobWorkspaceRestore getLastRestore(String repositoryName,
                                   String workspaceName)

Getting last restore by repository and workspace name.

Parameters:

repositoryName - String, the repository name

workspaceName - String, the workspace name

Returns:

JobWorkspaceRestore return the job to restore

getRepositoryRestores

List<JobRepositoryRestore> getRepositoryRestores()

Getting list of repository restores.

Returns:

List return the list of backups

getLastRepositoryRestore

JobRepositoryRestore getLastRepositoryRestore(String repositoryName)

Getting last repository restore by repository name.

Parameters:

repositoryName - String, the repository name

Returns:

JobWorkspaceRestore return the job to restore

getBackupsLogs

BackupChainLog[] getBackupsLogs()

Getting all backup logs .

Returns:

BackupChainLog[] return the all backup logs

getRepositoryBackupsLogs

RepositoryBackupChainLog[] getRepositoryBackupsLogs()

Getting all repository backup logs.

Returns:

RepositoryBackupChainLog[] return the all repository backup logs

startBackup

BackupChain startBackup(BackupConfig config)
                        throws BackupOperationException,
                               BackupConfigurationException,
                               javax.jcr.RepositoryException,
                               RepositoryConfigurationException

Starting backup.

Parameters:

config - BackupConfig, the backup configuration

Returns:

BackupChain return the backup chain

Throws:

BackupOperationException - BackupOperationException will be generate the exception BackupOperationException

BackupConfigurationException - will be generate the exception BackupConfigurationException

javax.jcr.RepositoryException - will be generate the exception RepositoryException

RepositoryConfigurationException - will be generate the exception RepositoryConfigurationException

stopBackup

void stopBackup(BackupChain backup)

Stop backup.

Parameters:

backup - BackupChain, the backup chain

findBackup

BackupChain findBackup(String reposytore,
                       String workspace)

Finding current backup by repository and workspace.

Parameters:

reposytore - String, the repository name

workspace - String, the workspace name

Returns:

BackupChain return the current backup

findBackup

BackupChain findBackup(String backupId)

Finding current backup by identifier.

Parameters:

backupId - String the backup identifier

Returns:

BackupChain return the current backup

restore

void restore(BackupChainLog log,
             String repositoryName,
             WorkspaceEntry workspaceEntry,
             boolean asynchronous)
             throws BackupOperationException,
                    BackupConfigurationException,
                    javax.jcr.RepositoryException,
                    RepositoryConfigurationException

Restore from backup.

Parameters:

log - BackupChainLog, the backup log

repositoryName - String, repository name

workspaceEntry - WorkspaceEntry, the workspace entry

asynchronous - boolean, in 'true' then asynchronous restore.

Throws:

BackupOperationException - will be generate the exception BackupOperationException

BackupConfigurationException - will be generate the exception BackupConfigurationException

javax.jcr.RepositoryException - will be generate the exception RepositoryException

RepositoryConfigurationException - will be generate the exception RepositoryConfigurationException

getMessages

BackupMessage[] getMessages()

Getting the backup messages.

Returns:

BackupMessage[] return the backup messages

getBackupDirectory

File getBackupDirectory()

Getting backup directory.

Returns:

File return the backup directory

getFullBackupType

String getFullBackupType()

Getting full backup type.

Returns:

Sting return FQN to full backup type

getIncrementalBackupType

String getIncrementalBackupType()

Getting incremental backup type.

Returns:

String return FQN to full backup type

getDefaultIncrementalJobPeriod

long getDefaultIncrementalJobPeriod()

Getting default incremental job period.

Returns:

long return the default incremental job period

startBackup

RepositoryBackupChain startBackup(RepositoryBackupConfig config)
                                  throws BackupOperationException,
                                         BackupConfigurationException,
                                         javax.jcr.RepositoryException,
                                         RepositoryConfigurationException

Starting repository backup.

Parameters:

config - RepositoryBackupConfig, the backup configuration to repository

Returns:

RepositoryBackupChain return the repository backup chain

Throws:

BackupOperationException - BackupOperationException will be generate the exception BackupOperationException

BackupConfigurationException - will be generate the exception BackupConfigurationException

javax.jcr.RepositoryException - will be generate the exception RepositoryException

RepositoryConfigurationException - will be generate the exception RepositoryConfigurationException

stopBackup

void stopBackup(RepositoryBackupChain backup)

Stop backup.

Parameters:

backup - RepositoryBackupChain, the repositroy backup chain

restore

void restore(RepositoryBackupChainLog log,
             RepositoryEntry repositoryEntry,
             Map<String,String> workspaceNamesCorrespondMap,
             boolean asynchronous)
             throws BackupOperationException,
                    BackupConfigurationException,
                    javax.jcr.RepositoryException,
                    RepositoryConfigurationException

Repository restore from backup.

Parameters:

log - RepositoryBackupChainLog, the repository backup log

repositoryEntry - RepositoryEntry, the repository entry

workspaceNamesCorrespondMap - Map, the map with correspondence workspace name in RepositoryEntry and RepositoryBackupChainLog.

asynchronous - boolean, in 'true' then asynchronous restore.

Throws:

BackupOperationException - will be generate the exception BackupOperationException

BackupConfigurationException - will be generate the exception BackupConfigurationException

javax.jcr.RepositoryException - will be generate the exception RepositoryException

RepositoryConfigurationException - will be generate the exception RepositoryConfigurationException

restore

void restore(RepositoryBackupChainLog log,
             RepositoryEntry repositoryEntry,
             boolean asynchronous)
             throws BackupOperationException,
                    BackupConfigurationException,
                    javax.jcr.RepositoryException,
                    RepositoryConfigurationException

Repository restore from backup.

Parameters:

log - RepositoryBackupChainLog, the repository backup log

repositoryEntry - RepositoryEntry, the repository entry

asynchronous - boolean, in 'true' then asynchronous restore.

Throws:

BackupOperationException - will be generate the exception BackupOperationException

BackupConfigurationException - will be generate the exception BackupConfigurationException

javax.jcr.RepositoryException - will be generate the exception RepositoryException

RepositoryConfigurationException - will be generate the exception RepositoryConfigurationException

restore

void restore(RepositoryBackupChainLog log,
             RepositoryEntry repositoryEntry,
             boolean asynchronous,
             boolean removeJobOnceOver)
             throws BackupOperationException,
                    BackupConfigurationException,
                    javax.jcr.RepositoryException,
                    RepositoryConfigurationException

Repository restore from backup.

Parameters:

log - RepositoryBackupChainLog, the repository backup log

repositoryEntry - RepositoryEntry, the repository entry

asynchronous - boolean, in 'true' then asynchronous restore.

removeJobOnceOver - boolean, in 'true' then restore job well remove after restore.

Throws:

BackupOperationException - will be generate the exception BackupOperationException

BackupConfigurationException - will be generate the exception BackupConfigurationException

javax.jcr.RepositoryException - will be generate the exception RepositoryException

RepositoryConfigurationException - will be generate the exception RepositoryConfigurationException

findRepositoryBackup

RepositoryBackupChain findRepositoryBackup(String repository)

Finding current backup by repository.

Parameters:

reposytore - String, the repository name

Returns:

RepositoryBackupChain return the current backup to repository

findRepositoryBackupId

RepositoryBackupChain findRepositoryBackupId(String id)

Finding current backup by id.

Parameters:

reposytore - String, the repository name

Returns:

RepositoryBackupChain return the current backup to repository