org.apache.derby.impl.store.raw.data
Class EncryptData

java.lang.Object
  org.apache.derby.impl.store.raw.data.EncryptData

All Implemented Interfaces:

java.security.PrivilegedAction

public class EncryptData
extends java.lang.Object
implements java.security.PrivilegedAction

This class is used to encrypt all the containers in the data segment with a new encryption key when password/key is changed or when an existing database is reconfigured for encryption. Encryption of existing data in the data segments is done by doing the following: Find all the containers in data segment (seg0) and encrypt all of them with the new encryption key, the process for each container is: 1.Write a log record to indicate that the container is getting encrypted. 2.Read all the pages of the container through the page cache and encrypt each page with new encryption key and then write to a temporary file(n.dat) in the data segment itself. 3. Rename the current container file (c.dat) to another file (o.dat) 4. Rename the new encrypted version of the file (n.dat). 5. All the old version of the container (o.dat) files are removed after a successful checkpoint with a new key or on a rollback.

Field Summary

private int	actionCode
private StorageFile	actionDestStorageFile
private StorageFile	actionStorageFile
private BaseDataFileFactory	dataFactory
private int	noOldFiles
private StorageFile[]	oldFiles
private static int	STORAGE_FILE_DELETE_ACTION
private static int	STORAGE_FILE_EXISTS_ACTION
private static int	STORAGE_FILE_RENAME_ACTION
private StorageFactory	storageFactory

Constructor Summary

EncryptData(BaseDataFileFactory dataFactory)

Method Summary

void	encryptAllContainers(RawTransaction t)
private StorageFile	encryptContainer(RawTransaction t, ContainerKey ckey) Encrypt a container.
private StorageFile	getFile(ContainerKey containerId, boolean old) Get file handle to a container file that is used to keep temporary versions of the container file.
private StorageFile	getFile(java.lang.String ctrFileName)
private java.lang.String	getFilePath(ContainerKey containerId, boolean old) Get path to a container file that is used to keep temporary versions of the container file.
private boolean	isOldContainerFile(java.lang.String fileName)
private boolean	privDelete(StorageFile file)
private boolean	privExists(StorageFile file)
private boolean	privRename(StorageFile fromFile, StorageFile destFile)
void	removeOldVersionOfContainers(boolean inRecovery)
(package private) void	restoreContainer(ContainerKey containerId)
java.lang.Object	run()

Methods inherited from class java.lang.Object

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

Field Detail

dataFactory

private BaseDataFileFactory dataFactory

storageFactory

private StorageFactory storageFactory

oldFiles

private StorageFile[] oldFiles

noOldFiles

private int noOldFiles

STORAGE_FILE_EXISTS_ACTION

private static final int STORAGE_FILE_EXISTS_ACTION

See Also:

Constant Field Values

STORAGE_FILE_DELETE_ACTION

private static final int STORAGE_FILE_DELETE_ACTION

See Also:

Constant Field Values

STORAGE_FILE_RENAME_ACTION

private static final int STORAGE_FILE_RENAME_ACTION

See Also:

Constant Field Values

actionCode

private int actionCode

actionStorageFile

private StorageFile actionStorageFile

actionDestStorageFile

private StorageFile actionDestStorageFile

Constructor Detail

EncryptData

public EncryptData(BaseDataFileFactory dataFactory)

Method Detail

encryptAllContainers

public void encryptAllContainers(RawTransaction t)
                          throws StandardException

Throws:

StandardException

encryptContainer

private StorageFile encryptContainer(RawTransaction t,
                                     ContainerKey ckey)
                              throws StandardException

Encrypt a container.

Parameters:

t - the transaction that is used to configure the database with new encryption properties.

ckey - the key of the container that is being encrypted.

Returns:

file handle to the old copy of the container.

Throws:

StandardException - Standard Derby error policy

getFile

private StorageFile getFile(ContainerKey containerId,
                            boolean old)

Get file handle to a container file that is used to keep temporary versions of the container file.

getFilePath

private java.lang.String getFilePath(ContainerKey containerId,
                                     boolean old)

Get path to a container file that is used to keep temporary versions of the container file.

isOldContainerFile

private boolean isOldContainerFile(java.lang.String fileName)

getFile

private StorageFile getFile(java.lang.String ctrFileName)

restoreContainer

void restoreContainer(ContainerKey containerId)
                throws StandardException

Throws:

StandardException

removeOldVersionOfContainers

public void removeOldVersionOfContainers(boolean inRecovery)
                                  throws StandardException

Throws:

StandardException

privExists

private boolean privExists(StorageFile file)

privDelete

private boolean privDelete(StorageFile file)

privRename

private boolean privRename(StorageFile fromFile,
                           StorageFile destFile)

run

public java.lang.Object run()

Specified by:

run in interface java.security.PrivilegedAction