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

Class RDBDocumentNodeStoreBuilder

java.lang.Object

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

org.apache.jackrabbit.oak.plugins.document.rdb.RDBDocumentNodeStoreBuilder

public class RDBDocumentNodeStoreBuilder
extends DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

A builder for a DocumentNodeStore backed by a relational database.

Field Summary

Fields inherited from class org.apache.jackrabbit.oak.plugins.document.DocumentNodeStoreBuilder

blobStoreSupplier, DEFAULT_CACHE_SEGMENT_COUNT, DEFAULT_CACHE_STACK_MOVE_DISTANCE, DEFAULT_CHILDREN_CACHE_PERCENTAGE, DEFAULT_DIFF_CACHE_PERCENTAGE, DEFAULT_MEMORY_CACHE_SIZE, DEFAULT_NODE_CACHE_PERCENTAGE, DEFAULT_PREV_DOC_CACHE_PERCENTAGE, DEFAULT_PREV_NO_PROP_CACHE_PERCENTAGE, DEFAULT_UPDATE_LIMIT, documentStoreSupplier

Constructor Summary

Constructors

Constructor	Description
RDBDocumentNodeStoreBuilder()

Method Summary

Modifier and Type	Method	Description
boolean	avoidMergeLock()
MissingLastRevSeeker	createMissingLastRevSeeker()
Iterable<ReferencedBlob>	createReferencedBlobs(DocumentNodeStore ns)
VersionGCSupport	createVersionGCSupport()
@Nullable Feature	getDocStoreAvoidMergeLockFeature()
@Nullable Feature	getDocStoreEmbeddedVerificationFeature()
@Nullable Feature	getDocStoreFullGCFeature()
Set<String>	getFullGCExcludePaths()
long	getFullGCGeneration()
Set<String>	getFullGCIncludePaths()
long	getFullGcMaxAgeMillis()	The maximum age for nodes in milliseconds.
int	getFullGCMode()
boolean	isEmbeddedVerificationEnabled()
boolean	isFullGCAuditLoggingEnabled()
boolean	isFullGCEnabled()
static RDBDocumentNodeStoreBuilder	newRDBDocumentNodeStoreBuilder()
RDBDocumentNodeStoreBuilder	setAvoidMergeLock(boolean b)
RDBDocumentNodeStoreBuilder	setDocStoreAvoidMergeLockFeature(@Nullable Feature docStoreAvoidMergeLock)
RDBDocumentNodeStoreBuilder	setDocStoreEmbeddedVerificationFeature(@Nullable Feature getDocStoreEmbeddedVerification)
RDBDocumentNodeStoreBuilder	setDocStoreFullGCFeature(@Nullable Feature docStoreFullGC)
RDBDocumentNodeStoreBuilder	setEmbeddedVerificationEnabled(boolean b)
RDBDocumentNodeStoreBuilder	setFullGCAuditLoggingEnabled(boolean b)
RDBDocumentNodeStoreBuilder	setFullGCEnabled(boolean b)
RDBDocumentNodeStoreBuilder	setFullGCExcludePaths(@NotNull String[] excludePaths)
RDBDocumentNodeStoreBuilder	setFullGCGeneration(long v)
RDBDocumentNodeStoreBuilder	setFullGCIncludePaths(@NotNull String[] includePaths)
RDBDocumentNodeStoreBuilder	setFullGcMaxAgeMillis(long v)	The maximum age for nodes in milliseconds.
RDBDocumentNodeStoreBuilder	setFullGCMode(int v)
RDBDocumentNodeStoreBuilder	setRDBConnection(DataSource ds)	Sets a DataSource to use for the RDB document and blob stores.
RDBDocumentNodeStoreBuilder	setRDBConnection(DataSource documentStoreDataSource, DataSource blobStoreDataSource)	Sets a DataSources to use for the RDB document and blob stores.
RDBDocumentNodeStoreBuilder	setRDBConnection(DataSource documentStoreDataSource, DataSource blobStoreDataSource, RDBOptions options)	Sets a DataSources to use for the RDB document and blob stores, including RDBOptions.
RDBDocumentNodeStoreBuilder	setRDBConnection(DataSource ds, RDBOptions options)	Sets a DataSource to use for the RDB document and blob stores, including RDBOptions.

Methods inherited from class org.apache.jackrabbit.oak.plugins.document.DocumentNodeStoreBuilder

build, buildChildrenCache, buildDocumentCache, buildLocalDiffCache, buildMemoryDiffCache, buildNodeCache, buildNodeDocumentCache, buildPrevDocumentsCache, buildPrevNoPropCache, clock, disableBranches, getAsyncDelay, getBlobStore, getBlobStoreCacheStats, getBlobStoreStats, getCacheEmptyCommitValue, getCancelInvalidationFeature, getChildrenCacheSize, getClock, getClusterId, getClusterIdReuseDelayAfterRecovery, getCommitValueCacheSize, getDiffCache, getDiffCacheSize, getDocStoreThrottlingFeature, getDocumentCacheSize, getDocumentStore, getDocumentStoreStatsCollector, getExecutor, getFullGCBatchSize, getFullGCDelayFactor, getFullGCProgressSize, getGCMonitor, getJournalGCMaxAge, getJournalPropertyHandlerFactory, getLeaseCheck, getLeaseFailureHandler, getLocalDiffCacheSize, getLogging, getMemoryDiffCacheSize, getNoChildOrderCleanupFeature, getNodeCachePathPredicate, getNodeCachePredicate, getNodeCacheSize, getNodeStoreStatsCollector, getPerfloggerInfoMillis, getPersistenceCacheStats, getPersistentCache, getPrefetchFeature, getPrevDocumentCacheSize, getPrevNoPropCacheFeature, getPrevNoPropCacheSize, getReadOnlyMode, getRecoveryDelayMillis, getRevisionGCMaxAge, getStatisticsProvider, getSuspendTimeoutMillis, getThrottlingJobSchedulePeriodSecs, getThrottlingStatsCollector, getThrottlingTimeMillis, getTiming, getUpdateLimit, getWeigher, isBundlingDisabled, isClusterInvisible, isDisableBranches, isPrefetchExternalChanges, isThrottlingEnabled, isUseSimpleRevision, memoryCacheDistribution, memoryCacheSize, newDocumentNodeStoreBuilder, setAsyncDelay, setBlobStore, setBundlingDisabled, setCacheEmptyCommitValue, setCacheSegmentCount, setCacheStackMoveDistance, setCancelInvalidationFeature, setClusterId, setClusterIdReuseDelayAfterRecovery, setClusterInvisible, setCommitValueCacheSize, setDocStoreThrottlingFeature, setDocumentStore, setDocumentStoreStatsCollector, setExecutor, setFullGCBatchSize, setFullGCDelayFactor, setFullGCProgressSize, setGCMonitor, setJournalCache, setJournalGCMaxAge, setJournalPropertyHandlerFactory, setLeaseCheck, setLeaseCheckMode, setLeaseFailureHandler, setLogging, setLoggingPrefix, setNoChildOrderCleanupFeature, setNodeCachePathPredicate, setNodeCachePredicate, setNodeStoreStatsCollector, setPerfloggerInfoMillis, setPersistentCache, setPrefetchExternalChanges, setPrefetchFeature, setPrevNoPropCacheFeature, setReadOnlyMode, setRecoveryDelayMillis, setRevisionGCMaxAge, setStatisticsProvider, setSuspendTimeoutMillis, setThrottlingEnabled, setThrottlingJobSchedulePeriodSecs, setThrottlingStatsCollector, setThrottlingTimeMillis, setTiming, setUpdateLimit, setUseSimpleRevision, thisBuilder, withWeigher

Methods inherited from class java.lang.Object

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

Constructor Detail

RDBDocumentNodeStoreBuilder

public RDBDocumentNodeStoreBuilder()

Method Detail

newRDBDocumentNodeStoreBuilder

public static RDBDocumentNodeStoreBuilder newRDBDocumentNodeStoreBuilder()

Returns:

a new RDBDocumentNodeStoreBuilder.

setRDBConnection

public RDBDocumentNodeStoreBuilder setRDBConnection(DataSource ds)

Sets a DataSource to use for the RDB document and blob stores.

Returns:

this

setRDBConnection

public RDBDocumentNodeStoreBuilder setRDBConnection(DataSource ds,
                                                    RDBOptions options)

Sets a DataSource to use for the RDB document and blob stores, including RDBOptions.

Returns:

this

setRDBConnection

public RDBDocumentNodeStoreBuilder setRDBConnection(DataSource documentStoreDataSource,
                                                    DataSource blobStoreDataSource)

Sets a DataSources to use for the RDB document and blob stores.

Returns:

this

setRDBConnection

public RDBDocumentNodeStoreBuilder setRDBConnection(DataSource documentStoreDataSource,
                                                    DataSource blobStoreDataSource,
                                                    RDBOptions options)

Sets a DataSources to use for the RDB document and blob stores, including RDBOptions.

Returns:

this

createVersionGCSupport

public VersionGCSupport createVersionGCSupport()

Overrides:

createVersionGCSupport in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

createReferencedBlobs

public Iterable<ReferencedBlob> createReferencedBlobs(DocumentNodeStore ns)

Overrides:

createReferencedBlobs in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

createMissingLastRevSeeker

public MissingLastRevSeeker createMissingLastRevSeeker()

Overrides:

createMissingLastRevSeeker in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

isFullGCEnabled

public boolean isFullGCEnabled()

Overrides:

isFullGCEnabled in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

setFullGCEnabled

public RDBDocumentNodeStoreBuilder setFullGCEnabled(boolean b)

Overrides:

setFullGCEnabled in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

setAvoidMergeLock

public RDBDocumentNodeStoreBuilder setAvoidMergeLock(boolean b)

Overrides:

setAvoidMergeLock in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

avoidMergeLock

public boolean avoidMergeLock()

Overrides:

avoidMergeLock in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

isFullGCAuditLoggingEnabled

public boolean isFullGCAuditLoggingEnabled()

Overrides:

isFullGCAuditLoggingEnabled in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

setFullGCAuditLoggingEnabled

public RDBDocumentNodeStoreBuilder setFullGCAuditLoggingEnabled(boolean b)

Overrides:

setFullGCAuditLoggingEnabled in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

getFullGCIncludePaths

public Set<String> getFullGCIncludePaths()

Overrides:

getFullGCIncludePaths in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

setFullGCIncludePaths

public RDBDocumentNodeStoreBuilder setFullGCIncludePaths(@NotNull
                                                         @NotNull String[] includePaths)

Overrides:

setFullGCIncludePaths in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

getFullGCExcludePaths

public Set<String> getFullGCExcludePaths()

Overrides:

getFullGCExcludePaths in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

setFullGCExcludePaths

public RDBDocumentNodeStoreBuilder setFullGCExcludePaths(@NotNull
                                                         @NotNull String[] excludePaths)

Overrides:

setFullGCExcludePaths in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

setFullGCMode

public RDBDocumentNodeStoreBuilder setFullGCMode(int v)

Overrides:

setFullGCMode in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

getFullGCMode

public int getFullGCMode()

Overrides:

getFullGCMode in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

setFullGCGeneration

public RDBDocumentNodeStoreBuilder setFullGCGeneration(long v)

Overrides:

setFullGCGeneration in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

getFullGCGeneration

public long getFullGCGeneration()

Overrides:

getFullGCGeneration in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

setFullGcMaxAgeMillis

public RDBDocumentNodeStoreBuilder setFullGcMaxAgeMillis(long v)

Description copied from class: DocumentNodeStoreBuilder

The maximum age for nodes in milliseconds. Older entries are candidates for full gc

Overrides:

setFullGcMaxAgeMillis in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

Parameters:

v - max age in millis

Returns:

builder object

getFullGcMaxAgeMillis

public long getFullGcMaxAgeMillis()

Description copied from class: DocumentNodeStoreBuilder

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

Overrides:

getFullGcMaxAgeMillis in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

Returns:

maximum age for nodes entries in milliseconds.

setDocStoreAvoidMergeLockFeature

public RDBDocumentNodeStoreBuilder setDocStoreAvoidMergeLockFeature(@Nullable
                                                                    @Nullable Feature docStoreAvoidMergeLock)

Overrides:

setDocStoreAvoidMergeLockFeature in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

getDocStoreAvoidMergeLockFeature

@Nullable
public @Nullable Feature getDocStoreAvoidMergeLockFeature()

Overrides:

getDocStoreAvoidMergeLockFeature in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

setDocStoreFullGCFeature

public RDBDocumentNodeStoreBuilder setDocStoreFullGCFeature(@Nullable
                                                            @Nullable Feature docStoreFullGC)

Overrides:

setDocStoreFullGCFeature in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

getDocStoreFullGCFeature

@Nullable
public @Nullable Feature getDocStoreFullGCFeature()

Overrides:

getDocStoreFullGCFeature in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

isEmbeddedVerificationEnabled

public boolean isEmbeddedVerificationEnabled()

Overrides:

isEmbeddedVerificationEnabled in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

setEmbeddedVerificationEnabled

public RDBDocumentNodeStoreBuilder setEmbeddedVerificationEnabled(boolean b)

Overrides:

setEmbeddedVerificationEnabled in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

setDocStoreEmbeddedVerificationFeature

public RDBDocumentNodeStoreBuilder setDocStoreEmbeddedVerificationFeature(@Nullable
                                                                          @Nullable Feature getDocStoreEmbeddedVerification)

Overrides:

setDocStoreEmbeddedVerificationFeature in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>

getDocStoreEmbeddedVerificationFeature

@Nullable
public @Nullable Feature getDocStoreEmbeddedVerificationFeature()

Overrides:

getDocStoreEmbeddedVerificationFeature in class DocumentNodeStoreBuilder<RDBDocumentNodeStoreBuilder>