Package org.apache.jackrabbit.oak.plugins.document

Interface Summary

Interface	Description
ClusterStateChangeListener	DocumentNS-internal listener that gets invoked when a change in the clusterNodes collection (active/inactive/timed out/recovering) is detected.
CommitValueResolver	Resolves the commit value for a given change revision on a document.
Consistency.Result	Callback interface for result of a consistency check.
DocumentNodeStateCache
DocumentNodeStoreMBean
DocumentNodeStoreStatsCollector
DocumentStore	The interface for the backend storage for documents.
DocumentStoreStatsCollector
DocumentStoreStatsMBean
FullGCMetricsExporter	Exporter interface for setting dependency for VersionGarbageCollector that allows for export of fullGC metrics to Prometheus via pushgateway.
FullGcNodeBin	This class is as a wrapper around DocumentStore that expose two methods used to clean garbage from NODES collection public int remove(Map orphanOrDeletedRemovalMap) public List findAndUpdate(List updateOpList) When enabled Each method saves the document ID or empty properties names (that will be deleted) to a separate _bin collection as a BinDocument then delegates deletion to DocumentStore When disabled (default) Each method delegates directly to DocumentStore
FullGCStatsCollector	Collector interface for DocumentNodeStore full garbage collection statistics.
LastRevTracker	An implementation of this interface receives callbacks about paths that need an update of the _lastRev field on documents.
NodeStateDiffer
RevisionContext	Provides revision related context.
RevisionGCStatsCollector	Collector interface for DocumentNodeStore revision garbage collection statistics.
RevisionGCStatsMBean	MBean exposing DocumentNodeStore revision garbage collection statistics.
Throttler	Interface to implement throttling for document store.
ThrottlingStatsCollector	Stats Collector for throttling operation.

Class Summary

Class	Description
AbstractDocumentNodeState
BlobCollector
BlobReferenceIterator	An iterator over all referenced binaries.
CheckpointsHelper	Helper class to access package private functionality.
ClusterNodeInfo	Information about a cluster node.
ClusterNodeInfoDocument	A document storing cluster node info.
Collection<T extends Document>	The collection types.
Commit	A higher level object representing a commit.
CompressedDocumentPropertyState	PropertyState compression implementation with lazy parsing of the JSOP encoded value.
Consistency	Consistency check on a NodeDocument.
CreateGarbageHelper	Helper class to generate garbage for testing purposes.
Document	A document corresponds to a node stored in the DocumentNodeStore.
DocumentBlobReferenceRetriever	Implementation of BlobReferenceRetriever for the DocumentNodeStore.
DocumentBroadcastConfig
DocumentCheckpointMBean	CheckpointMBean implementation for the DocumentNodeStore.
DocumentDiscoveryLiteService	The DocumentDiscoveryLiteService is taking care of providing a repository descriptor that contains the current cluster-view details.
DocumentNodeState	A NodeState implementation for the DocumentNodeStore.
DocumentNodeState.BundlingContext
DocumentNodeState.Children	A list of children for a node.
DocumentNodeStore	Implementation of a NodeStore on DocumentStore.
DocumentNodeStoreBuilder<T extends DocumentNodeStoreBuilder<T>>	A generic builder for a DocumentNodeStore.
DocumentNodeStoreHelper	Helper class to access package private method of DocumentNodeStore and other classes in this package.
DocumentNodeStoreService	The OSGi service to start/stop a DocumentNodeStore instance.
DocumentNodeStoreService.Preset
DocumentNodeStoreStats
DocumentPropertyStateFactory
DocumentStoreStats	Document Store statistics helper class.
DocumentStoreStatsPrinter	Inventory printer for DocumentStore.getStats().
FormatVersion	The format version currently in use by the DocumentNodeStore and written to the underlying DocumentStore.
JournalEntry	Keeps track of changes performed between two consecutive background updates.
JournalGarbageCollector	The JournalGarbageCollector can clean up JournalEntries that are older than a particular age.
JournalPropertyHandlerFactory
LastRevRecoveryAgent	Utility class for recovering potential missing _lastRev updates of nodes due to crash of a node.
LocalDiffCache	A diff cache, which is pro-actively filled after a commit.
LocalDiffCache.Diff
MemoryDiffCache	An in-memory diff cache implementation.
MemoryDiffCache.Key
MissingLastRevSeeker	Utilities to retrieve _lastRev missing update candidates.
NamePathRev	A cache key implementation, which is a combination of a name, path and a revision vector.
NodeDocument	A document storing data about a node.
NodeDocumentHelper	Helper class to access package private methods on NodeDocument.
NodeDocumentIdComparator	Implements a comparator, which sorts NodeDocumentId string according to 1) their depth (highest first) and 2) the id string itself.
NodeDocumentRevisionCleaner	This is a prototype class of a very fine-grained revision cleaner that cleans even revisions in-between checkpoints.
Path	The Path class is closely modeled after the semantics of PathUtils in oak-commons.
PathComparator	Implements a comparator, which sorts paths according to 1) their depth (highest first) and 2) the paths natural ordering.
PathRev	A cache key implementation, which is a combination of a path and a revision vector.
Revision	A revision.
RevisionContextWrapper	Wraps an existing revision context and exposes a custom clusterId.
RevisionVector	A vector of revisions.
SplitDocumentCleanUp	Implements a split document cleanup.
StableRevisionComparator	StableRevisionComparator implements a revision comparator, which is only based on stable information available in the two revisions presented to this comparator.
StringCache	TODO document
Sweep2Helper	Helper methods for sweep2 functionality introduced with OAK-9176.
Sweep2StatusDocument	Represents the sweep2 status as recorded in the settings collection.
SweepHelper	Helper class to perform a revision sweep for a given clusterId.
ThrottlingStatsCollectorImpl	Throttling statistics helper class.
UpdateOp	A DocumentStore "update" operation for one document.
UpdateOp.Condition	A condition to check before an update is applied.
UpdateOp.Key	A key for an operation consists of a property name and an optional revision.
UpdateOp.Operation	A DocumentStore operation for a given key within a document.
UpdateUtils	Provides convenience methods for applying UpdateOps to Documents.
VersionGarbageCollector
VersionGarbageCollector.VersionGCInfo
VersionGarbageCollector.VersionGCStats
VersionGCOptions
VersionGCRecommendations	Gives a recommendation about parameters for the next revision garbage collection run.
VersionGCSupport

Enum Summary

Enum	Description
ClusterNodeInfo.ClusterNodeState
ClusterNodeInfo.RecoverLockState
DocumentStoreException.Type
FullGCMode	During hardening of FullGC one can choose level type of garbage should be cleaned up.
LeaseCheckMode	The different modes for lease checks.
NodeDocument.SplitDocType	A document which is created from splitting a main document can be classified into multiple types depending on the content i.e.
UpdateOp.Condition.Type
UpdateOp.Operation.Type	The DocumentStore operation type.

Exception Summary

Exception	Description
DocumentStoreException	DocumentStoreException is a runtime exception for DocumentStore implementations to signal unexpected problems like a communication exception.