|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.derby.impl.store.raw.data.BaseContainer
org.apache.derby.impl.store.raw.data.FileContainer
org.apache.derby.impl.store.raw.data.RAFContainer
class RAFContainer
RAFContainer (short for RandomAccessFileContainer) is a concrete subclass of FileContainer for FileContainers which are implemented on java.io.RandomAccessFile.
Field Summary | |
---|---|
private java.lang.String |
actionBackupLocation
|
private int |
actionCode
|
private BaseContainerHandle |
actionContainerHandle
|
private boolean |
actionErrorOK
|
private StorageFile |
actionFile
|
private ContainerKey |
actionIdentity
|
private LogInstant |
actionInstant
|
private boolean |
actionStub
|
private boolean |
actionTryAlternatePath
|
private static int |
BACKUP_CONTAINER_ACTION
|
private static int |
CREATE_CONTAINER_ACTION
|
protected StorageRandomAccessFile |
fileData
|
private static int |
GET_FILE_NAME_ACTION
|
private static int |
GET_RANDOM_ACCESS_FILE_ACTION
|
private boolean |
inBackup
|
private boolean |
inRemove
|
protected boolean |
needsSync
|
private static int |
OPEN_CONTAINER_ACTION
|
private static int |
REMOVE_FILE_ACTION
|
private static int |
STUBBIFY_ACTION
|
Fields inherited from class org.apache.derby.impl.store.raw.data.FileContainer |
---|
allocCache, canUpdate, CHECKSUM_SIZE, CONTAINER_INFO_SIZE, containerCache, containerInfo, containerVersion, dataFactory, estimatedRowCount, FIRST_ALLOC_PAGE_NUMBER, FIRST_ALLOC_PAGE_OFFSET, firstAllocPageNumber, firstAllocPageOffset, formatIdInteger, initialPages, isDirty, lastLogInstant, minimumRecordSize, pageCache, pageSize, preDirty, SPACE_TRACE, spareSpace |
Fields inherited from class org.apache.derby.impl.store.raw.data.BaseContainer |
---|
identity, isCommittedDrop, isDropped, isReusableRecordId |
Constructor Summary | |
---|---|
RAFContainer(BaseDataFileFactory factory)
|
Method Summary | |
---|---|
protected void |
backupContainer(BaseContainerHandle handle,
java.lang.String backupLocation)
Backup the container. |
void |
clean(boolean forRemove)
Clean the container. |
private void |
clearDirty()
|
(package private) void |
closeContainer()
|
(package private) void |
createContainer(ContainerKey newIdentity)
Create a new container. |
Cacheable |
createIdentity(java.lang.Object key,
java.lang.Object createParameter)
Create a new item. |
protected void |
encryptContainer(BaseContainerHandle handle,
java.lang.String newFilePath)
Create encrypted version of the container with the user specified encryption properties. |
protected void |
flushAll()
flush the cache to ensure all of my pages are written to disk |
(package private) StorageFile |
getFileName(ContainerKey identity,
boolean stub,
boolean errorOK,
boolean tryAlternatePath)
|
boolean |
isDirty()
We treat this container as dirty if it has the container file open. |
(package private) boolean |
openContainer(ContainerKey newIdentity)
Open a container. |
private boolean |
padFile(StorageRandomAccessFile file,
long pageOffset)
Pad the file upto the passed in page offset. |
protected int |
preAllocate(long lastPreallocPagenum,
int preAllocSize)
Preallocate some pages if need be |
private void |
privBackupContainer(BaseContainerHandle handle,
java.lang.String backupLocation)
Backup the container. |
protected StorageFile |
privGetFileName(ContainerKey identity,
boolean stub,
boolean errorOK,
boolean tryAlternatePath)
|
(package private) StorageRandomAccessFile |
privGetRandomAccessFile(StorageFile file)
|
private boolean |
privRemoveFile(StorageFile file)
|
protected void |
readPage(long pageNumber,
byte[] pageData)
Read a page into the supplied array. |
protected void |
removeContainer(LogInstant instant,
boolean leaveStub)
Remove the container |
(package private) boolean |
removeFile(StorageFile file)
|
java.lang.Object |
run()
|
Cacheable |
setIdentity(java.lang.Object key)
Set container's identity |
private void |
stubbify(LogInstant instant)
|
protected void |
truncatePages(long lastValidPagenum)
Truncate pages of a container. |
protected byte[] |
updatePageArray(long pageNumber,
byte[] pageData,
byte[] encryptionBuf,
boolean encryptWithNewEngine)
Update the page array with container header if the page is a first alloc page and encrypt the page data if the database is encrypted. |
protected void |
writePage(long pageNumber,
byte[] pageData,
boolean syncPage)
Write a page from the supplied array. |
private void |
writeRAFHeader(StorageRandomAccessFile file,
boolean create,
boolean syncFile)
Write the header of a random access file and sync it |
Methods inherited from class org.apache.derby.impl.store.raw.data.BaseContainer |
---|
addPage, compressContainer, fillInIdentity, getAllocPage, getAnyPage, getCommittedDropState, getContainerId, getContainerStatus, getDeallocLock, getDroppedState, getFirstPage, getIdentity, getNextPage, getSegmentId, isReusableRecordId, lockAttributes, lockerAlwaysCompatible, lockEvent, removePage, requestCompatible, setCommittedDropState, setDroppedState, setReusableRecordIdState, truncate, unlockEvent, use |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.derby.iapi.services.cache.Cacheable |
---|
getIdentity |
Field Detail |
---|
protected StorageRandomAccessFile fileData
protected boolean needsSync
private int actionCode
private static final int GET_FILE_NAME_ACTION
private static final int CREATE_CONTAINER_ACTION
private static final int REMOVE_FILE_ACTION
private static final int OPEN_CONTAINER_ACTION
private static final int STUBBIFY_ACTION
private static final int BACKUP_CONTAINER_ACTION
private static final int GET_RANDOM_ACCESS_FILE_ACTION
private ContainerKey actionIdentity
private boolean actionStub
private boolean actionErrorOK
private boolean actionTryAlternatePath
private StorageFile actionFile
private LogInstant actionInstant
private java.lang.String actionBackupLocation
private BaseContainerHandle actionContainerHandle
private boolean inBackup
private boolean inRemove
Constructor Detail |
---|
RAFContainer(BaseDataFileFactory factory)
Method Detail |
---|
public boolean isDirty()
FileContainer
isDirty
in interface Cacheable
isDirty
in class FileContainer
Cacheable.isDirty()
public Cacheable setIdentity(java.lang.Object key) throws StandardException
setIdentity
in interface Cacheable
setIdentity
in class FileContainer
StandardException
- Standard Derby error policyCacheable.setIdentity(java.lang.Object)
public Cacheable createIdentity(java.lang.Object key, java.lang.Object createParameter) throws StandardException
Cacheable
Create a new item and set the identity of the object to represent it.
The object will be in the No Identity state,
ie. it will have just been created or clearIdentity() was just called.
The object must copy the information out of key, not just store a reference to key
if the key is not immutable.
After this call the expression getIdentity().equals(key) must return true.
If the class of the object needs to change (e.g. to support a different format)
then the object should create a new object, call its initParameter() with the parameters
the original object was called with, set its identity and return a reference to it. The cache
manager will discard the reference to the old object.
If an exception is thrown the object must be left in the no-identity state.
MT - single thread required - Method must only be called be cache manager
and the cache manager will guarantee only one thread can be calling it.
createIdentity
in interface Cacheable
createIdentity
in class FileContainer
StandardException
- Standard Derby error policyCacheManager.create(java.lang.Object, java.lang.Object)
protected void removeContainer(LogInstant instant, boolean leaveStub) throws StandardException
removeContainer
in class BaseContainer
leaveStub
- if true, leave a stub. If false, remove everything
StandardException
- Standard Derby error policyRawContainerHandle.removeContainer(org.apache.derby.iapi.store.raw.log.LogInstant)
void closeContainer()
closeContainer
in class FileContainer
protected void readPage(long pageNumber, byte[] pageData) throws java.io.IOException, StandardException
readPage
in class FileContainer
java.io.IOException
- exception reading page
StandardException
- Standard Derby error policyprotected void writePage(long pageNumber, byte[] pageData, boolean syncPage) throws java.io.IOException, StandardException
writePage
in class FileContainer
StandardException
- Standard Derby error policy
java.io.IOException
- IO error accessing pageprotected byte[] updatePageArray(long pageNumber, byte[] pageData, byte[] encryptionBuf, boolean encryptWithNewEngine) throws StandardException, java.io.IOException
pageNumber
- the page number of the pagepageData
- byte array that has the actual page data.encryptionBuf
- buffer that is used to store encryted version of the
page.
StandardException
java.io.IOException
private boolean padFile(StorageRandomAccessFile file, long pageOffset) throws java.io.IOException, StandardException
java.io.IOException
StandardException
public void clean(boolean forRemove) throws StandardException
Write out the container header and sync all dirty pages of this container to disk before returning.
checkpoint calls this interface through callbacks by telling the cache manager to clean all containers in the open container cache. This sync of the file happens as part of writing and then syncing the container header in writeRAFHeader().
clean
in interface Cacheable
forRemove
- Is clean called because container is being removed?
StandardException
- Standard exception policy.private void clearDirty()
protected int preAllocate(long lastPreallocPagenum, int preAllocSize)
preAllocate
in class FileContainer
lastPreallocPagenum
- the last preallocated page number as known
by the allocation pagepreAllocSize
- try to preallocate this page number of pages.
Since only the container knows how many pages are actually on
disk, it may determine that certain number of pages that the
allocation page thinks need to be preallocated is already
allocated, in those case, act as if the preallocation is
successful.
protected void truncatePages(long lastValidPagenum) throws StandardException
Truncate all pages from lastValidPagenum+1 through the end of the file.
truncatePages
in class BaseContainer
lastValidPagenum
- The page number of the last valid page of the
file. All pages after this one are truncated.
StandardException
- Standard exception policy.private void writeRAFHeader(StorageRandomAccessFile file, boolean create, boolean syncFile) throws java.io.IOException, StandardException
create
- if true, the container is being created
if false, the container already existsyncFile
- if true, sync the file
java.io.IOException
StandardException
protected void flushAll() throws StandardException
flushAll
in class BaseContainer
StandardException
- Standard Derby error policyStorageFile getFileName(ContainerKey identity, boolean stub, boolean errorOK, boolean tryAlternatePath) throws StandardException
StandardException
protected StorageFile privGetFileName(ContainerKey identity, boolean stub, boolean errorOK, boolean tryAlternatePath) throws StandardException
StandardException
void createContainer(ContainerKey newIdentity) throws StandardException
FileContainer
Create a new container, all references to identity must be through the passed in identity, this object will no identity until after this method returns.
createContainer
in class FileContainer
StandardException
- Derby Standard error policyboolean removeFile(StorageFile file) throws java.lang.SecurityException, StandardException
java.lang.SecurityException
StandardException
private boolean privRemoveFile(StorageFile file) throws StandardException
StandardException
boolean openContainer(ContainerKey newIdentity) throws StandardException
FileContainer
Longer descrption of routine.
Open a container. Open the file that maps to this container, if the
file does not exist then we assume the container was never created.
If the file exists but we have trouble opening it then we throw some
exception.
MT - single thread required - Enforced by cache manager.
openContainer
in class FileContainer
StandardException
- Standard exception policy.private void stubbify(LogInstant instant) throws StandardException
StandardException
protected void backupContainer(BaseContainerHandle handle, java.lang.String backupLocation) throws StandardException
backupContainer
in class FileContainer
handle
- the container handle.backupLocation
- location of the backup container.
StandardException
- Standard Derby error policyprivate void privBackupContainer(BaseContainerHandle handle, java.lang.String backupLocation) throws StandardException
handle
- the container handle.backupLocation
- location of the backup container.
StandardException
- Derby Standard error policyprotected void encryptContainer(BaseContainerHandle handle, java.lang.String newFilePath) throws StandardException
encryptContainer
in class BaseContainer
handle
- the container handle.newFilePath
- file to store the new encrypted version of
the container
StandardException
- Derby Standard error policyStorageRandomAccessFile privGetRandomAccessFile(StorageFile file) throws java.lang.SecurityException, StandardException
java.lang.SecurityException
StandardException
public java.lang.Object run() throws StandardException, java.io.IOException
run
in interface java.security.PrivilegedExceptionAction
StandardException
java.io.IOException
|
Built on Thu 2010-12-23 20:49:13+0000, from revision ??? | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |