com.sleepycat.je

Class BackupFSArchiveCopy

java.lang.Object

com.sleepycat.je.BackupFSArchiveCopy

All Implemented Interfaces:

BackupFileCopy

public class BackupFSArchiveCopy
extends Object
implements BackupFileCopy

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHECKSUM_KEY

Constructor Summary

Constructors

Constructor and Description
BackupFSArchiveCopy()

Method Summary

Modifier and Type	Method and Description
byte[]	checksum(URL archiveURL) Returns the checksum computed by reading archiveFile.
byte[]	copy(File localFile, URL archiveURL) Note that the copy implementation can afford to be simple and not clean up on failure since a partially copied archiveURL file can never be part of the manifest.
String	getChecksumAlg() Returns the checksum algorithm used to checksum the archive file being accessed.
String	getCompressionAlg() Returns the compression algorithm used to compress the archive file being accessed.
String	getEncryptionAlg() Returns the encryption algorithm used to encrypt/decrypt the archive file being accessed.
void	initialize(File configFile) initialize is invoked exactly once after the creation of the object via its noargs constructor.

Methods inherited from class java.lang.Object

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

Field Detail

CHECKSUM_KEY

public static final String CHECKSUM_KEY

See Also:

Constant Field Values

Constructor Detail

BackupFSArchiveCopy

public BackupFSArchiveCopy()

Method Detail

initialize

public void initialize(File configFile)
                throws InterruptedException,
                       IOException

Description copied from interface: BackupFileCopy

initialize is invoked exactly once after the creation of the object via its noargs constructor.

Specified by:

initialize in interface BackupFileCopy

Parameters:

configFile - the config file used to initialize the object. It could, for example, contain the credentials needed to access the archive,the compression and encryption algorithms used to store archive files, etc. The format of the config file (properties, json, etc.) is private to the implementation.

Throws:

InterruptedException - if the initialize operation is interrupted

IOException - if some irrecoverable I/O issue was encountered during initialization.

getEncryptionAlg

public String getEncryptionAlg()

Description copied from interface: BackupFileCopy

Returns the encryption algorithm used to encrypt/decrypt the archive file being accessed. The encryption algorithm is set via the config file during the call to BackupFileCopy.initialize(java.io.File). The algorithm name is a valid argument to Cipher or the provider overloading used by the implementation.

Specified by:

getEncryptionAlg in interface BackupFileCopy

Returns:

null (if no encryption is in use), or the name of the encryption algorithm.

getCompressionAlg

public String getCompressionAlg()

Description copied from interface: BackupFileCopy

Returns the compression algorithm used to compress the archive file being accessed. The compression algorithm is set via the config file during the call to BackupFileCopy.initialize(java.io.File).

Specified by:

getCompressionAlg in interface BackupFileCopy

Returns:

null (if no compression is in use), or the name of the compression algorithm. The value (for now) could be one of zip or gzip.

getChecksumAlg

public String getChecksumAlg()

Description copied from interface: BackupFileCopy

Returns the checksum algorithm used to checksum the archive file being accessed. The checksum algorithm is set via the config file during the call to BackupFileCopy.initialize(java.io.File). The algorithm name is a valid argument to MessageDigest.getInstance(String) or the provider overloading used by the implementation.

Specified by:

getChecksumAlg in interface BackupFileCopy

Returns:

The name of the checksum algorithm

copy

public byte[] copy(File localFile,
                   URL archiveURL)
            throws InterruptedException,
                   IOException

Note that the copy implementation can afford to be simple and not clean up on failure since a partially copied archiveURL file can never be part of the manifest. Such a partially copied file will typically be overwritten as the backup manager retries the copy and if it succeeds, it becomes part of the manifest. If the copy is abandoned, the archive pruning utility will eventually delete it and reclaim its storage.

Specified by:

copy in interface BackupFileCopy

Parameters:

localFile - the file to be copied

archiveURL - the target path for the copy; it must be an absolute URL

Returns:

the checksum of the contents of localFile as they were at the time of the copy.

Throws:

InterruptedException - if the copy is interrupted

IOException - if some irrecoverable I/O issue was encountered either while reading or writing the file.

checksum

public byte[] checksum(URL archiveURL)
                throws InterruptedException,
                       IOException

Description copied from interface: BackupFileCopy

Returns the checksum computed by reading archiveFile. The file is assumed to be encrypted and compressed in the archive according to the configuration specified by BackupFileCopy.initialize(java.io.File)

Specified by:

checksum in interface BackupFileCopy

Parameters:

archiveURL - the archive file being read to compute the checksum value; it must be an absolute URL

Returns:

the checksum value

Throws:

InterruptedException - if the checksum operation is interrupted

IOException - if some irrecoverable I/O issue was encountered while reading the archiveFile