com.github.cloudyrock.mongock.driver.mongodb.sync.v4.driver

Class MongoSync4DriverBase<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>

java.lang.Object

com.github.cloudyrock.mongock.driver.core.driver.ConnectionDriverBase<CHANGE_ENTRY>

com.github.cloudyrock.mongock.driver.mongodb.sync.v4.driver.MongoSync4DriverBase<CHANGE_ENTRY>

All Implemented Interfaces:

com.github.cloudyrock.mongock.driver.api.common.Validable, com.github.cloudyrock.mongock.driver.api.driver.ConnectionDriver<CHANGE_ENTRY>, com.github.cloudyrock.mongock.driver.api.driver.Transactionable

Direct Known Subclasses:

MongoSync4Driver

@NotThreadSafe
public abstract class MongoSync4DriverBase<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>
extends com.github.cloudyrock.mongock.driver.core.driver.ConnectionDriverBase<CHANGE_ENTRY>
implements com.github.cloudyrock.mongock.driver.api.driver.ConnectionDriver<CHANGE_ENTRY>, com.github.cloudyrock.mongock.driver.api.driver.Transactionable

Field Summary

Fields

Modifier and Type	Field and Description
protected String	changeLogCollectionName
protected Set<com.github.cloudyrock.mongock.driver.api.driver.ChangeSetDependency>	dependencies
protected boolean	indexCreation
protected String	lockCollectionName
protected MongoSync4LockRepository	lockRepository
protected com.mongodb.client.MongoClient	mongoClient
protected com.mongodb.client.MongoDatabase	mongoDatabase
protected com.github.cloudyrock.mongock.driver.api.driver.TransactionStrategy	transactionStrategy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MongoSync4DriverBase(com.mongodb.client.MongoClient mongoClient, String databaseName, long lockAcquiredForMillis, long lockQuitTryingAfterMillis, long lockTryFrequencyMillis)
protected	MongoSync4DriverBase(com.mongodb.client.MongoDatabase mongoDatabase, long lockAcquiredForMillis, long lockQuitTryingAfterMillis, long lockTryFrequencyMillis)

Method Summary

Modifier and Type	Method and Description
void	disableTransaction()
void	executeInTransaction(Runnable operation)
String	getChangeLogRepositoryName()
Set<com.github.cloudyrock.mongock.driver.api.driver.ChangeSetDependency>	getDependencies()
protected com.github.cloudyrock.mongock.driver.core.lock.LockRepository	getLockRepository()
String	getLockRepositoryName()
protected ReadWriteConfiguration	getReadWriteConfiguration()
com.github.cloudyrock.mongock.driver.api.driver.TransactionStrategy	getTransactionStrategy()
void	runValidation()
void	setChangeLogRepositoryName(String changeLogCollectionName)
void	setIndexCreation(boolean indexCreation)
void	setLockRepositoryName(String lockCollectionName)
void	setReadConcern(com.mongodb.ReadConcern readConcern)
void	setReadPreference(com.mongodb.ReadPreference readPreference)
void	setTransactionOptions(com.mongodb.TransactionOptions txOptions) When using Java MongoDB driver directly, it sets the transaction options for all the Mongock's transactions.
void	setWriteConcern(com.mongodb.WriteConcern writeConcern)
void	specificInitialization()

Methods inherited from class com.github.cloudyrock.mongock.driver.core.driver.ConnectionDriverBase

getLockAcquiredForMillis, getLockManager, getLockQuitTryingAfterMillis, getLockTryFrequencyMillis, getManagerAndAcquireLock, initialize, isIndexCreation, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.cloudyrock.mongock.driver.api.driver.ConnectionDriver

getChangeEntryService, getForbiddenParameters, getLegacyMigrationChangeLogClass, getLockAcquiredForMillis, getLockManager, getLockQuitTryingAfterMillis, getLockTryFrequencyMillis, getManagerAndAcquireLock, initialize, isIndexCreation, isInitialized

Field Detail

mongoDatabase

protected final com.mongodb.client.MongoDatabase mongoDatabase

changeLogCollectionName

protected String changeLogCollectionName

lockCollectionName

protected String lockCollectionName

indexCreation

protected boolean indexCreation

lockRepository

protected MongoSync4LockRepository lockRepository

dependencies

protected Set<com.github.cloudyrock.mongock.driver.api.driver.ChangeSetDependency> dependencies

transactionStrategy

protected com.github.cloudyrock.mongock.driver.api.driver.TransactionStrategy transactionStrategy

mongoClient

protected com.mongodb.client.MongoClient mongoClient

Constructor Detail

MongoSync4DriverBase

protected MongoSync4DriverBase(com.mongodb.client.MongoClient mongoClient,
                               String databaseName,
                               long lockAcquiredForMillis,
                               long lockQuitTryingAfterMillis,
                               long lockTryFrequencyMillis)

MongoSync4DriverBase

protected MongoSync4DriverBase(com.mongodb.client.MongoDatabase mongoDatabase,
                               long lockAcquiredForMillis,
                               long lockQuitTryingAfterMillis,
                               long lockTryFrequencyMillis)

Method Detail

setChangeLogRepositoryName

public void setChangeLogRepositoryName(String changeLogCollectionName)

Specified by:

setChangeLogRepositoryName in interface com.github.cloudyrock.mongock.driver.api.driver.ConnectionDriver<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>

Overrides:

setChangeLogRepositoryName in class com.github.cloudyrock.mongock.driver.core.driver.ConnectionDriverBase<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>

setLockRepositoryName

public void setLockRepositoryName(String lockCollectionName)

Specified by:

setLockRepositoryName in interface com.github.cloudyrock.mongock.driver.api.driver.ConnectionDriver<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>

Overrides:

setLockRepositoryName in class com.github.cloudyrock.mongock.driver.core.driver.ConnectionDriverBase<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>

getChangeLogRepositoryName

public String getChangeLogRepositoryName()

Specified by:

getChangeLogRepositoryName in interface com.github.cloudyrock.mongock.driver.api.driver.ConnectionDriver<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>

Overrides:

getChangeLogRepositoryName in class com.github.cloudyrock.mongock.driver.core.driver.ConnectionDriverBase<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>

getLockRepositoryName

public String getLockRepositoryName()

Specified by:

getLockRepositoryName in interface com.github.cloudyrock.mongock.driver.api.driver.ConnectionDriver<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>

Overrides:

getLockRepositoryName in class com.github.cloudyrock.mongock.driver.core.driver.ConnectionDriverBase<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>

setIndexCreation

public void setIndexCreation(boolean indexCreation)

Specified by:

setIndexCreation in interface com.github.cloudyrock.mongock.driver.api.driver.ConnectionDriver<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>

Overrides:

setIndexCreation in class com.github.cloudyrock.mongock.driver.core.driver.ConnectionDriverBase<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>

setTransactionOptions

public void setTransactionOptions(com.mongodb.TransactionOptions txOptions)

When using Java MongoDB driver directly, it sets the transaction options for all the Mongock's transactions. Default: readPreference: primary, readConcern and writeConcern: majority

Parameters:

txOptions - transaction options

setWriteConcern

public void setWriteConcern(com.mongodb.WriteConcern writeConcern)

setReadConcern

public void setReadConcern(com.mongodb.ReadConcern readConcern)

setReadPreference

public void setReadPreference(com.mongodb.ReadPreference readPreference)

runValidation

public void runValidation()
                   throws com.github.cloudyrock.mongock.exception.MongockException

Specified by:

runValidation in interface com.github.cloudyrock.mongock.driver.api.common.Validable

Overrides:

runValidation in class com.github.cloudyrock.mongock.driver.core.driver.ConnectionDriverBase<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>

Throws:

com.github.cloudyrock.mongock.exception.MongockException

getLockRepository

protected com.github.cloudyrock.mongock.driver.core.lock.LockRepository getLockRepository()

Specified by:

getLockRepository in class com.github.cloudyrock.mongock.driver.core.driver.ConnectionDriverBase<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>

getDependencies

public Set<com.github.cloudyrock.mongock.driver.api.driver.ChangeSetDependency> getDependencies()

Specified by:

getDependencies in interface com.github.cloudyrock.mongock.driver.api.driver.ConnectionDriver<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>

specificInitialization

public void specificInitialization()

Specified by:

specificInitialization in class com.github.cloudyrock.mongock.driver.core.driver.ConnectionDriverBase<CHANGE_ENTRY extends com.github.cloudyrock.mongock.driver.api.entry.ChangeEntry>

disableTransaction

public void disableTransaction()

Specified by:

disableTransaction in interface com.github.cloudyrock.mongock.driver.api.driver.Transactionable

getTransactionStrategy

public com.github.cloudyrock.mongock.driver.api.driver.TransactionStrategy getTransactionStrategy()

Specified by:

getTransactionStrategy in interface com.github.cloudyrock.mongock.driver.api.driver.Transactionable

executeInTransaction

public void executeInTransaction(Runnable operation)

Specified by:

executeInTransaction in interface com.github.cloudyrock.mongock.driver.api.driver.Transactionable

getReadWriteConfiguration

protected ReadWriteConfiguration getReadWriteConfiguration()