org.axonframework.extensions.mongo.eventsourcing.eventstore

Class MongoSettingsFactory

java.lang.Object

org.axonframework.extensions.mongo.eventsourcing.eventstore.MongoSettingsFactory

public class MongoSettingsFactory
extends Object

Factory class used to create a MongoClientSettings instance. The instance makes use of the defaults as provided by the MongoOptions class. The moment you set a valid value, that value is used to create the options object.

Note: WriteConcern enums were changed in MongoDb driver 4.x. Depending on the number of addresses provided, the factory defaults to either WriteConcern.W2 when more than one address is provided, or WriteConcern.JOURNALED when only one server is available. The idea of these defaults is that data must be able to survive a (not too heavy) crash without loss of data. We wouldn't want to publish untraceable events, would we...

Since:

2.0 (in incubator since 0.7)

Author:

Jettro Coenradie

Constructor Summary

Constructors

Constructor and Description
MongoSettingsFactory() Default constructor for the factory that initializes the defaults.

Method Summary

Modifier and Type	Method and Description
com.mongodb.MongoClientSettings	createMongoClientSettings() Uses the configured parameters to create a MongoOptions instance.
int	getConnectionsPerHost() Getter for connectionsPerHost.
long	getMaxWaitTime() get the maximum time a blocked thread that waits for a connection should wait.
int	getSocketConnectTimeout() Sets the connection timeout in milliseconds for doing something in mongo.
int	getSocketReadTimeOut() Getter for the socket read timeout.
void	setConnectionsPerHost(int connectionsPerHost) Setter for the connections per host that are allowed.
void	setMaxWaitTime(long maxWaitTime) Set the max wait time for a blocked thread in milli seconds.
void	setMongoAddresses(List<com.mongodb.ServerAddress> mongoAddresses) Provide a list of ServerAddress objects to use for locating the Mongo replica set.
void	setSocketConnectTimeout(int socketConnectTimeout) Setter for socket connection timeout.
void	setSocketReadTimeOut(int socketReadTimeOut) Setter for the socket read timeout.
void	setWriteConcern(com.mongodb.WriteConcern writeConcern) Provided a write concern to be used by the mongo instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoSettingsFactory

public MongoSettingsFactory()

Default constructor for the factory that initializes the defaults.

Method Detail

createMongoClientSettings

public com.mongodb.MongoClientSettings createMongoClientSettings()

Uses the configured parameters to create a MongoOptions instance.

Returns:

MongoOptions instance based on the configured properties

getConnectionsPerHost

public int getConnectionsPerHost()

Getter for connectionsPerHost.

Returns:

number representing the connections per host

setConnectionsPerHost

public void setConnectionsPerHost(int connectionsPerHost)

Setter for the connections per host that are allowed.

Parameters:

connectionsPerHost - number representing the number of connections per host

getSocketConnectTimeout

public int getSocketConnectTimeout()

Sets the connection timeout in milliseconds for doing something in mongo. Zero is indefinite

Returns:

number representing milli seconds of timeout

setSocketConnectTimeout

public void setSocketConnectTimeout(int socketConnectTimeout)

Setter for socket connection timeout.

Parameters:

socketConnectTimeout - number representing the connection timeout in millis

getMaxWaitTime

public long getMaxWaitTime()

get the maximum time a blocked thread that waits for a connection should wait.

Returns:

number of milli seconds the thread waits for a connection

setMaxWaitTime

public void setMaxWaitTime(long maxWaitTime)

Set the max wait time for a blocked thread in milli seconds.

Parameters:

maxWaitTime - number representing the number of milli seconds to wait for a thread

getSocketReadTimeOut

public int getSocketReadTimeOut()

Getter for the socket read timeout.

Returns:

Number representing the amount of milli seconds to wait for a socket connection

setSocketReadTimeOut

public void setSocketReadTimeOut(int socketReadTimeOut)

Setter for the socket read timeout.

Parameters:

socketReadTimeOut - number representing the amount of milli seconds to wait for a socket connection

setMongoAddresses

public void setMongoAddresses(List<com.mongodb.ServerAddress> mongoAddresses)

Provide a list of ServerAddress objects to use for locating the Mongo replica set. An empty list will result in a single Mongo instance being used on the default host (127.0.0.1) and port (com.mongodb.ServerAddress#defaultPort)

Defaults to an empty list, which locates a single Mongo instance on the default host (127.0.0.1) and port (com.mongodb.ServerAddress#defaultPort)

Parameters:

mongoAddresses - List of ServerAddress instances

setWriteConcern

public void setWriteConcern(com.mongodb.WriteConcern writeConcern)

Provided a write concern to be used by the mongo instance. The provided concern should be compatible with the number of addresses provided with setMongoAddresses(java.util.List). For example, providing WriteConcern.W2 in combination with a single address will cause each write operation to hang.

While safe (e.g. WriteConcern.W2) WriteConcerns allow you to detect concurrency issues immediately, you might want to use a more relaxed write concern if you have other mechanisms in place to ensure consistency.

Defaults to WriteConcern.W2 if you provided more than one address with setMongoAddresses(java.util.List), or WriteConcern.JOURNALED if there is only one address (or none at all).

Parameters:

writeConcern - WriteConcern to use for the connections