DATAMONGO-1620 - Polishing.

Use Integer.MIN_VALUE as placeholder for unset values to allow setting zero (immediately) and -1 (indefinite wait) server selection timeouts. Fix test method name. Add JavaDoc.

Original pull request: #449.

Author: mp911de

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoClientOptionsFactoryBean.java

@@ -32,7 +32,7 @@
 
 /**
  * A factory bean for construction of a {@link MongoClientOptions} instance.
- * 
+ *
  * @author Christoph Strobl
  * @author Oliver Gierke
  * @since 1.7
@@ -64,14 +64,14 @@ public class MongoClientOptionsFactoryBean extends AbstractFactoryBean<MongoClie
 	private int heartbeatConnectTimeout = DEFAULT_MONGO_OPTIONS.getHeartbeatConnectTimeout();
 	private int heartbeatSocketTimeout = DEFAULT_MONGO_OPTIONS.getHeartbeatSocketTimeout();
 	private String requiredReplicaSetName = DEFAULT_MONGO_OPTIONS.getRequiredReplicaSetName();
-	private int serverSelectionTimeout = -1;
+	private int serverSelectionTimeout = Integer.MIN_VALUE;
 
 	private boolean ssl;
 	private SSLSocketFactory sslSocketFactory;
 
 	/**
 	 * Set the {@link MongoClient} description.
-	 * 
+	 *
 	 * @param description
 	 */
 	public void setDescription(String description) {
@@ -80,7 +80,7 @@ public void setDescription(String description) {
 
 	/**
 	 * Set the minimum number of connections per host.
-	 * 
+	 *
 	 * @param minConnectionsPerHost
 	 */
 	public void setMinConnectionsPerHost(int minConnectionsPerHost) {
@@ -90,7 +90,7 @@ public void setMinConnectionsPerHost(int minConnectionsPerHost) {
 	/**
 	 * Set the number of connections allowed per host. Will block if run out. Default is 10. System property
 	 * {@code MONGO.POOLSIZE} can override
-	 * 
+	 *
 	 * @param connectionsPerHost
 	 */
 	public void setConnectionsPerHost(int connectionsPerHost) {
@@ -101,7 +101,7 @@ public void setConnectionsPerHost(int connectionsPerHost) {
 	 * Set the multiplier for connectionsPerHost for # of threads that can block. Default is 5. If connectionsPerHost is
 	 * 10, and threadsAllowedToBlockForConnectionMultiplier is 5, then 50 threads can block more than that and an
 	 * exception will be thrown.
-	 * 
+	 *
 	 * @param threadsAllowedToBlockForConnectionMultiplier
 	 */
 	public void setThreadsAllowedToBlockForConnectionMultiplier(int threadsAllowedToBlockForConnectionMultiplier) {
@@ -110,7 +110,7 @@ public void setThreadsAllowedToBlockForConnectionMultiplier(int threadsAllowedTo
 
 	/**
 	 * Set the max wait time of a blocking thread for a connection. Default is 12000 ms (2 minutes)
-	 * 
+	 *
 	 * @param maxWaitTime
 	 */
 	public void setMaxWaitTime(int maxWaitTime) {
@@ -119,7 +119,7 @@ public void setMaxWaitTime(int maxWaitTime) {
 
 	/**
 	 * The maximum idle time for a pooled connection.
-	 * 
+	 *
 	 * @param maxConnectionIdleTime
 	 */
 	public void setMaxConnectionIdleTime(int maxConnectionIdleTime) {
@@ -128,7 +128,7 @@ public void setMaxConnectionIdleTime(int maxConnectionIdleTime) {
 
 	/**
 	 * Set the maximum life time for a pooled connection.
-	 * 
+	 *
 	 * @param maxConnectionLifeTime
 	 */
 	public void setMaxConnectionLifeTime(int maxConnectionLifeTime) {
@@ -137,7 +137,7 @@ public void setMaxConnectionLifeTime(int maxConnectionLifeTime) {
 
 	/**
 	 * Set the connect timeout in milliseconds. 0 is default and infinite.
-	 * 
+	 *
 	 * @param connectTimeout
 	 */
 	public void setConnectTimeout(int connectTimeout) {
@@ -146,7 +146,7 @@ public void setConnectTimeout(int connectTimeout) {
 
 	/**
 	 * Set the socket timeout. 0 is default and infinite.
-	 * 
+	 *
 	 * @param socketTimeout
 	 */
 	public void setSocketTimeout(int socketTimeout) {
@@ -155,7 +155,7 @@ public void setSocketTimeout(int socketTimeout) {
 
 	/**
 	 * Set the keep alive flag, controls whether or not to have socket keep alive timeout. Defaults to false.
-	 * 
+	 *
 	 * @param socketKeepAlive
 	 */
 	public void setSocketKeepAlive(boolean socketKeepAlive) {
@@ -164,7 +164,7 @@ public void setSocketKeepAlive(boolean socketKeepAlive) {
 
 	/**
 	 * Set the {@link ReadPreference}.
-	 * 
+	 *
 	 * @param readPreference
 	 */
 	public void setReadPreference(ReadPreference readPreference) {
@@ -174,7 +174,7 @@ public void setReadPreference(ReadPreference readPreference) {
 	/**
 	 * Set the {@link WriteConcern} that will be the default value used when asking the {@link MongoDbFactory} for a DB
 	 * object.
-	 * 
+	 *
 	 * @param writeConcern
 	 */
 	public void setWriteConcern(WriteConcern writeConcern) {
@@ -190,7 +190,7 @@ public void setSocketFactory(SocketFactory socketFactory) {
 
 	/**
 	 * Set the frequency that the driver will attempt to determine the current state of each server in the cluster.
-	 * 
+	 *
 	 * @param heartbeatFrequency
 	 */
 	public void setHeartbeatFrequency(int heartbeatFrequency) {
@@ -200,7 +200,7 @@ public void setHeartbeatFrequency(int heartbeatFrequency) {
 	/**
 	 * In the event that the driver has to frequently re-check a server's availability, it will wait at least this long
 	 * since the previous check to avoid wasted effort.
-	 * 
+	 *
 	 * @param minHeartbeatFrequency
 	 */
 	public void setMinHeartbeatFrequency(int minHeartbeatFrequency) {
@@ -209,7 +209,7 @@ public void setMinHeartbeatFrequency(int minHeartbeatFrequency) {
 
 	/**
 	 * Set the connect timeout for connections used for the cluster heartbeat.
-	 * 
+	 *
 	 * @param heartbeatConnectTimeout
 	 */
 	public void setHeartbeatConnectTimeout(int heartbeatConnectTimeout) {
@@ -218,7 +218,7 @@ public void setHeartbeatConnectTimeout(int heartbeatConnectTimeout) {
 
 	/**
 	 * Set the socket timeout for connections used for the cluster heartbeat.
-	 * 
+	 *
 	 * @param heartbeatSocketTimeout
 	 */
 	public void setHeartbeatSocketTimeout(int heartbeatSocketTimeout) {
@@ -227,7 +227,7 @@ public void setHeartbeatSocketTimeout(int heartbeatSocketTimeout) {
 
 	/**
 	 * Configures the name of the replica set.
-	 * 
+	 *
 	 * @param requiredReplicaSetName
 	 */
 	public void setRequiredReplicaSetName(String requiredReplicaSetName) {
@@ -236,7 +236,7 @@ public void setRequiredReplicaSetName(String requiredReplicaSetName) {
 
 	/**
 	 * This controls if the driver should us an SSL connection. Defaults to |@literal false}.
-	 * 
+	 *
 	 * @param ssl
 	 */
 	public void setSsl(boolean ssl) {
@@ -246,7 +246,7 @@ public void setSsl(boolean ssl) {
 	/**
 	 * Set the {@link SSLSocketFactory} to use for the {@literal SSL} connection. If none is configured here,
 	 * {@link SSLSocketFactory#getDefault()} will be used.
-	 * 
+	 *
 	 * @param sslSocketFactory
 	 */
 	public void setSslSocketFactory(SSLSocketFactory sslSocketFactory) {
@@ -255,7 +255,8 @@ public void setSslSocketFactory(SSLSocketFactory sslSocketFactory) {
 
 	/**
 	 * Set the {@literal server selection timeout} in msec for a 3.x MongoDB Java driver. If not set the default value of
-	 * 30 sec will be used.
+	 * 30 sec will be used. A value of 0 means that it will timeout immediately if no server is available. A negative
+	 * value means to wait indefinitely.
 	 *
 	 * @param serverSelectionTimeout in msec.
 	 */
@@ -275,7 +276,7 @@ protected MongoClientOptions createInstance() throws Exception {
 
 		MongoClientOptions.Builder builder = MongoClientOptions.builder();
 
-		if (MongoClientVersion.isMongo3Driver() && serverSelectionTimeout > 0) {
+		if (MongoClientVersion.isMongo3Driver() && serverSelectionTimeout != Integer.MIN_VALUE) {
 			new DirectFieldAccessor(builder).setPropertyValue("serverSelectionTimeout", serverSelectionTimeout);
 		}
 

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/config/MongoClientParserIntegrationTests.java

@@ -39,7 +39,7 @@
 
 /**
  * Integration tests for {@link MongoClientParser}.
- * 
+ *
  * @author Christoph Strobl
  */
 public class MongoClientParserIntegrationTests {
@@ -118,7 +118,7 @@ public void createsMongoClientWithCredentialsCorrectly() {
 	}
 
 	@Test // DATAMONGO-1620
-	public void createsMongoClinetWithServerSelectionTimeoutCorrectly() {
+	public void createsMongoClientWithServerSelectionTimeoutCorrectly() {
 
 		assumeThat(MongoClientVersion.isMongo3Driver(), is(true));