Package com.mongodb.connection

Class ServerSettings.Builder

java.lang.Object
com.mongodb.connection.ServerSettings.Builder
Enclosing class:
ServerSettings
@NotThreadSafe public static final class ServerSettings.Builder extends Object
A builder for the settings.

  • Method Details

    • applySettings

      public ServerSettings.Builder applySettings(ServerSettings serverSettings)
      Applies the serverSettings to the builder

      Note: Overwrites all existing settings

      Parameters:
      serverSettings - the serverSettings
      Returns:
      this
      Since:
      3.7

    • heartbeatFrequency

      public ServerSettings.Builder heartbeatFrequency(long heartbeatFrequency, TimeUnit timeUnit)
      Sets the frequency that the cluster monitor attempts to reach each server. The default value is 10 seconds.
      Parameters:
      heartbeatFrequency - the heartbeat frequency
      timeUnit - the time unit
      Returns:
      this

    • minHeartbeatFrequency

      public ServerSettings.Builder minHeartbeatFrequency(long minHeartbeatFrequency, TimeUnit timeUnit)
      Sets the minimum heartbeat frequency. 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. The default value is 500 milliseconds.
      Parameters:
      minHeartbeatFrequency - the minimum heartbeat frequency
      timeUnit - the time unit
      Returns:
      this

    • serverMonitoringMode

      public ServerSettings.Builder serverMonitoringMode(ServerMonitoringMode serverMonitoringMode)
      Sets the server monitoring mode, which defines the monitoring protocol to use. The default value is ServerMonitoringMode.AUTO.
      Parameters:
      serverMonitoringMode - The ServerMonitoringMode.
      Returns:
      this.
      Since:
      5.1
      See Also:

    • addServerListener

      public ServerSettings.Builder addServerListener(ServerListener serverListener)
      Add a server listener.
      Parameters:
      serverListener - the non-null server listener
      Returns:
      this
      Since:
      3.3

    • serverListenerList

      public ServerSettings.Builder serverListenerList(List<ServerListener> serverListeners)
      Sets the server listeners.
      Parameters:
      serverListeners - list of server listeners
      Returns:
      this
      Since:
      4.5

    • addServerMonitorListener

      public ServerSettings.Builder addServerMonitorListener(ServerMonitorListener serverMonitorListener)
      Adds a server monitor listener.
      Parameters:
      serverMonitorListener - the non-null server monitor listener
      Returns:
      this
      Since:
      3.3

    • serverMonitorListenerList

      public ServerSettings.Builder serverMonitorListenerList(List<ServerMonitorListener> serverMonitorListeners)
      Sets the server monitor listeners.
      Parameters:
      serverMonitorListeners - list of server monitor listeners
      Returns:
      this
      Since:
      4.5

    • applyConnectionString

      public ServerSettings.Builder applyConnectionString(ConnectionString connectionString)
      Takes the settings from the given ConnectionString and applies them to the builder
      Parameters:
      connectionString - the connection string containing details of how to connect to MongoDB
      Returns:
      this
      Since:
      3.3

    • build

      public ServerSettings build()
      Create a new ServerSettings from the settings applied to this builder.
      Returns:
      a ServerSettings with the given settings.