com.orientechnologies.orient.core.storage.impl.local.paginated.base

Class ODurableComponent

java.lang.Object

com.orientechnologies.common.concur.resource.OSharedResourceAdaptive

com.orientechnologies.orient.core.storage.impl.local.paginated.base.ODurableComponent

Direct Known Subclasses:

OClusterPositionMap, OHashTableDirectory, OLocalHashTable, OLocalHashTable20, OPaginatedCluster, OSBTree, OSBTreeBonsaiLocal

public abstract class ODurableComponent
extends OSharedResourceAdaptive

Base class for all durable data structures, that is data structures state of which can be consistently restored after system crash but results of last operations in small interval before crash may be lost. This class contains methods which are used to support such concepts as:

1. "atomic operation" - set of operations which should be either applied together or not. It includes not only changes on current data structure but on all durable data structures which are used by current one during implementation of specific operation.
2. write ahead log - log of all changes which were done with page content after loading it from cache.

To support of "atomic operation" concept following should be done:

1. Call startAtomicOperation(boolean) method.
2. Call endAtomicOperation(boolean, Exception) method when atomic operation completes, passed in parameter should be false if atomic operation completes with success and true if there were some exceptions and it is needed to rollback given operation.

Since:

8/27/13

Author:

Andrey Lomakin

Field Summary

Fields

Modifier and Type	Field and Description
protected OAtomicOperationsManager	atomicOperationsManager
protected String	extension
protected OPerformanceStatisticManager	performanceStatisticManager
protected OReadCache	readCache
protected OAbstractPaginatedStorage	storage
protected OWriteCache	writeCache

Constructor Summary

Constructors

Constructor and Description
ODurableComponent(OAbstractPaginatedStorage storage, String name, String extension, String lockName)

Method Summary

Modifier and Type	Method and Description
protected void	acquireExclusiveLock()
protected long	addFile(OAtomicOperation atomicOperation, String fileName)
protected OCacheEntry	addPage(OAtomicOperation atomicOperation, long fileId)
protected void	completeOperation()
protected void	deleteFile(OAtomicOperation atomicOperation, long fileId)
protected void	endAtomicOperation(boolean rollback, Exception e)
protected OWALChanges	getChanges(OAtomicOperation atomicOperation, OCacheEntry entry)
String	getExtension()
protected long	getFilledUpTo(OAtomicOperation atomicOperation, long fileId)
String	getFullName()
String	getLockName()
String	getName()
protected boolean	isFileExists(OAtomicOperation atomicOperation, long fileId)
protected boolean	isFileExists(OAtomicOperation atomicOperation, String fileName)
protected OCacheEntry	loadPage(OAtomicOperation atomicOperation, long fileId, long pageIndex, boolean checkPinnedPages)
protected OCacheEntry	loadPage(OAtomicOperation atomicOperation, long fileId, long pageIndex, boolean checkPinnedPages, int pageCount)
protected long	openFile(OAtomicOperation atomicOperation, String fileName)
protected void	pinPage(OAtomicOperation atomicOperation, OCacheEntry cacheEntry)
protected void	releasePage(OAtomicOperation atomicOperation, OCacheEntry cacheEntry)
void	setName(String name)
protected OAtomicOperation	startAtomicOperation(boolean trackNonTxOperations)
protected void	startOperation()
protected void	truncateFile(OAtomicOperation atomicOperation, long filedId)

Methods inherited from class com.orientechnologies.common.concur.resource.OSharedResourceAdaptive

acquireSharedLock, addUser, assertExclusiveLockHold, assertSharedLockHold, getUsers, isConcurrent, releaseExclusiveLock, releaseSharedLock, removeUser, tryAcquireExclusiveLock, tryAcquireSharedLock

Methods inherited from class java.lang.Object

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

Field Detail

atomicOperationsManager

protected final OAtomicOperationsManager atomicOperationsManager

storage

protected final OAbstractPaginatedStorage storage

readCache

protected final OReadCache readCache

writeCache

protected final OWriteCache writeCache

performanceStatisticManager

protected final OPerformanceStatisticManager performanceStatisticManager

extension

protected final String extension

Constructor Detail

ODurableComponent

public ODurableComponent(OAbstractPaginatedStorage storage,
                         String name,
                         String extension,
                         String lockName)

Method Detail

getLockName

public String getLockName()

getName

public String getName()

setName

public void setName(String name)

getFullName

public String getFullName()

getExtension

public String getExtension()

acquireExclusiveLock

protected void acquireExclusiveLock()

Overrides:

acquireExclusiveLock in class OSharedResourceAdaptive

endAtomicOperation

protected void endAtomicOperation(boolean rollback,
                                  Exception e)
                           throws IOException

Throws:

IOException

startAtomicOperation

protected OAtomicOperation startAtomicOperation(boolean trackNonTxOperations)
                                         throws IOException

Throws:

IOException

See Also:

OAtomicOperationsManager.startAtomicOperation(com.orientechnologies.orient.core.storage.impl.local.paginated.base.ODurableComponent, boolean)

getChanges

protected OWALChanges getChanges(OAtomicOperation atomicOperation,
                                 OCacheEntry entry)

getFilledUpTo

protected long getFilledUpTo(OAtomicOperation atomicOperation,
                             long fileId)
                      throws IOException

Throws:

IOException

loadPage

protected OCacheEntry loadPage(OAtomicOperation atomicOperation,
                               long fileId,
                               long pageIndex,
                               boolean checkPinnedPages)
                        throws IOException

Throws:

IOException

loadPage

protected OCacheEntry loadPage(OAtomicOperation atomicOperation,
                               long fileId,
                               long pageIndex,
                               boolean checkPinnedPages,
                               int pageCount)
                        throws IOException

Throws:

IOException

pinPage

protected void pinPage(OAtomicOperation atomicOperation,
                       OCacheEntry cacheEntry)
                throws IOException

Throws:

IOException

addPage

protected OCacheEntry addPage(OAtomicOperation atomicOperation,
                              long fileId)
                       throws IOException

Throws:

IOException

releasePage

protected void releasePage(OAtomicOperation atomicOperation,
                           OCacheEntry cacheEntry)

addFile

protected long addFile(OAtomicOperation atomicOperation,
                       String fileName)
                throws IOException

Throws:

IOException

openFile

protected long openFile(OAtomicOperation atomicOperation,
                        String fileName)
                 throws IOException

Throws:

IOException

deleteFile

protected void deleteFile(OAtomicOperation atomicOperation,
                          long fileId)
                   throws IOException

Throws:

IOException

isFileExists

protected boolean isFileExists(OAtomicOperation atomicOperation,
                               String fileName)

isFileExists

protected boolean isFileExists(OAtomicOperation atomicOperation,
                               long fileId)

truncateFile

protected void truncateFile(OAtomicOperation atomicOperation,
                            long filedId)
                     throws IOException

Throws:

IOException

startOperation

protected void startOperation()

completeOperation

protected void completeOperation()