org.apache.jackrabbit.oak.plugins.document

Class DocumentNodeStoreBuilder<T extends DocumentNodeStoreBuilder<T>>

java.lang.Object

org.apache.jackrabbit.oak.plugins.document.DocumentNodeStoreBuilder<T>

Direct Known Subclasses:

MongoDocumentNodeStoreBuilderBase, RDBDocumentNodeStoreBuilder

public class DocumentNodeStoreBuilder<T extends DocumentNodeStoreBuilder<T>>
extends java.lang.Object

A generic builder for a DocumentNodeStore. By default the builder will create an in-memory DocumentNodeStore. In most cases this is only useful for tests.

Field Summary

Fields

Modifier and Type	Field and Description
protected Supplier<BlobStore>	blobStoreSupplier
static int	DEFAULT_CACHE_SEGMENT_COUNT
static int	DEFAULT_CACHE_STACK_MOVE_DISTANCE
static int	DEFAULT_CHILDREN_CACHE_PERCENTAGE
static int	DEFAULT_DIFF_CACHE_PERCENTAGE
static long	DEFAULT_MEMORY_CACHE_SIZE
static int	DEFAULT_NODE_CACHE_PERCENTAGE
static int	DEFAULT_PREV_DOC_CACHE_PERCENTAGE
static int	DEFAULT_UPDATE_LIMIT
protected Supplier<DocumentStore>	documentStoreSupplier

Constructor Summary

Constructors

Constructor and Description
DocumentNodeStoreBuilder()

Method Summary

Modifier and Type	Method and Description
DocumentNodeStore	build()
Cache<NamePathRev,DocumentNodeState.Children>	buildChildrenCache(DocumentNodeStore store)
Cache<CacheValue,NodeDocument>	buildDocumentCache(DocumentStore docStore)
Cache<RevisionsKey,LocalDiffCache.Diff>	buildLocalDiffCache()
Cache<CacheValue,StringValue>	buildMemoryDiffCache()
Cache<PathRev,DocumentNodeState>	buildNodeCache(DocumentNodeStore store)
NodeDocumentCache	buildNodeDocumentCache(DocumentStore docStore, NodeDocumentLocks locks)
Cache<StringValue,NodeDocument>	buildPrevDocumentsCache(DocumentStore docStore)
T	clock(Clock clock)
MissingLastRevSeeker	createMissingLastRevSeeker()
java.lang.Iterable<ReferencedBlob>	createReferencedBlobs(DocumentNodeStore ns)
VersionGCSupport	createVersionGCSupport()
T	disableBranches()
int	getAsyncDelay()
BlobStore	getBlobStore()
@Nullable CacheStats	getBlobStoreCacheStats()
@Nullable BlobStoreStats	getBlobStoreStats()
boolean	getCacheEmptyCommitValue()
long	getChildrenCacheSize()
Clock	getClock()
int	getClusterId()
int	getCommitValueCacheSize()
org.apache.jackrabbit.oak.plugins.document.DiffCache	getDiffCache(int clusterId)
long	getDiffCacheSize()
long	getDocumentCacheSize()
DocumentStore	getDocumentStore()
DocumentStoreStatsCollector	getDocumentStoreStatsCollector()
java.util.concurrent.Executor	getExecutor()
GCMonitor	getGCMonitor()
long	getJournalGCMaxAge() The maximum age for journal entries in milliseconds.
JournalPropertyHandlerFactory	getJournalPropertyHandlerFactory()
boolean	getLeaseCheck() Deprecated. This method does not distinguish between LeaseCheckMode.LENIENT and LeaseCheckMode.STRICT and returns true for both modes. Use getLeaseCheckMode() instead.
LeaseFailureHandler	getLeaseFailureHandler()
long	getLocalDiffCacheSize()
boolean	getLogging()
long	getMemoryDiffCacheSize()
Predicate<Path>	getNodeCachePathPredicate()
Predicate<java.lang.String>	getNodeCachePredicate() Deprecated. Use getNodeCachePathPredicate() instead.
long	getNodeCacheSize()
DocumentNodeStoreStatsCollector	getNodeStoreStatsCollector()
@NotNull java.util.Map<java.lang.String,PersistentCacheStats>	getPersistenceCacheStats()
PersistentCache	getPersistentCache()
long	getPrevDocumentCacheSize()
boolean	getReadOnlyMode()
long	getRevisionGCMaxAge() The maximum age for changes in milliseconds.
StatisticsProvider	getStatisticsProvider()
boolean	getTiming()
int	getUpdateLimit()
Weigher<CacheValue,CacheValue>	getWeigher()
boolean	isBundlingDisabled()
boolean	isClusterInvisible()
boolean	isDisableBranches()
boolean	isPrefetchExternalChanges()
boolean	isUseSimpleRevision()
T	memoryCacheDistribution(int nodeCachePercentage, int prevDocCachePercentage, int childrenCachePercentage, int diffCachePercentage)
T	memoryCacheSize(long memoryCacheSize)
static DocumentNodeStoreBuilder<?>	newDocumentNodeStoreBuilder()
T	setAsyncDelay(int asyncDelay) Set the maximum delay to write the last revision to the root node.
T	setBlobStore(BlobStore blobStore) Set the blob store to use.
T	setBundlingDisabled(boolean enabled)
T	setCacheEmptyCommitValue(boolean enable) Controls whether caching of empty commit values (negative cache) is enabled.
T	setCacheSegmentCount(int cacheSegmentCount)
T	setCacheStackMoveDistance(int cacheSegmentCount)
T	setClusterId(int clusterId) Set the cluster id to use.
T	setClusterInvisible(boolean invisible) Set the cluster as invisible to the discovery lite service.
T	setCommitValueCacheSize(int cacheSize)
T	setDocumentStore(DocumentStore documentStore) Set the document store to use.
T	setDocumentStoreStatsCollector(DocumentStoreStatsCollector documentStoreStatsCollector)
T	setExecutor(java.util.concurrent.Executor executor)
T	setGCMonitor(@NotNull GCMonitor gcMonitor)
T	setJournalCache(java.lang.String journalCache) Sets the journal cache option.
T	setJournalGCMaxAge(long maxRevisionAgeMillis)
T	setJournalPropertyHandlerFactory(JournalPropertyHandlerFactory factory)
T	setLeaseCheck(boolean leaseCheck) Deprecated. use setLeaseCheckMode(LeaseCheckMode) instead.
T	setLeaseCheckMode(LeaseCheckMode mode)
T	setLeaseFailureHandler(LeaseFailureHandler leaseFailureHandler)
T	setLogging(boolean logging)
T	setLoggingPrefix(java.lang.String prefix) Sets a custom prefix for the logger.
T	setNodeCachePathPredicate(Predicate<Path> p)
T	setNodeCachePredicate(Predicate<java.lang.String> p) Deprecated. Use setNodeCachePathPredicate(Predicate) instead.
T	setNodeStoreStatsCollector(DocumentNodeStoreStatsCollector statsCollector)
T	setPersistentCache(java.lang.String persistentCache) Sets the persistent cache option.
T	setPrefetchExternalChanges(boolean b)
T	setReadOnlyMode()
T	setRevisionGCMaxAge(long maxRevisionGCAgeMillis)
T	setStatisticsProvider(StatisticsProvider statisticsProvider)
T	setTiming(boolean timing) Use the timing document store wrapper.
T	setUpdateLimit(int limit)
T	setUseSimpleRevision(boolean useSimpleRevision)
protected T	thisBuilder()
T	withWeigher(Weigher<CacheValue,CacheValue> weigher)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MEMORY_CACHE_SIZE

public static final long DEFAULT_MEMORY_CACHE_SIZE

See Also:

Constant Field Values

DEFAULT_NODE_CACHE_PERCENTAGE

public static final int DEFAULT_NODE_CACHE_PERCENTAGE

See Also:

Constant Field Values

DEFAULT_PREV_DOC_CACHE_PERCENTAGE

public static final int DEFAULT_PREV_DOC_CACHE_PERCENTAGE

See Also:

Constant Field Values

DEFAULT_CHILDREN_CACHE_PERCENTAGE

public static final int DEFAULT_CHILDREN_CACHE_PERCENTAGE

See Also:

Constant Field Values

DEFAULT_DIFF_CACHE_PERCENTAGE

public static final int DEFAULT_DIFF_CACHE_PERCENTAGE

See Also:

Constant Field Values

DEFAULT_CACHE_SEGMENT_COUNT

public static final int DEFAULT_CACHE_SEGMENT_COUNT

See Also:

Constant Field Values

DEFAULT_CACHE_STACK_MOVE_DISTANCE

public static final int DEFAULT_CACHE_STACK_MOVE_DISTANCE

See Also:

Constant Field Values

DEFAULT_UPDATE_LIMIT

public static final int DEFAULT_UPDATE_LIMIT

See Also:

Constant Field Values

documentStoreSupplier

protected Supplier<DocumentStore> documentStoreSupplier

blobStoreSupplier

protected Supplier<BlobStore> blobStoreSupplier

Constructor Detail

DocumentNodeStoreBuilder

public DocumentNodeStoreBuilder()

Method Detail

newDocumentNodeStoreBuilder

public static DocumentNodeStoreBuilder<?> newDocumentNodeStoreBuilder()

Returns:

a new DocumentNodeStoreBuilder.

build

public DocumentNodeStore build()

thisBuilder

protected final T thisBuilder()

setPersistentCache

public T setPersistentCache(java.lang.String persistentCache)

Sets the persistent cache option.

Returns:

this

setJournalCache

public T setJournalCache(java.lang.String journalCache)

Sets the journal cache option.

Returns:

this

setTiming

public T setTiming(boolean timing)

Use the timing document store wrapper.

Parameters:

timing - whether to use the timing wrapper.

Returns:

this

getTiming

public boolean getTiming()

setLogging

public T setLogging(boolean logging)

getLogging

public boolean getLogging()

setLoggingPrefix

public T setLoggingPrefix(java.lang.String prefix)

Sets a custom prefix for the logger.

Parameters:

prefix - to be used in the logs output.

Returns:

this

setLeaseCheck

@Deprecated
public T setLeaseCheck(boolean leaseCheck)

Deprecated. use setLeaseCheckMode(LeaseCheckMode) instead.

If true, sets lease check mode to LeaseCheckMode.LENIENT, otherwise sets the mode to LeaseCheckMode.DISABLED. This method is only kept for backward compatibility with the behaviour before OAK-7626. The new default lease check mode is LeaseCheckMode.STRICT, but existing code may rely on the previous behaviour, when enabling the lease check corresponded with a LeaseCheckMode.LENIENT behaviour.

getLeaseCheck

@Deprecated
public boolean getLeaseCheck()

Deprecated. This method does not distinguish between LeaseCheckMode.LENIENT and LeaseCheckMode.STRICT and returns true for both modes. Use getLeaseCheckMode() instead.

setLeaseCheckMode

public T setLeaseCheckMode(LeaseCheckMode mode)

setReadOnlyMode

public T setReadOnlyMode()

getReadOnlyMode

public boolean getReadOnlyMode()

setLeaseFailureHandler

public T setLeaseFailureHandler(LeaseFailureHandler leaseFailureHandler)

getLeaseFailureHandler

public LeaseFailureHandler getLeaseFailureHandler()

setDocumentStore

public T setDocumentStore(DocumentStore documentStore)

Set the document store to use. By default an in-memory store is used.

Parameters:

documentStore - the document store

Returns:

this

getDocumentStore

public DocumentStore getDocumentStore()

getDiffCache

public org.apache.jackrabbit.oak.plugins.document.DiffCache getDiffCache(int clusterId)

setBlobStore

public T setBlobStore(BlobStore blobStore)

Set the blob store to use. By default an in-memory store is used.

Parameters:

blobStore - the blob store

Returns:

this

getBlobStore

public BlobStore getBlobStore()

setClusterId

public T setClusterId(int clusterId)

Set the cluster id to use. By default, 0 is used, meaning the cluster id is automatically generated.

Parameters:

clusterId - the cluster id

Returns:

this

setClusterInvisible

public T setClusterInvisible(boolean invisible)

Set the cluster as invisible to the discovery lite service. By default it is visible.

Returns:

this

See Also:

DocumentDiscoveryLiteService

setCacheSegmentCount

public T setCacheSegmentCount(int cacheSegmentCount)

setCacheStackMoveDistance

public T setCacheStackMoveDistance(int cacheSegmentCount)

getClusterId

public int getClusterId()

isClusterInvisible

public boolean isClusterInvisible()

setAsyncDelay

public T setAsyncDelay(int asyncDelay)

Set the maximum delay to write the last revision to the root node. By default 1000 (meaning 1 second) is used.

Parameters:

asyncDelay - in milliseconds

Returns:

this

getAsyncDelay

public int getAsyncDelay()

getWeigher

public Weigher<CacheValue,CacheValue> getWeigher()

withWeigher

public T withWeigher(Weigher<CacheValue,CacheValue> weigher)

memoryCacheSize

public T memoryCacheSize(long memoryCacheSize)

memoryCacheDistribution

public T memoryCacheDistribution(int nodeCachePercentage,
                                 int prevDocCachePercentage,
                                 int childrenCachePercentage,
                                 int diffCachePercentage)

getNodeCacheSize

public long getNodeCacheSize()

getPrevDocumentCacheSize

public long getPrevDocumentCacheSize()

getChildrenCacheSize

public long getChildrenCacheSize()

getDocumentCacheSize

public long getDocumentCacheSize()

getDiffCacheSize

public long getDiffCacheSize()

getMemoryDiffCacheSize

public long getMemoryDiffCacheSize()

getLocalDiffCacheSize

public long getLocalDiffCacheSize()

setUseSimpleRevision

public T setUseSimpleRevision(boolean useSimpleRevision)

isUseSimpleRevision

public boolean isUseSimpleRevision()

getExecutor

public java.util.concurrent.Executor getExecutor()

setExecutor

public T setExecutor(java.util.concurrent.Executor executor)

clock

public T clock(Clock clock)

setStatisticsProvider

public T setStatisticsProvider(StatisticsProvider statisticsProvider)

getStatisticsProvider

public StatisticsProvider getStatisticsProvider()

getDocumentStoreStatsCollector

public DocumentStoreStatsCollector getDocumentStoreStatsCollector()

setDocumentStoreStatsCollector

public T setDocumentStoreStatsCollector(DocumentStoreStatsCollector documentStoreStatsCollector)

getNodeStoreStatsCollector

public DocumentNodeStoreStatsCollector getNodeStoreStatsCollector()

setNodeStoreStatsCollector

public T setNodeStoreStatsCollector(DocumentNodeStoreStatsCollector statsCollector)

getPersistenceCacheStats

@NotNull
public @NotNull java.util.Map<java.lang.String,PersistentCacheStats> getPersistenceCacheStats()

getBlobStoreStats

@Nullable
public @Nullable BlobStoreStats getBlobStoreStats()

getBlobStoreCacheStats

@Nullable
public @Nullable CacheStats getBlobStoreCacheStats()

getClock

public Clock getClock()

disableBranches

public T disableBranches()

isDisableBranches

public boolean isDisableBranches()

setBundlingDisabled

public T setBundlingDisabled(boolean enabled)

isBundlingDisabled

public boolean isBundlingDisabled()

setPrefetchExternalChanges

public T setPrefetchExternalChanges(boolean b)

isPrefetchExternalChanges

public boolean isPrefetchExternalChanges()

setJournalPropertyHandlerFactory

public T setJournalPropertyHandlerFactory(JournalPropertyHandlerFactory factory)

getJournalPropertyHandlerFactory

public JournalPropertyHandlerFactory getJournalPropertyHandlerFactory()

setUpdateLimit

public T setUpdateLimit(int limit)

getUpdateLimit

public int getUpdateLimit()

setCommitValueCacheSize

public T setCommitValueCacheSize(int cacheSize)

getCommitValueCacheSize

public int getCommitValueCacheSize()

setCacheEmptyCommitValue

public T setCacheEmptyCommitValue(boolean enable)

Controls whether caching of empty commit values (negative cache) is enabled. This cache is disabled by default. The cache can only be enabled on a read-only store. In read-write mode, the cache is always be disabled.

Parameters:

enable - true to enable the empty commit value cache.

Returns:

this builder.

getCacheEmptyCommitValue

public boolean getCacheEmptyCommitValue()

Returns:

true when caching of empty commit values is enabled, false otherwise.

setJournalGCMaxAge

public T setJournalGCMaxAge(long maxRevisionAgeMillis)

getJournalGCMaxAge

public long getJournalGCMaxAge()

The maximum age for journal entries in milliseconds. Older entries are candidates for GC.

Returns:

maximum age for journal entries in milliseconds.

setRevisionGCMaxAge

public T setRevisionGCMaxAge(long maxRevisionGCAgeMillis)

getRevisionGCMaxAge

public long getRevisionGCMaxAge()

The maximum age for changes in milliseconds. Older changes are candidates for revision garbage collection.

Returns:

maximum age in milliseconds.

setGCMonitor

public T setGCMonitor(@NotNull
                      @NotNull GCMonitor gcMonitor)

getGCMonitor

public GCMonitor getGCMonitor()

createVersionGCSupport

public VersionGCSupport createVersionGCSupport()

createReferencedBlobs

public java.lang.Iterable<ReferencedBlob> createReferencedBlobs(DocumentNodeStore ns)

createMissingLastRevSeeker

public MissingLastRevSeeker createMissingLastRevSeeker()

buildNodeCache

public Cache<PathRev,DocumentNodeState> buildNodeCache(DocumentNodeStore store)

buildChildrenCache

public Cache<NamePathRev,DocumentNodeState.Children> buildChildrenCache(DocumentNodeStore store)

buildMemoryDiffCache

public Cache<CacheValue,StringValue> buildMemoryDiffCache()

buildLocalDiffCache

public Cache<RevisionsKey,LocalDiffCache.Diff> buildLocalDiffCache()

buildDocumentCache

public Cache<CacheValue,NodeDocument> buildDocumentCache(DocumentStore docStore)

buildPrevDocumentsCache

public Cache<StringValue,NodeDocument> buildPrevDocumentsCache(DocumentStore docStore)

buildNodeDocumentCache

public NodeDocumentCache buildNodeDocumentCache(DocumentStore docStore,
                                                NodeDocumentLocks locks)

setNodeCachePredicate

@Deprecated
public T setNodeCachePredicate(Predicate<java.lang.String> p)

Deprecated. Use setNodeCachePathPredicate(Predicate) instead.

getNodeCachePredicate

@Deprecated
public Predicate<java.lang.String> getNodeCachePredicate()

Deprecated. Use getNodeCachePathPredicate() instead.

setNodeCachePathPredicate

public T setNodeCachePathPredicate(Predicate<Path> p)

getNodeCachePathPredicate

public Predicate<Path> getNodeCachePathPredicate()

getPersistentCache

public PersistentCache getPersistentCache()