Package com.atlassian.crowd.manager.backup

Class DefaultBackupManager

java.lang.Object

com.atlassian.crowd.manager.backup.DefaultBackupManager

All Implemented Interfaces:

BackupManager

public class DefaultBackupManager
extends Object
implements BackupManager

Default implementation of BackupManager

Since:

v2.7

Constructor Summary

Constructors

Constructor	Description
DefaultBackupManager(XmlMigrationManager xmlMigrationManager, BackupFileStore backupFileStore, PropertyManager propertyManager)

Method Summary

Modifier and Type	Method	Description
long	backup(String exportFileName)	Perform an XML export of crowd, as well as of the directory configuration.
long	backup(String exportFileName, boolean resetDomain)	Perform an XML export of crowd, as well as of the directory configuration.
String	generateAutomatedBackupFileName()	Generate a filename for an automated backup, that can then be used with BackupManager.backup(String, boolean).
BackupSummary	getAutomatedBackupSummary()	Return a summary of how many automated backups are present, and how old are the oldest and most recent backups.
String	getBackupFileFullPath(String fileName)	Generate the full path of the given backup filename.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultBackupManager

public DefaultBackupManager(XmlMigrationManager xmlMigrationManager,
 BackupFileStore backupFileStore,
 PropertyManager propertyManager)

Method Details

generateAutomatedBackupFileName

public String generateAutomatedBackupFileName()

Description copied from interface: BackupManager

Generate a filename for an automated backup, that can then be used with BackupManager.backup(String, boolean).

Specified by:

generateAutomatedBackupFileName in interface BackupManager

Returns:

a filename

getBackupFileFullPath

public String getBackupFileFullPath(String fileName)

Description copied from interface: BackupManager

Generate the full path of the given backup filename.

Specified by:

getBackupFileFullPath in interface BackupManager

Parameters:

fileName - a filename

Returns:

a full path

backup

public long backup(String exportFileName)
            throws ExportException,
BackupOrRestoreAlreadyInProgressException

Description copied from interface: BackupManager

Perform an XML export of crowd, as well as of the directory configuration.

Specified by:

backup in interface BackupManager

Parameters:

exportFileName - the name of the file to export to (not the full path)

Returns:

the time it took to execute the export, in milliseconds

Throws:

ExportException - in case an error happens while exporting the data

BackupOrRestoreAlreadyInProgressException - in case a backup or a restore is already in progress

backup

@Transactional
public long backup(String exportFileName,
 boolean resetDomain)
            throws ExportException,
BackupOrRestoreAlreadyInProgressException

Description copied from interface: BackupManager

Perform an XML export of crowd, as well as of the directory configuration.

Specified by:

backup in interface BackupManager

Parameters:

exportFileName - the name of the file to export to (not the full path)

resetDomain - whether to activate the RESET_DOMAIN option or not

Returns:

the time it took to execute the export, in milliseconds

Throws:

ExportException - in case an error happens while exporting the data

BackupOrRestoreAlreadyInProgressException - in case a backup or a restore is already in progress

getAutomatedBackupSummary

public BackupSummary getAutomatedBackupSummary()

Description copied from interface: BackupManager

Return a summary of how many automated backups are present, and how old are the oldest and most recent backups.

Specified by:

getAutomatedBackupSummary in interface BackupManager

Returns:

a BackupSummary