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

Class OLocalPaginatedStorage

java.lang.Object

com.orientechnologies.orient.core.storage.OStorageAbstract

com.orientechnologies.orient.core.storage.impl.local.OAbstractPaginatedStorage

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

All Implemented Interfaces:

OSharedContainer, OOrientShutdownListener, OOrientStartupListener, OBackgroundExceptionListener, OFreezableStorageComponent, OFullCheckpointRequestListener, OLowDiskSpaceListener, OPageIsBrokenListener, OIdentifiableStorage, OStorage, OBackupable

public class OLocalPaginatedStorage
extends OAbstractPaginatedStorage
implements OFreezableStorageComponent

Since:

28.03.13

Author:

Andrey Lomakin

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.storage.OStorage

OStorage.LOCKING_STRATEGY, OStorage.SIZE, OStorage.STATUS

Field Summary

Fields inherited from class com.orientechnologies.orient.core.storage.impl.local.OAbstractPaginatedStorage

atomicOperationsManager, readCache, sbTreeCollectionManager, writeAheadLog, writeCache

Fields inherited from class com.orientechnologies.orient.core.storage.OStorageAbstract

componentsFactory, configuration, mode, name, sharedContainer, stateLock, status, storageThreadGroup, url, version

Fields inherited from interface com.orientechnologies.orient.core.storage.OStorage

CLUSTER_DEFAULT_NAME

Constructor Summary

Constructors

Constructor and Description
OLocalPaginatedStorage(String name, String filePath, String mode, int id, OReadCache readCache, OClosableLinkedContainer<Long,OFileClassic> files)

Method Summary

Modifier and Type	Method and Description
protected void	addFileToDirectory(String name, InputStream stream, File directory)
List<String>	backup(OutputStream out, Map<String,Object> options, Callable<Object> callable, OCommandOutputListener iOutput, int compressionLevel, int bufferSize) Executes a backup of the database.
void	cancelIndexRebuild()
protected void	clearStorageDirty()
void	closeAndMove(OCallable<Void,String> mover)
protected OLogSequenceNumber	copyWALToIncrementalBackup(ZipOutputStream zipOutputStream, long startSegment)
void	create(Map<String,Object> iProperties)
protected OWriteAheadLog	createWalFromIBUFiles(File directory)
protected File	createWalTempDirectory()
boolean	exists()
static boolean	exists(String path)
String	getStoragePath()
String	getType() Returns the storage's type.
String	getURL()
OStorageVariableParser	getVariableParser()
protected void	initWalAndDiskCache()
protected boolean	isDirty()
boolean	isIndexRebuildScheduled()
protected boolean	isIndexRebuildScheduledInternal()
protected boolean	isWriteAllowedDuringIncrementalBackup()
protected void	makeStorageDirty()
protected String	normalizeName(String name)
protected void	postCloseSteps(boolean onDelete, boolean jvmError)
protected void	postDeleteSteps()
protected void	preCloseSteps()
protected void	preCreateSteps()
protected void	preOpenSteps()
void	restore(InputStream in, Map<String,Object> options, Callable<Object> callable, OCommandOutputListener iListener) Executes a restore of a database backup.
protected void	scheduleIndexRebuild()

Methods inherited from class com.orientechnologies.orient.core.storage.impl.local.OAbstractPaginatedStorage

acquireReadLock, acquireWriteLock, addCluster, addCluster, addIndexEngine, callIndexEngine, callInLock, ceilingPhysicalPositions, check, checkClustersConsistency, checkForRecordValidity, checkOpeness, cleanOutRecord, clearIndex, clearProperties, close, closeClusters, closeIndexes, command, commit, compactCluster, completeGatheringPerformanceStatisticForCurrentThread, count, count, count, count, createRecord, delete, deleteIndexEngine, deleteRecord, dropCluster, executeCommand, floorPhysicalPositions, freeze, getAtomicOperationsManager, getClusterById, getClusterByName, getClusterDataRange, getClusterIdByName, getClusterInstances, getClusterNames, getClusters, getConflictStrategy, getDefaultClusterId, getFullCheckpointCount, getId, getIndexCursor, getIndexDescCursor, getIndexEngine, getIndexFirstKey, getIndexKeyCursor, getIndexLastKey, getIndexSize, getIndexValue, getLSN, getMode, getPerformanceStatisticManager, getPhysicalClusterNameById, getReadCache, getRecordMetadata, getRecordScanned, getRecoverListener, getRidsGroupedByCluster, getSBtreeCollectionManager, getSize, getStorageTransaction, getWALInstance, getWriteCache, hasIndexRangeQuerySupport, hideRecord, higherPhysicalPositions, incrementalBackup, indexContainsKey, isClosed, isFrozen, isRemote, iterateIndexEntriesBetween, iterateIndexEntriesMajor, iterateIndexEntriesMinor, loadExternalIndexEngine, loadIndexEngine, logAndPrepareForRethrow, logAndPrepareForRethrow, logAndPrepareForRethrow, lowDiskSpace, lowerPhysicalPositions, makeFullCheckpoint, onException, onShutdown, onStartup, open, open, openClusters, openIndexes, pageIsBroken, postCreateSteps, putIndexValue, readRecord, readRecordIfVersionIsNotLatest, readRecords, recordsChangedAfterLSN, recordsChangedRecently, recyclePosition, registerRecoverListener, release, releaseReadLock, releaseWriteLock, reload, removeKeyFromIndex, removeProperty, renameCluster, requestCheckpoint, restoreAtomicUnit, restoreFrom, restoreFromIncrementalBackup, rollback, setCharset, setClusterSelection, setClusterStatus, setConflictStrategy, setDateFormat, setDateTimeFormat, setDefaultClusterId, setIndexMgrRecordId, setLocaleCountry, setLocaleLanguage, setMinimumClusters, setProperty, setRecordSerializer, setSchemaRecordId, setTimeZone, setValidation, startGatheringPerformanceStatisticForCurrentThread, synch, underDistributedStorage, unregisterRecoverListener, updateConfiguration, updateIndexEntry, updateRecord, validatedPutIndexValue

Methods inherited from class com.orientechnologies.orient.core.storage.OStorageAbstract

checkForClusterPermissions, close, countRecords, dropCluster, existsResource, getComponentsFactory, getConfiguration, getName, getResource, getStatus, getUnderlying, getVersion, isAssigningClusterIds, isDistributed, removeResource, shutdown, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orientechnologies.orient.core.storage.impl.local.OFreezableStorageComponent

freeze, isFrozen, release

Methods inherited from interface com.orientechnologies.orient.core.storage.OStorage

checkForClusterPermissions, close, countRecords, dropCluster, getComponentsFactory, getConfiguration, getName, getStatus, getUnderlying, getVersion, isAssigningClusterIds, isDistributed, shutdown

Methods inherited from interface com.orientechnologies.common.concur.resource.OSharedContainer

existsResource, getResource, removeResource

Constructor Detail

OLocalPaginatedStorage

public OLocalPaginatedStorage(String name,
                              String filePath,
                              String mode,
                              int id,
                              OReadCache readCache,
                              OClosableLinkedContainer<Long,OFileClassic> files)
                       throws IOException

Throws:

IOException

Method Detail

create

public void create(Map<String,Object> iProperties)

Specified by:

create in interface OStorage

Overrides:

create in class OAbstractPaginatedStorage

normalizeName

protected String normalizeName(String name)

Overrides:

normalizeName in class OStorageAbstract

exists

public boolean exists()

Specified by:

exists in interface OStorage

getURL

public String getURL()

Specified by:

getURL in interface OStorage

Overrides:

getURL in class OStorageAbstract

getStoragePath

public String getStoragePath()

getVariableParser

public OStorageVariableParser getVariableParser()

getType

public String getType()

Description copied from interface: OStorage

Returns the storage's type.

Specified by:

getType in interface OStorage

backup

public List<String> backup(OutputStream out,
                           Map<String,Object> options,
                           Callable<Object> callable,
                           OCommandOutputListener iOutput,
                           int compressionLevel,
                           int bufferSize)
                    throws IOException

Description copied from interface: OBackupable

Executes a backup of the database. During the backup the database will be frozen in read-only mode.

Specified by:

backup in interface OBackupable

Parameters:

out - OutputStream used to write the backup content. Use a FileOutputStream to make the backup persistent on disk

options - Backup options as Map object. Currently no options are supported, this is just ignored (null is accepted)

callable - Callback to execute when the database is locked

iOutput - Listener called for backup messages

compressionLevel - ZIP Compression level between 1 (the minimum) and 9 (maximum). The bigger is the compression, the smaller will be the final backup content, but will consume more CPU and time to execute

bufferSize - Buffer size in bytes, the bigger is the buffer, the more efficient will be the compression

Throws:

IOException

See Also:

ODatabaseExport

restore

public void restore(InputStream in,
                    Map<String,Object> options,
                    Callable<Object> callable,
                    OCommandOutputListener iListener)
             throws IOException

Description copied from interface: OBackupable

Executes a restore of a database backup. During the restore the database will be frozen in read-only mode.

Specified by:

restore in interface OBackupable

Parameters:

in - InputStream used to read the backup content. Use a FileInputStream to read a backup on a disk

options - Backup options as Map object

callable - Callback to execute when the database is locked

iListener - Listener called for backup messages

Throws:

IOException

See Also:

ODatabaseImport

copyWALToIncrementalBackup

protected OLogSequenceNumber copyWALToIncrementalBackup(ZipOutputStream zipOutputStream,
                                                        long startSegment)
                                                 throws IOException

Specified by:

copyWALToIncrementalBackup in class OAbstractPaginatedStorage

Throws:

IOException

createWalTempDirectory

protected File createWalTempDirectory()

Specified by:

createWalTempDirectory in class OAbstractPaginatedStorage

addFileToDirectory

protected void addFileToDirectory(String name,
                                  InputStream stream,
                                  File directory)
                           throws IOException

Specified by:

addFileToDirectory in class OAbstractPaginatedStorage

Throws:

IOException

createWalFromIBUFiles

protected OWriteAheadLog createWalFromIBUFiles(File directory)
                                        throws IOException

Specified by:

createWalFromIBUFiles in class OAbstractPaginatedStorage

Throws:

IOException

preOpenSteps

protected void preOpenSteps()
                     throws IOException

Overrides:

preOpenSteps in class OAbstractPaginatedStorage

Throws:

IOException

preCreateSteps

protected void preCreateSteps()
                       throws IOException

Overrides:

preCreateSteps in class OAbstractPaginatedStorage

Throws:

IOException

postCloseSteps

protected void postCloseSteps(boolean onDelete,
                              boolean jvmError)
                       throws IOException

Specified by:

postCloseSteps in class OAbstractPaginatedStorage

Throws:

IOException

preCloseSteps

protected void preCloseSteps()
                      throws IOException

Overrides:

preCloseSteps in class OAbstractPaginatedStorage

Throws:

IOException

postDeleteSteps

protected void postDeleteSteps()

Overrides:

postDeleteSteps in class OAbstractPaginatedStorage

makeStorageDirty

protected void makeStorageDirty()
                         throws IOException

Overrides:

makeStorageDirty in class OAbstractPaginatedStorage

Throws:

IOException

clearStorageDirty

protected void clearStorageDirty()
                          throws IOException

Overrides:

clearStorageDirty in class OAbstractPaginatedStorage

Throws:

IOException

isDirty

protected boolean isDirty()
                   throws IOException

Overrides:

isDirty in class OAbstractPaginatedStorage

Throws:

IOException

isIndexRebuildScheduled

public boolean isIndexRebuildScheduled()

Overrides:

isIndexRebuildScheduled in class OAbstractPaginatedStorage

isIndexRebuildScheduledInternal

protected boolean isIndexRebuildScheduledInternal()

Overrides:

isIndexRebuildScheduledInternal in class OAbstractPaginatedStorage

scheduleIndexRebuild

protected void scheduleIndexRebuild()
                             throws IOException

Overrides:

scheduleIndexRebuild in class OAbstractPaginatedStorage

Throws:

IOException

cancelIndexRebuild

public void cancelIndexRebuild()
                        throws IOException

Overrides:

cancelIndexRebuild in class OAbstractPaginatedStorage

Throws:

IOException

isWriteAllowedDuringIncrementalBackup

protected boolean isWriteAllowedDuringIncrementalBackup()

Specified by:

isWriteAllowedDuringIncrementalBackup in class OAbstractPaginatedStorage

initWalAndDiskCache

protected void initWalAndDiskCache()
                            throws IOException

Specified by:

initWalAndDiskCache in class OAbstractPaginatedStorage

Throws:

IOException

exists

public static boolean exists(String path)

closeAndMove

public void closeAndMove(OCallable<Void,String> mover)