Package com.mongodb.connection

Class ProxySettings.Builder

java.lang.Object

com.mongodb.connection.ProxySettings.Builder

Enclosing class:

ProxySettings

public static final class ProxySettings.Builder
extends Object

A builder for an instance of ProxySettings.

Method Summary

Modifier and Type	Method	Description
ProxySettings.Builder	applyConnectionString(ConnectionString connectionString)	Takes the proxy settings from the given ConnectionString and applies them to the ProxySettings.Builder.
ProxySettings.Builder	applySettings(ProxySettings proxySettings)	Applies the provided ProxySettings to this builder instance.
ProxySettings	build()	Build an instance of ProxySettings.
ProxySettings.Builder	host(String host)	Sets the SOCKS5 proxy host to establish a connection through.
ProxySettings.Builder	password(String password)	Sets the password for authenticating with the SOCKS5 proxy server.
ProxySettings.Builder	port(int port)	Sets the port number for the SOCKS5 proxy server.
ProxySettings.Builder	username(String username)	Sets the username for authenticating with the SOCKS5 proxy server.

Methods inherited from class java.lang.Object

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

Method Details

applySettings

public ProxySettings.Builder applySettings(ProxySettings proxySettings)

Applies the provided ProxySettings to this builder instance.

Note: This method overwrites all existing proxy settings previously configured in this builder.

Parameters:

proxySettings - The ProxySettings instance containing the proxy configuration to apply.

Returns:

This ProxySettings.Builder instance with the updated proxy settings applied.

Throws:

IllegalArgumentException - If the provided ProxySettings instance is null.

host

public ProxySettings.Builder host(String host)

Sets the SOCKS5 proxy host to establish a connection through.

The host can be specified as an IPv4 address (e.g., "192.168.1.1"), an IPv6 address (e.g., "2001:0db8:85a3:0000:0000:8a2e:0370:7334"), or a domain name (e.g., "proxy.example.com").

Parameters:

host - The SOCKS5 proxy host to set.

Returns:

This ProxySettings.Builder instance, configured with the specified proxy host.

Throws:

IllegalArgumentException - If the provided host is null or empty after trimming.

See Also:

• port(int)
• ProxySettings.getHost()

port

public ProxySettings.Builder port(int port)

Sets the port number for the SOCKS5 proxy server. The port should be a non-negative integer representing the port through which the SOCKS5 proxy connection will be established.

If a port is specified via this method, a corresponding host must be provided using the host(String) method.

If no port is provided, the default port 1080 will be used.

Parameters:

port - The port number to set for the SOCKS5 proxy server.

Returns:

This ProxySettings.Builder instance, configured with the specified proxy port.

Throws:

IllegalArgumentException - If the provided port is negative.

See Also:

• host(String)
• ProxySettings.getPort()

username

public ProxySettings.Builder username(String username)

Sets the username for authenticating with the SOCKS5 proxy server. The provided username should not be empty or null.

If a username is specified, the corresponding password and proxy host must also be specified using the password(String) and host(String) methods, respectively.

Parameters:

username - The username to set for proxy authentication.

Returns:

This ProxySettings.Builder instance, configured with the specified username.

Throws:

IllegalArgumentException - If the provided username is empty or null.

See Also:

• password(String)
• host(String)
• ProxySettings.getUsername()

password

public ProxySettings.Builder password(String password)

Sets the password for authenticating with the SOCKS5 proxy server. The provided password should not be empty or null.

If a password is specified, the corresponding username and proxy host must also be specified using the username(String) and host(String) methods, respectively.

Parameters:

password - The password to set for proxy authentication.

Returns:

This ProxySettings.Builder instance, configured with the specified password.

Throws:

IllegalArgumentException - If the provided password is empty or null.

See Also:

• username(String)
• host(String)
• ProxySettings.getPassword()

applyConnectionString

public ProxySettings.Builder applyConnectionString(ConnectionString connectionString)

Takes the proxy settings from the given ConnectionString and applies them to the ProxySettings.Builder.

Parameters:

connectionString - the connection string containing details of how to connect to proxy server.

Returns:

this.

See Also:

• ConnectionString.getProxyHost()
• ConnectionString.getProxyPort()
• ConnectionString.getProxyUsername()
• ConnectionString.getProxyPassword()

build

public ProxySettings build()

Build an instance of ProxySettings.

Returns:

the ProxySettings.