de.ipcon.db.blob

Class ServerFileVault

java.lang.Object

de.ipcon.db.blob.ServerFileVault

All Implemented Interfaces:

FileVaultI, ServerFileVaultI, IntegrityCheckingServerFileVaultI

public class ServerFileVault
extends java.lang.Object
implements ServerFileVaultI

This class is a singleton which provides transactional access to files (connected to database-objects) using TransactionalFileI-objects

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILEEXTENSION_BLOB
static java.lang.String	FILEEXTENSION_LOG
static org.apache.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
ServerFileVault(java.io.File _newFilesDir, java.io.File _storageDir, java.io.File _backupDir, java.io.File _lostAndFoundDir, java.io.File _atticDir)
ServerFileVault(java.io.File _newFilesDir, java.io.File _storageDir, java.io.File _backupDir, java.io.File _lostAndFoundDir, java.io.File _atticDir, DBManLocalI _dbm)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBackupFileName(java.lang.Long boid, java.lang.Long bpid)
java.lang.String	getBackupFileNameTemp(java.lang.Long boid, java.lang.Long bpid)
java.io.File	getBLOB(java.lang.Long boid) get the BLOB belonging to BO[id].
java.io.File	getBLOB(java.lang.Long boid, java.lang.Long backuppingBPId) get the BLOB belonging to BO[id].
InitialBLOBTransferMetaDataContainer	getBLOBBOIdsForIntitialBLOBCopy(java.util.Map idsAndVFilesOnSyncNode, java.util.List pendingBLOBChangeBOIdsOnSyncNode, java.util.List pendingBLOBChangeBOIdsOnAuthNode) Returns the Ids of all local BLOBs, unless they are older or have the same hash as listed in the passed Map This method is called on the receiving end of command CMD_COPYBLOBS to determine which BLOBs exist locally, that do not exist on the sender's end or have a different hash.
VFile	getBLOBInfo(java.lang.Long id) gathers information about the BLOB belonging to BO[i].
VFile	getBLOBInfo(java.lang.Long id, java.lang.Long backuppingBPId) gathers information about the BLOB belonging to BO[i].
java.util.Iterator<java.lang.Long>	getExistingBLOBsIdIterator()
java.util.Iterator<java.lang.Long>	getExistingBLOBsIdIterator(java.util.Set<java.lang.Long> pendingBLOBChangeBOIdsLocal)
java.util.Iterator<VFile>	getExistingBLOBsVFileIterator(java.util.Set<java.lang.Long> pendingBLOBChangeBOIdsLocal) Traverses the storageDir and creates a Map with the ids and the VFile (with metadata about the file).
ManagedFileI	getHandle(java.io.InputStream is, java.lang.Long id) Returns a ManagedFileI for reading binary data from the given InputStream and storing it as BLOB of the BO with the passed Id
ManagedFileI	getHandle(java.io.InputStream is, java.lang.Long id, boolean noHistory)
ManagedFileI	getHandleForPullDuringSync(BLOBLoaderI blobLoader, long len, java.lang.String blobHash, java.lang.Long boid, java.lang.Long backuppingBPId, boolean noHistory)
ManagedFileI	getHandleForPushDuringSync(java.lang.Long id, boolean deletion, java.lang.Long backuppingBPId, java.lang.String blobHash)
ManagedFileI	getHandleForReceivingBLOBOnServerSide(java.io.ObjectInput in, long len, java.lang.String blobHash, java.lang.Long id, boolean syncMode, boolean noHistory)
ManagedFileI	getHandleForRemoveBLOB(java.lang.String oldHash, java.lang.Long id)
ManagedFileI	getHandleForRemoveBLOB(java.lang.String oldHash, java.lang.Long id, boolean noHistory)
ManagedFileI	getHandleForUndoBLOBChangeOnServerSide(java.lang.String oldHash, java.lang.String newHash, java.lang.Long undoBPId, java.lang.Long id, boolean noHistory)
static ServerFileVault	getInstance(DBManLocalI _dbm, netrexx.lang.Rexx _section)
static ServerFileVault	getInstance(DBManLocalI _dbm, netrexx.lang.Rexx _section, java.lang.String _legacyFilesRootName)
static ServerFileVault	getInstance(java.io.File _newFilesDir, java.io.File _storageDir, java.io.File _backupDir, java.io.File _lostAndFoundDir, java.io.File _atticDir)
InputStreamWrapper	getStream(java.lang.Long id) get the BLOB belonging to BO[id].
InputStreamWrapper	getStream(java.lang.Long id, java.lang.Long backuppingBPId) get the BLOB belonging to BO[id].
void	recover()
void	retireOrphanedBLOBsEventually(java.util.Set<java.lang.Long> blobIds)
VFile	storeRemoteBLOB(BLOBInputI in, java.lang.String newBLOBIdString, VFile rvfile, int current, int totalBLOBs)
long	toDataOutput(java.lang.Long boid, java.io.DataOutput oo, boolean closeOS, java.lang.Long backuppingBPId) Writes the BLOB belonging to BO[id] to the passed DataOutput.
long	toStream(java.lang.Long boid, java.io.OutputStream os, boolean closeOS, java.lang.Long backuppingBPId) Writes the BLOB belonging to BO[id] to the passed OutputStream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.ipcon.db.blob.ServerFileVaultI

exists, exists

Field Detail

log

public static final org.apache.log4j.Logger log

FILEEXTENSION_LOG

public static final java.lang.String FILEEXTENSION_LOG

See Also:

Constant Field Values

FILEEXTENSION_BLOB

public static final java.lang.String FILEEXTENSION_BLOB

See Also:

Constant Field Values

Constructor Detail

ServerFileVault

public ServerFileVault(java.io.File _newFilesDir,
                       java.io.File _storageDir,
                       java.io.File _backupDir,
                       java.io.File _lostAndFoundDir,
                       java.io.File _atticDir)

ServerFileVault

public ServerFileVault(java.io.File _newFilesDir,
                       java.io.File _storageDir,
                       java.io.File _backupDir,
                       java.io.File _lostAndFoundDir,
                       java.io.File _atticDir,
                       DBManLocalI _dbm)

Method Detail

getInstance

public static ServerFileVault getInstance(java.io.File _newFilesDir,
                                          java.io.File _storageDir,
                                          java.io.File _backupDir,
                                          java.io.File _lostAndFoundDir,
                                          java.io.File _atticDir)

getInstance

public static ServerFileVault getInstance(DBManLocalI _dbm,
                                          netrexx.lang.Rexx _section)

getInstance

public static ServerFileVault getInstance(DBManLocalI _dbm,
                                          netrexx.lang.Rexx _section,
                                          java.lang.String _legacyFilesRootName)

retireOrphanedBLOBsEventually

public void retireOrphanedBLOBsEventually(java.util.Set<java.lang.Long> blobIds)

Specified by:

retireOrphanedBLOBsEventually in interface IntegrityCheckingServerFileVaultI

recover

public void recover()
             throws java.io.IOException

Specified by:

recover in interface ServerFileVaultI

Throws:

java.io.IOException

getBLOBInfo

public VFile getBLOBInfo(java.lang.Long id)

Description copied from interface: ServerFileVaultI

gathers information about the BLOB belonging to BO[i].

Specified by:

getBLOBInfo in interface ServerFileVaultI

Parameters:

id - the id of the BO the BLOB-info belongs to.

Returns:

VFile object containing information about lastmodification and size.

getBLOBInfo

public VFile getBLOBInfo(java.lang.Long id,
                         java.lang.Long backuppingBPId)

Description copied from interface: ServerFileVaultI

gathers information about the BLOB belonging to BO[i].

Specified by:

getBLOBInfo in interface ServerFileVaultI

Parameters:

id - the id of the BO the BLOB-info belongs to.

backuppingBPId - the information should be taken from the backup-BLOB in the backup-dir using this BP-Id

Returns:

VFile object containing information about lastmodification and size.

getStream

public InputStreamWrapper getStream(java.lang.Long id)

Description copied from interface: ServerFileVaultI

get the BLOB belonging to BO[id]. Gives back an InputStreamWrapper of the BLOB.

Specified by:

getStream in interface ServerFileVaultI

Parameters:

id - the id of the BO the BLOB belongs to.

Returns:

an InputStreamWrapper containing the data of the BLOB.

getStream

public InputStreamWrapper getStream(java.lang.Long id,
                                    java.lang.Long backuppingBPId)

Description copied from interface: ServerFileVaultI

get the BLOB belonging to BO[id]. Gives back an InputStreamWrapper of the BLOB.

Specified by:

getStream in interface ServerFileVaultI

Parameters:

id - the id of the BO the BLOB belongs to.

backuppingBPId - the data should be taken from the backup-BLOB in the backup-dir using this BP-Id

Returns:

an InputStreamWrapper containing the data of the BLOB.

toStream

public long toStream(java.lang.Long boid,
                     java.io.OutputStream os,
                     boolean closeOS,
                     java.lang.Long backuppingBPId)
              throws java.io.IOException

Description copied from interface: ServerFileVaultI

Writes the BLOB belonging to BO[id] to the passed OutputStream. writes to te given OutputStream

Specified by:

toStream in interface ServerFileVaultI

Parameters:

boid - the id of the BO the BLOB belongs to

os - the OutputStream to write the BLOB-bytes to

closeOS - a boolean designating if the OutputStream shall be closed afterwards or not.

backuppingBPId - the data should be taken from the backup-BLOB in the backup-dir using this BP-Id

Throws:

java.io.IOException

toDataOutput

public long toDataOutput(java.lang.Long boid,
                         java.io.DataOutput oo,
                         boolean closeOS,
                         java.lang.Long backuppingBPId)
                  throws java.io.IOException

Description copied from interface: ServerFileVaultI

Writes the BLOB belonging to BO[id] to the passed DataOutput. writes to te given DataOutput

Specified by:

toDataOutput in interface ServerFileVaultI

Parameters:

boid - the id of the BO the BLOB belongs to

oo - the DataOutput to write the BLOB-bytes to

closeOS - a boolean designating if the DataOutput shall be closed afterwards or not.

backuppingBPId - the BLOB should be taken from the backup-dir using this BP-Id

Throws:

java.io.IOException

getBLOB

public java.io.File getBLOB(java.lang.Long boid)

Description copied from interface: ServerFileVaultI

get the BLOB belonging to BO[id]. Gives back a File.

Specified by:

getBLOB in interface ServerFileVaultI

Parameters:

boid - the id of the BO the BLOB belongs to.

Returns:

a File handle pointing to a file containing the data of the BLOB.

getBLOB

public java.io.File getBLOB(java.lang.Long boid,
                            java.lang.Long backuppingBPId)

Description copied from interface: ServerFileVaultI

get the BLOB belonging to BO[id]. Gives back a File.

Specified by:

getBLOB in interface ServerFileVaultI

Parameters:

boid - the id of the BO the BLOB belongs to.

backuppingBPId - the BLOB should be taken from the backup-dir using this BP-Id

Returns:

a File handle pointing to a file containing the data of the BLOB.

getBackupFileName

public java.lang.String getBackupFileName(java.lang.Long boid,
                                          java.lang.Long bpid)

getBackupFileNameTemp

public java.lang.String getBackupFileNameTemp(java.lang.Long boid,
                                              java.lang.Long bpid)

getHandleForRemoveBLOB

public ManagedFileI getHandleForRemoveBLOB(java.lang.String oldHash,
                                           java.lang.Long id)

Specified by:

getHandleForRemoveBLOB in interface FileVaultI

getHandleForRemoveBLOB

public ManagedFileI getHandleForRemoveBLOB(java.lang.String oldHash,
                                           java.lang.Long id,
                                           boolean noHistory)

Specified by:

getHandleForRemoveBLOB in interface ServerFileVaultI

getHandle

public ManagedFileI getHandle(java.io.InputStream is,
                              java.lang.Long id)
                       throws java.io.IOException

Returns a ManagedFileI for reading binary data from the given InputStream and storing it as BLOB of the BO with the passed Id

Specified by:

getHandle in interface FileVaultI

Throws:

java.io.IOException

getHandle

public ManagedFileI getHandle(java.io.InputStream is,
                              java.lang.Long id,
                              boolean noHistory)
                       throws java.io.IOException

Specified by:

getHandle in interface ServerFileVaultI

Throws:

java.io.IOException

getHandleForReceivingBLOBOnServerSide

public ManagedFileI getHandleForReceivingBLOBOnServerSide(java.io.ObjectInput in,
                                                          long len,
                                                          java.lang.String blobHash,
                                                          java.lang.Long id,
                                                          boolean syncMode,
                                                          boolean noHistory)
                                                   throws java.io.IOException

Specified by:

getHandleForReceivingBLOBOnServerSide in interface FileVaultI

Throws:

java.io.IOException

getHandleForUndoBLOBChangeOnServerSide

public ManagedFileI getHandleForUndoBLOBChangeOnServerSide(java.lang.String oldHash,
                                                           java.lang.String newHash,
                                                           java.lang.Long undoBPId,
                                                           java.lang.Long id,
                                                           boolean noHistory)

Specified by:

getHandleForUndoBLOBChangeOnServerSide in interface FileVaultI

getHandleForPullDuringSync

public ManagedFileI getHandleForPullDuringSync(BLOBLoaderI blobLoader,
                                               long len,
                                               java.lang.String blobHash,
                                               java.lang.Long boid,
                                               java.lang.Long backuppingBPId,
                                               boolean noHistory)
                                        throws java.io.IOException

Specified by:

getHandleForPullDuringSync in interface ServerFileVaultI

Throws:

java.io.IOException

getHandleForPushDuringSync

public ManagedFileI getHandleForPushDuringSync(java.lang.Long id,
                                               boolean deletion,
                                               java.lang.Long backuppingBPId,
                                               java.lang.String blobHash)

Specified by:

getHandleForPushDuringSync in interface ServerFileVaultI

storeRemoteBLOB

public VFile storeRemoteBLOB(BLOBInputI in,
                             java.lang.String newBLOBIdString,
                             VFile rvfile,
                             int current,
                             int totalBLOBs)
                      throws java.io.FileNotFoundException

Specified by:

storeRemoteBLOB in interface ServerFileVaultI

Throws:

java.io.FileNotFoundException

getExistingBLOBsVFileIterator

public java.util.Iterator<VFile> getExistingBLOBsVFileIterator(java.util.Set<java.lang.Long> pendingBLOBChangeBOIdsLocal)
                                                        throws java.io.IOException

Traverses the storageDir and creates a Map with the ids and the VFile (with metadata about the file). This method is called on the sending end of command CMD_COPYBLOBS to determine which BLOBs exist locally.

Specified by:

getExistingBLOBsVFileIterator in interface ServerFileVaultI

Returns:

a Map with the ids and the VFile (with metadata about the file) for all local BLOBs in the storageDir

Throws:

java.io.IOException

getExistingBLOBsIdIterator

public java.util.Iterator<java.lang.Long> getExistingBLOBsIdIterator(java.util.Set<java.lang.Long> pendingBLOBChangeBOIdsLocal)
                                                              throws java.io.IOException

Specified by:

getExistingBLOBsIdIterator in interface ServerFileVaultI

Throws:

java.io.IOException

getExistingBLOBsIdIterator

public java.util.Iterator<java.lang.Long> getExistingBLOBsIdIterator()
                                                              throws java.io.IOException

Specified by:

getExistingBLOBsIdIterator in interface IntegrityCheckingServerFileVaultI

Throws:

java.io.IOException

getBLOBBOIdsForIntitialBLOBCopy

public InitialBLOBTransferMetaDataContainer getBLOBBOIdsForIntitialBLOBCopy(java.util.Map idsAndVFilesOnSyncNode,
                                                                            java.util.List pendingBLOBChangeBOIdsOnSyncNode,
                                                                            java.util.List pendingBLOBChangeBOIdsOnAuthNode)
                                                                     throws java.io.IOException

Returns the Ids of all local BLOBs, unless they are older or have the same hash as listed in the passed Map This method is called on the receiving end of command CMD_COPYBLOBS to determine which BLOBs exist locally, that do not exist on the sender's end or have a different hash.

Specified by:

getBLOBBOIdsForIntitialBLOBCopy in interface ServerFileVaultI

Returns:

a Map containing info about all local BLOBs, which are not part of idsAndVFilesOnSyncNode or have a different hash than on the remote end.

Throws:

java.io.IOException