org.deventropy.junithelper.derby.util

Class DerbyBackupOperationsHelper

java.lang.Object

org.deventropy.junithelper.derby.util.DerbyBackupOperationsHelper

public class DerbyBackupOperationsHelper
extends Object

Helper class used by the EmbeddedDerbyResource to implement online backup operations on the instance.

Author:

Bindul Bhowmik

Constructor Summary

Constructors

Constructor and Description
DerbyBackupOperationsHelper(EmbeddedDerbyResource embeddedDerbyResource) Initializes the backup operations helper with the derby resource.

Method Summary

Modifier and Type	Method and Description
void	backupLiveDatabase(File backupDir, boolean waitForTransactions, boolean enableArchiveLogging, boolean deleteArchivedLogs) Perform an online backup of the running instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

DerbyBackupOperationsHelper

public DerbyBackupOperationsHelper(EmbeddedDerbyResource embeddedDerbyResource)

Initializes the backup operations helper with the derby resource.

Parameters:

embeddedDerbyResource - The derby resource on which backup operations will be invoked.

Method Detail

backupLiveDatabase

public void backupLiveDatabase(File backupDir,
                               boolean waitForTransactions,
                               boolean enableArchiveLogging,
                               boolean deleteArchivedLogs)
                        throws SQLException

Perform an online backup of the running instance. The online backup uses either the SYSCS_UTIL.SYSCS_BACKUP_DATABASE if enableArchiveLogging is set to false or SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE otherwise. If the waitForTransactions parameter is set to false the _NOWAIT versions of the procedures are used.

For more information on backing up Derby database, see Using the backup procedures to perform an online backup in the Derby Administrators guide.

Parameters:

backupDir - The directory to which the database should be backed up.

waitForTransactions - Wait for running transactions to complete.

enableArchiveLogging - If archive logging should be enabled for the database.

deleteArchivedLogs - Ask Derby to delete the old archive logs after the backup is successful.

Throws:

SQLException - Exception from Derby when the backup fails.