Class ClusterSettings
- Since:
- 3.0
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A builder for the cluster settings. -
Method Summary
Modifier and TypeMethodDescriptionstatic ClusterSettings.Builder
builder()
Get a builder for this class.static ClusterSettings.Builder
builder
(ClusterSettings clusterSettings) Creates a builder instance.boolean
Gets the cluster listeners.getHosts()
Gets the seed list of hosts for the cluster.long
getLocalThreshold
(TimeUnit timeUnit) Gets the local threshold.getMode()
Gets the mode.Gets the required cluster type This setting is not used ifgetMode()
isClusterConnectionMode.LOAD_BALANCED
.Gets the required replica set name.long
getServerSelectionTimeout
(TimeUnit timeUnit) Gets the timeout to apply when selecting a server.Gets the server selector.Returns a short, pretty description for these ClusterSettings.Gets the host name from which to lookup SRV record for the seed listGets the maximum number of hosts to connect to when using SRV protocol.Gets the SRV service name.int
hashCode()
toString()
-
Method Details
-
builder
Get a builder for this class.- Returns:
- a new Builder for creating ClusterSettings.
-
builder
Creates a builder instance.- Parameters:
clusterSettings
- existing ClusterSettings to default the builder settings on.- Returns:
- a builder
- Since:
- 3.5
-
getSrvHost
Gets the host name from which to lookup SRV record for the seed list- Returns:
- the SRV host, or null if none specified
- Since:
- 3.10
-
getSrvMaxHosts
Gets the maximum number of hosts to connect to when using SRV protocol. This setting is not used ifgetMode()
isClusterConnectionMode.LOAD_BALANCED
.- Returns:
- the maximum number of hosts to connect to when using SRV protocol. Defaults to null.
- Since:
- 4.4
- See Also:
-
getSrvServiceName
Gets the SRV service name.The SRV resource record (RFC 2782) service name, which is limited to 15 characters (RFC 6335 section 5.1). It is combined with the host name specified by
getSrvHost()
as follows:_srvServiceName._tcp.hostName
. The combined string is an SRV resource record name (RFC 1035 section 2.3.1), which is limited to 255 characters (RFC 1035 section 2.3.4).- Returns:
- the SRV service name, which defaults to
"mongodb"
- Since:
- 4.5
- See Also:
-
getHosts
Gets the seed list of hosts for the cluster.- Returns:
- the seed list of hosts
-
getMode
Gets the mode.- Returns:
- the mode
-
getRequiredClusterType
Gets the required cluster type This setting is not used ifgetMode()
isClusterConnectionMode.LOAD_BALANCED
.- Returns:
- the required cluster type
- See Also:
-
getRequiredReplicaSetName
Gets the required replica set name. This setting is not used ifgetMode()
isClusterConnectionMode.LOAD_BALANCED
.- Returns:
- the required replica set name
- See Also:
-
getServerSelector
Gets the server selector.The server selector augments the normal server selection rules applied by the driver when determining which server to send an operation to. At the point that it's called by the driver, the
ClusterDescription
which is passed to it contains a list ofServerDescription
instances which satisfy either the configuredReadPreference
for any read operation or ones that can take writes (e.g. a standalone, mongos, or replica set primary), barring those corresponding to servers that the driver considers unavailable or potentially problematic.The server selector can then filter the
ServerDescription
list using whatever criteria that is required by the application.After this selector executes, three additional selectors are applied by the driver:
- select from within the latency window
- select at most two random servers from those remaining
- select the one with fewer outstanding concurrent operations
To skip the latency window selector, an application can:
- configure the local threshold to a sufficiently high value so that it doesn't exclude any servers
- return a list containing a single server from this selector (which will also make the random member selector a no-op)
- Returns:
- the server selector, which may be null
- See Also:
-
getServerSelectionTimeout
Gets the timeout to apply when selecting a server. If the timeout expires before a server is found to handle a request, aMongoTimeoutException
will be thrown. The default value is 30 seconds.A value of 0 means that it will timeout immediately if no server is available. A negative value means to wait indefinitely.
- Parameters:
timeUnit
- the time unit- Returns:
- the timeout in the given time unit
-
getLocalThreshold
Gets the local threshold. When choosing among multiple MongoDB servers to send a request, the MongoClient will only send that request to a server whose ping time is less than or equal to the server with the fastest ping time plus the local threshold.For example, let's say that the client is choosing a server to send a query when the read preference is
ReadPreference.secondary()
, and that there are three secondaries, server1, server2, and server3, whose ping times are 10, 15, and 16 milliseconds, respectively. With a local threshold of 5 milliseconds, the client will send the query to either server1 or server2 (randomly selecting between the two).Default is 15 milliseconds.
- Parameters:
timeUnit
- the time unit- Returns:
- the local threshold in the given timeunit.
- Since:
- 3.7
- MongoDB documentation
- Local Threshold
-
getClusterListeners
Gets the cluster listeners. The default value is an empty list.- Returns:
- the cluster listeners
- Since:
- 3.3
-
equals
-
hashCode
public int hashCode() -
toString
-
getShortDescription
Returns a short, pretty description for these ClusterSettings.- Returns:
- a String description of the relevant settings.
-