org.apache.jackrabbit.oak.segment.spi.persistence.persistentcache

Class CachingPersistence

java.lang.Object

org.apache.jackrabbit.oak.segment.spi.persistence.persistentcache.CachingPersistence

All Implemented Interfaces:

SegmentNodeStorePersistence

public class CachingPersistence
extends java.lang.Object
implements SegmentNodeStorePersistence

Constructor Summary

Constructors

Constructor and Description
CachingPersistence(PersistentCache persistentCache, SegmentNodeStorePersistence delegate)

Method Summary

Modifier and Type	Method and Description
SegmentArchiveManager	createArchiveManager(boolean memoryMapping, boolean offHeapAccess, IOMonitor ioMonitor, FileStoreMonitor fileStoreMonitor, RemoteStoreMonitor remoteStoreMonitor) Opens a new archive manager.
GCJournalFile	getGCJournalFile() Create the GCJournalFile.
JournalFile	getJournalFile() Create the JournalFile.
ManifestFile	getManifestFile() Create the ManifestFile.
RepositoryLock	lockRepository() Acquire the lock on the repository.
boolean	segmentFilesExist() Check if the segment store already contains any segments

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingPersistence

public CachingPersistence(PersistentCache persistentCache,
                          SegmentNodeStorePersistence delegate)

Method Detail

createArchiveManager

public SegmentArchiveManager createArchiveManager(boolean memoryMapping,
                                                  boolean offHeapAccess,
                                                  IOMonitor ioMonitor,
                                                  FileStoreMonitor fileStoreMonitor,
                                                  RemoteStoreMonitor remoteStoreMonitor)
                                           throws java.io.IOException

Description copied from interface: SegmentNodeStorePersistence

Opens a new archive manager. It'll be used to access the archives containing segments.

Specified by:

createArchiveManager in interface SegmentNodeStorePersistence

Parameters:

memoryMapping - whether the memory mapping should be used (if the given persistence supports it)

offHeapAccess - whether off heap access for segments should be used

ioMonitor - object used to monitor segment-related IO access. The implementation should call the appropriate methods when accessing segments.

fileStoreMonitor - object used to monitor the general IO usage.

Returns:

segment archive manager

Throws:

java.io.IOException

segmentFilesExist

public boolean segmentFilesExist()

Description copied from interface: SegmentNodeStorePersistence

Check if the segment store already contains any segments

Specified by:

segmentFilesExist in interface SegmentNodeStorePersistence

Returns:

true is some segments are available for reading

getJournalFile

public JournalFile getJournalFile()

Description copied from interface: SegmentNodeStorePersistence

Create the JournalFile.

Specified by:

getJournalFile in interface SegmentNodeStorePersistence

Returns:

object representing the segment journal file

getGCJournalFile

public GCJournalFile getGCJournalFile()
                               throws java.io.IOException

Description copied from interface: SegmentNodeStorePersistence

Create the GCJournalFile.

Specified by:

getGCJournalFile in interface SegmentNodeStorePersistence

Returns:

object representing the GC journal file

Throws:

java.io.IOException

getManifestFile

public ManifestFile getManifestFile()
                             throws java.io.IOException

Description copied from interface: SegmentNodeStorePersistence

Create the ManifestFile.

Specified by:

getManifestFile in interface SegmentNodeStorePersistence

Returns:

object representing the manifest file

Throws:

java.io.IOException

lockRepository

public RepositoryLock lockRepository()
                              throws java.io.IOException

Description copied from interface: SegmentNodeStorePersistence

Acquire the lock on the repository. During the lock lifetime it shouldn't be possible to acquire it again, either by a local or by a remote process.

The lock can be released manually by calling RepositoryLock.unlock(). If the segment node store is shut down uncleanly (eg. the process crashes), it should be released automatically, so no extra maintenance tasks are required to run the process again.

Specified by:

lockRepository in interface SegmentNodeStorePersistence

Returns:

the acquired repository lock

Throws:

java.io.IOException