backupmanagment

Class BackupInstance

java.lang.Object

backupmanagment.BackupInstance

All Implemented Interfaces:

java.io.Serializable

 class BackupInstance
extends java.lang.Object
implements java.io.Serializable

Holds every information about a scheduled backup. The BackupManager class manages, creates and serializes instances of this class.
Created by Martin Sicho on 19.3.14.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.Long>	mBackupIndex This is the file index.
private java.lang.String	mDirBackup Path to the directory where the copies are stored as String.
private java.lang.String	mDirOriginal Path to the original directory as String.
private boolean	mKeepAll Specifies whether a complete file history should be kept or not.
private java.util.Date	mLastSynchronization This is the Date of last synchronization of this BackupInstance.
private java.lang.String	mName The backup name.
private boolean	mShallow Specifies whether the backup is shallow or not.

Constructor Summary

Constructors

Constructor and Description
BackupInstance(BackupInstanceFramework framework) The class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	addBackupToIndex(java.nio.file.Path original_path, java.nio.file.attribute.FileTime last_modified) Indexes a path.
(package private) void	backupDirectory(java.nio.file.Path dir, java.nio.file.attribute.FileTime last_modified) Creates a backup of a directory.
(package private) void	backupFile(java.nio.file.Path file, java.nio.file.attribute.FileTime last_modified) Creates a backup of a file.
(package private) java.nio.file.Path	dirBackup() This method returns the path to the directory where the backed up data are to be created.
(package private) java.nio.file.Path	dirOriginal() This method returns path to the original file or directory.
(package private) boolean	isBackupCreated(java.nio.file.Path path) Checks if a backup of an original file/directory exists.
(package private) boolean	isPathIndexed(java.nio.file.Path path) Checks if the input path is indexed.
(package private) boolean	isShallow()
(package private) java.util.Date	lastSyncDate() This method returns the date of last synchronization.
(package private) void	removeBackupFromIndex(java.nio.file.Path original_path) The opposite of addBackupToIndex(java.nio.file.Path, java.nio.file.attribute.FileTime).
private void	removeDeleted() Calls the DeleteFileVisitor to delete files that are no longer present in the original directory.
(package private) java.nio.file.Path	retrieveBackupPath(java.nio.file.Path original_path) This method, together with retrieveOriginalpath(java.nio.file.Path), provides the program with the ability to rebuild the directory tree of the original location in the backup directory.
(package private) java.nio.file.attribute.FileTime	retrieveLastBackupTime(java.nio.file.Path path) Fetches the last modified time known when the file/directory was last indexed.
(package private) java.nio.file.Path	retrieveOriginalpath(java.nio.file.Path backup_path) This method, together with retrieveBackupPath(java.nio.file.Path) , provides the program with the ability to rebuild the directory tree of the original location in the backup directory.
(package private) void	rewriteLastModified(java.nio.file.Path backup_dir, java.nio.file.attribute.FileTime last_modified) Set last modified time for a directory.
(package private) void	synchronize() This method is used to synchronize the backup directory with the original.

Methods inherited from class java.lang.Object

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

Field Detail

mName

private java.lang.String mName

The backup name.

mDirOriginal

private java.lang.String mDirOriginal

Path to the original directory as String.

mDirBackup

private java.lang.String mDirBackup

Path to the directory where the copies are stored as String.

mShallow

private boolean mShallow

Specifies whether the backup is shallow or not.

mKeepAll

private boolean mKeepAll

Specifies whether a complete file history should be kept or not.

mBackupIndex

private java.util.Map<java.lang.String,java.lang.Long> mBackupIndex

This is the file index. There is a Long value attached to each file. It represents the last modified date of the file when it was last backed up.

mLastSynchronization

private java.util.Date mLastSynchronization

This is the Date of last synchronization of this BackupInstance.

Constructor Detail

BackupInstance

BackupInstance(BackupInstanceFramework framework)

The class constructor. Takes one instance of BackupInstanceFramework that serves as a template for the serializable BackupInstance object.

Parameters:

framework - instance of BackupInstanceFramework

Method Detail

synchronize

void synchronize()

This method is used to synchronize the backup directory with the original. It controls the flow according to rules set by BackupInstanceFramework instance that was passed to the class constructor.

lastSyncDate

java.util.Date lastSyncDate()

This method returns the date of last synchronization.

Returns:

date of last synchronization as Date

dirOriginal

java.nio.file.Path dirOriginal()

This method returns path to the original file or directory.

Returns:

Path to the original.

dirBackup

java.nio.file.Path dirBackup()

This method returns the path to the directory where the backed up data are to be created.

Returns:

Path to the backup directory.

isShallow

boolean isShallow()

retrieveBackupPath

java.nio.file.Path retrieveBackupPath(java.nio.file.Path original_path)

This method, together with retrieveOriginalpath(java.nio.file.Path), provides the program with the ability to rebuild the directory tree of the original location in the backup directory.
It takes an instance of Path that is located within the original directory and transforms it into a Path pointing to the same location in the backup directory.

Parameters:

original_path - a Path located somewhere in the original directory

Returns:

a corresponding Path in the backup directory

retrieveOriginalpath

java.nio.file.Path retrieveOriginalpath(java.nio.file.Path backup_path)

This method, together with retrieveBackupPath(java.nio.file.Path) , provides the program with the ability to rebuild the directory tree of the original location in the backup directory.
It takes an instance of Path that is located within the backup directory and transforms it into a Path pointing to the same location in the original directory.

Parameters:

backup_path - a path located somewhere in the backup directory

Returns:

a corresponding path to the original

addBackupToIndex

void addBackupToIndex(java.nio.file.Path original_path,
                    java.nio.file.attribute.FileTime last_modified)

Indexes a path. Only paths to the original are indexed (they can be converted back to the backup location with the retrieveBackupPath(java.nio.file.Path) method).

Parameters:

original_path - instance of Path pointing to file/directory to be indexed.

last_modified - instance of FileTime specifying the time of last modification of the original file/directory

removeBackupFromIndex

void removeBackupFromIndex(java.nio.file.Path original_path)

The opposite of addBackupToIndex(java.nio.file.Path, java.nio.file.attribute.FileTime). Removes the path from the index.

Parameters:

original_path - instance of Path that points to the original to be removed from index.

isPathIndexed

boolean isPathIndexed(java.nio.file.Path path)

Checks if the input path is indexed.

Parameters:

path - the path to be checked.

Returns:

returns true, if it is indexed, false if it isn't

retrieveLastBackupTime

java.nio.file.attribute.FileTime retrieveLastBackupTime(java.nio.file.Path path)

Fetches the last modified time known when the file/directory was last indexed.

Parameters:

path - input path

Returns:

instance of FileTime specifying the time of last modification of the original file/directory when it was last indexed.

isBackupCreated

boolean isBackupCreated(java.nio.file.Path path)

Checks if a backup of an original file/directory exists.

Parameters:

path - the path to be checked.

Returns:

returns true, if backup exists, false if it doesn't

backupDirectory

void backupDirectory(java.nio.file.Path dir,
                   java.nio.file.attribute.FileTime last_modified)

Creates a backup of a directory.

Parameters:

dir - Path to the directory that is being backed.

last_modified - known last modified time in the form of FileTime instance

backupFile

void backupFile(java.nio.file.Path file,
              java.nio.file.attribute.FileTime last_modified)

Creates a backup of a file.

Parameters:

file - Path to the file that is being backed.

last_modified - known last modified time in the form of FileTime instance

rewriteLastModified

void rewriteLastModified(java.nio.file.Path backup_dir,
                       java.nio.file.attribute.FileTime last_modified)

Set last modified time for a directory. This method is used by BackupFileVisitor to set correct last modified times for directories in the backup location.
NOTE: this feature is pretty much useless at the moment because directories are created top to bottom and that means only one level directories will be affected. A second file tree walk would be needed to eliminate this I suppose...

Parameters:

backup_dir - location in the backup directory

last_modified - last modified time of the original directory (located somewhere in the backup path)

removeDeleted

private void removeDeleted()
                    throws java.io.IOException

Calls the DeleteFileVisitor to delete files that are no longer present in the original directory.

Throws:

java.io.IOException