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

Class MongoDocumentNodeStoreBuilderBase<T extends MongoDocumentNodeStoreBuilderBase<T>>

java.lang.Object

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

org.apache.jackrabbit.oak.plugins.document.mongo.MongoDocumentNodeStoreBuilderBase<T>

Direct Known Subclasses:

MongoDocumentNodeStoreBuilder

public abstract class MongoDocumentNodeStoreBuilderBase<T extends MongoDocumentNodeStoreBuilderBase<T>>
extends DocumentNodeStoreBuilder<T>

A base builder implementation for a DocumentNodeStore backed by MongoDB.

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_UPDATE_LIMIT, documentStoreSupplier

Constructor Summary

Constructors

Constructor	Description
MongoDocumentNodeStoreBuilderBase()

Method Summary

Modifier and Type	Method	Description
MissingLastRevSeeker	createMissingLastRevSeeker()
java.lang.Iterable<ReferencedBlob>	createReferencedBlobs(DocumentNodeStore ns)
VersionGCSupport	createVersionGCSupport()
java.lang.String	getCollectionCompressionType()
com.mongodb.MongoClient	getMongoClient()	Returns the MongoDB client configured in the setMongoDB(String, String, int) method.
boolean	isSocketKeepAlive()
T	setClientSessionDisabled(boolean b)	Disables the use of a client session available with MongoDB 3.6 and newer.
T	setCollectionCompressionType(java.lang.String compressionType)
T	setLeaseSocketTimeout(int timeoutMillis)	Sets a socket timeout for lease update operations.
T	setMaxReplicationLag(long duration, java.util.concurrent.TimeUnit unit)
T	setMongoDB(@NotNull com.mongodb.MongoClient client, @NotNull java.lang.String dbName)	Use the given MongoDB as backend storage for the DocumentNodeStore.
T	setMongoDB(@NotNull com.mongodb.MongoClient client, @NotNull java.lang.String dbName, int blobCacheSizeMB)	Use the given MongoDB as backend storage for the DocumentNodeStore.
T	setMongoDB(@NotNull java.lang.String uri, @NotNull java.lang.String name, int blobCacheSizeMB)	Uses the given information to connect to to MongoDB as backend storage for the DocumentNodeStore.
T	setSocketKeepAlive(boolean enable)	Enables or disables the socket keep-alive option for MongoDB.

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

build, buildChildrenCache, buildDocumentCache, buildLocalDiffCache, buildMemoryDiffCache, buildNodeCache, buildNodeDocumentCache, buildPrevDocumentsCache, clock, disableBranches, getAsyncDelay, getBlobStore, getBlobStoreCacheStats, getBlobStoreStats, getCacheEmptyCommitValue, getCancelInvalidationFeature, getChildrenCacheSize, getClock, getClusterId, getClusterIdReuseDelayAfterRecovery, getCommitValueCacheSize, getDiffCache, getDiffCacheSize, getDocStoreThrottlingFeature, getDocumentCacheSize, getDocumentStore, getDocumentStoreStatsCollector, getExecutor, getGCMonitor, getJournalGCMaxAge, getJournalPropertyHandlerFactory, getLeaseCheck, getLeaseFailureHandler, getLocalDiffCacheSize, getLogging, getMemoryDiffCacheSize, getNoChildOrderCleanupFeature, getNodeCachePathPredicate, getNodeCachePredicate, getNodeCacheSize, getNodeStoreStatsCollector, getPersistenceCacheStats, getPersistentCache, getPrefetchFeature, getPrevDocumentCacheSize, getReadOnlyMode, getRecoveryDelayMillis, getRevisionGCMaxAge, getStatisticsProvider, getSuspendTimeoutMillis, getThrottlingStatsCollector, 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, setGCMonitor, setJournalCache, setJournalGCMaxAge, setJournalPropertyHandlerFactory, setLeaseCheck, setLeaseCheckMode, setLeaseFailureHandler, setLogging, setLoggingPrefix, setNoChildOrderCleanupFeature, setNodeCachePathPredicate, setNodeCachePredicate, setNodeStoreStatsCollector, setPersistentCache, setPrefetchExternalChanges, setPrefetchFeature, setReadOnlyMode, setRecoveryDelayMillis, setRevisionGCMaxAge, setStatisticsProvider, setSuspendTimeoutMillis, setThrottlingEnabled, setThrottlingStatsCollector, 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

MongoDocumentNodeStoreBuilderBase

public MongoDocumentNodeStoreBuilderBase()

Method Detail

setMongoDB

public T setMongoDB(@NotNull
                    @NotNull java.lang.String uri,
                    @NotNull
                    @NotNull java.lang.String name,
                    int blobCacheSizeMB)

Uses the given information to connect to to MongoDB as backend storage for the DocumentNodeStore. The write concern is either taken from the URI or determined automatically based on the MongoDB setup. When running on a replica set without explicit write concern in the URI, the write concern will be MAJORITY, otherwise ACKNOWLEDGED.

Parameters:

uri - a MongoDB URI.

name - the name of the database to connect to. This overrides any database name given in the uri.

blobCacheSizeMB - the blob cache size in MB.

Returns:

this

setMongoDB

public T setMongoDB(@NotNull
                    @NotNull com.mongodb.MongoClient client,
                    @NotNull
                    @NotNull java.lang.String dbName,
                    int blobCacheSizeMB)

Use the given MongoDB as backend storage for the DocumentNodeStore.

Parameters:

client - the MongoDB connection

dbName - the database name

blobCacheSizeMB - the size of the blob cache in MB.

Returns:

this

setMongoDB

public T setMongoDB(@NotNull
                    @NotNull com.mongodb.MongoClient client,
                    @NotNull
                    @NotNull java.lang.String dbName)

Use the given MongoDB as backend storage for the DocumentNodeStore.

Parameters:

client - the MongoDB connection

dbName - the database name

Returns:

this

setSocketKeepAlive

public T setSocketKeepAlive(boolean enable)

Enables or disables the socket keep-alive option for MongoDB. The default is enabled.

Parameters:

enable - whether to enable or disable it.

Returns:

this

isSocketKeepAlive

public boolean isSocketKeepAlive()

Returns:

whether socket keep-alive is enabled.

setClientSessionDisabled

public T setClientSessionDisabled(boolean b)

Disables the use of a client session available with MongoDB 3.6 and newer. By default the MongoDocumentStore will use a client session if available. That is, when connected to MongoDB 3.6 and newer.

Parameters:

b - whether to disable the use of a client session.

Returns:

this

setLeaseSocketTimeout

public T setLeaseSocketTimeout(int timeoutMillis)

Sets a socket timeout for lease update operations.

Parameters:

timeoutMillis - the socket timeout in milliseconds.

Returns:

this builder.

setMaxReplicationLag

public T setMaxReplicationLag(long duration,
                              java.util.concurrent.TimeUnit unit)

setCollectionCompressionType

public T setCollectionCompressionType(java.lang.String compressionType)

createVersionGCSupport

public VersionGCSupport createVersionGCSupport()

Overrides:

createVersionGCSupport in class DocumentNodeStoreBuilder<T extends MongoDocumentNodeStoreBuilderBase<T>>

createReferencedBlobs

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

Overrides:

createReferencedBlobs in class DocumentNodeStoreBuilder<T extends MongoDocumentNodeStoreBuilderBase<T>>

createMissingLastRevSeeker

public MissingLastRevSeeker createMissingLastRevSeeker()

Overrides:

createMissingLastRevSeeker in class DocumentNodeStoreBuilder<T extends MongoDocumentNodeStoreBuilderBase<T>>

getCollectionCompressionType

public java.lang.String getCollectionCompressionType()

getMongoClient

public com.mongodb.MongoClient getMongoClient()

Returns the MongoDB client configured in the setMongoDB(String, String, int) method.

Returns:

the client or null if the setMongoDB(String, String, int) method hasn't been called.