com.aspc.backup

Class BackupUtil

java.lang.Object

com.aspc.backup.BackupUtil

public final class BackupUtil
extends java.lang.Object

THREAD MODE: MULTI-THREADED Servlet

Since:

7 October 2003

Author:

Jason McGrath

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BACKUP_DIR backup directory
static java.lang.String	DB_BACKUP_EXT database backup extension
static java.lang.String	DOC_BACKUP_EXT document backup extension
static java.lang.String	PROP_BACKUP_EXT properties backup extension
static java.lang.String	SRC_BACKUP_EXT src backup extension

Method Summary

Modifier and Type	Method and Description
static void	backupDB(DataBase db, java.lang.String fileName) back up a database.
static void	backupDB(DataBase db, java.lang.String fileName, java.lang.String includeTables) back up a database.
static void	backupDocs(VirtualDB vdb, java.lang.String fileName, java.lang.String pattern) Backup the documents for this layer
static void	backupProperties(DataBase masterDb, int layerId, java.lang.String fileName) back up the properties
static void	backupSrc(java.lang.String srcFolder, java.lang.String zipFileName, java.lang.String incPattern, java.lang.String excPattern)
static java.lang.String	findBackupFile(VirtualDB vdb, java.lang.String backupDir, java.lang.String ext, java.util.Date beforeDt) find the matching backup file.
static java.lang.String	generateFileName(VirtualDB vdb, java.lang.String backupDir, java.lang.String ext) generate the backup file name
static java.lang.String	getBackupDir() get the current backup directory
static void	restoreDB(DataBase db, java.lang.String fileName) Restores a database from an backup file Defaults to dropping all tables before loading
static void	restoreDB(DataBase db, java.lang.String fileName, boolean drop, java.lang.String pattern) Restores a database from an backup file The drop option indicates that existing tables should be removed before loading into that table
static void	updateBackupDt(VirtualDB vdb) mark the virtual db as backed up at this time.

Methods inherited from class java.lang.Object

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

Field Detail

BACKUP_DIR

public static final java.lang.String BACKUP_DIR

backup directory

See Also:

Constant Field Values

DB_BACKUP_EXT

public static final java.lang.String DB_BACKUP_EXT

database backup extension

See Also:

Constant Field Values

DOC_BACKUP_EXT

public static final java.lang.String DOC_BACKUP_EXT

document backup extension

See Also:

Constant Field Values

SRC_BACKUP_EXT

public static final java.lang.String SRC_BACKUP_EXT

src backup extension

See Also:

Constant Field Values

PROP_BACKUP_EXT

public static final java.lang.String PROP_BACKUP_EXT

properties backup extension

See Also:

Constant Field Values

Method Detail

backupDB

public static void backupDB(DataBase db,
                            @Nonnull
                            java.lang.String fileName)
                     throws java.lang.Exception

back up a database.

Parameters:

db - the database to backup

fileName - the target file

Throws:

java.lang.Exception - a serious problem

backupDB

public static void backupDB(@Nonnull
                            DataBase db,
                            @Nonnull
                            java.lang.String fileName,
                            @Nullable
                            java.lang.String includeTables)
                     throws java.lang.Exception

back up a database.

Parameters:

db - the database to backup

fileName - the target file

includeTables -

Throws:

java.lang.Exception - a serious problem

updateBackupDt

public static void updateBackupDt(@Nonnull
                                  VirtualDB vdb)
                           throws java.lang.Exception

mark the virtual db as backed up at this time.

Parameters:

vdb - the layer

Throws:

java.lang.Exception - a serious problem

backupSrc

public static void backupSrc(java.lang.String srcFolder,
                             java.lang.String zipFileName,
                             java.lang.String incPattern,
                             java.lang.String excPattern)
                      throws java.lang.Exception

Throws:

java.lang.Exception

backupDocs

public static void backupDocs(@Nonnull
                              VirtualDB vdb,
                              @Nonnull
                              java.lang.String fileName,
                              java.lang.String pattern)
                       throws java.lang.Exception

Backup the documents for this layer

Parameters:

pattern - the set of files to backup.

vdb - the layer

fileName - the target file.

Throws:

java.lang.Exception - a serious problem

backupProperties

public static void backupProperties(DataBase masterDb,
                                    int layerId,
                                    java.lang.String fileName)
                             throws java.lang.Exception

back up the properties

Parameters:

masterDb - the master database

layerId - the layer

fileName - the target file.

Throws:

java.lang.Exception - a serious problem.

restoreDB

public static void restoreDB(DataBase db,
                             java.lang.String fileName)
                      throws java.lang.Exception

Restores a database from an backup file Defaults to dropping all tables before loading

Parameters:

db - - database to load into

fileName - - location of backup file

Throws:

java.lang.Exception - a serious problem

restoreDB

public static void restoreDB(DataBase db,
                             java.lang.String fileName,
                             boolean drop,
                             java.lang.String pattern)
                      throws java.lang.Exception

Restores a database from an backup file The drop option indicates that existing tables should be removed before loading into that table

Parameters:

db - - database to load into

fileName - - location of backup file

drop - - drop table before loading

pattern - - table name filter pattern

Throws:

java.lang.Exception - a serious problem

getBackupDir

public static java.lang.String getBackupDir()

get the current backup directory

Returns:

the directory

findBackupFile

public static java.lang.String findBackupFile(VirtualDB vdb,
                                              java.lang.String backupDir,
                                              java.lang.String ext,
                                              java.util.Date beforeDt)
                                       throws java.lang.Exception

find the matching backup file.

Parameters:

vdb - the layer

backupDir - the dir

ext - the extension

beforeDt - the last date

Returns:

the backup file.

Throws:

java.lang.Exception - a serious problem

generateFileName

public static java.lang.String generateFileName(VirtualDB vdb,
                                                java.lang.String backupDir,
                                                java.lang.String ext)
                                         throws java.lang.Exception

generate the backup file name

Parameters:

vdb - the layer

backupDir - the dir

ext - the extension

Returns:

the file.

Throws:

java.lang.Exception - a serious problem