Package com.mongodb.connection

Class ProxySettings

java.lang.Object

com.mongodb.connection.ProxySettings

@Immutable
public final class ProxySettings
extends Object

This setting is only applicable when communicating with a MongoDB server using the synchronous variant of MongoClient.

This setting is furthermore ignored if:

• the communication is via Unix domain socket.
• a TransportSettings is MongoClientSettings.Builder.transportSettings(TransportSettings) configured}.

Since:

4.11

See Also:

• SocketSettings.getProxySettings()
• ClientEncryptionSettings.getKeyVaultMongoClientSettings()
• AutoEncryptionSettings.getKeyVaultMongoClientSettings()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ProxySettings.Builder	A builder for an instance of ProxySettings.

Method Summary

Modifier and Type	Method	Description
static ProxySettings.Builder	builder()	Creates a ProxySettings.Builder for creating a new ProxySettings instance.
static ProxySettings.Builder	builder(ProxySettings proxySettings)	Creates a ProxySettings.Builder for creating a new ProxySettings instance.
boolean	equals(Object o)
String	getHost()	Gets the SOCKS5 proxy host.
String	getPassword()	Gets the SOCKS5 proxy password.
int	getPort()	Gets the SOCKS5 proxy port.
String	getUsername()	Gets the SOCKS5 proxy username.
int	hashCode()
boolean	isProxyEnabled()	Checks if the SOCKS5 proxy is enabled.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

builder

public static ProxySettings.Builder builder()

Creates a ProxySettings.Builder for creating a new ProxySettings instance.

Returns:

a new ProxySettings.Builder for ProxySettings.

builder

public static ProxySettings.Builder builder(ProxySettings proxySettings)

Creates a ProxySettings.Builder for creating a new ProxySettings instance.

Parameters:

proxySettings - existing ProxySettings to default the builder settings on.

Returns:

a new ProxySettings.Builder for ProxySettings.

getHost

@Nullable
public String getHost()

Gets the SOCKS5 proxy host.

Returns:

the proxy host value. null if and only if the proxy functionality is not enabled.

See Also:

• ProxySettings.Builder.host(String)

getPort

public int getPort()

Gets the SOCKS5 proxy port.

Returns:

The port number of the SOCKS5 proxy. If a custom port has been set using ProxySettings.Builder.port(int), that custom port value is returned. Otherwise, the default SOCKS5 port 1080 is returned.

See Also:

• ProxySettings.Builder.port(int)

getUsername

@Nullable
public String getUsername()

Gets the SOCKS5 proxy username.

Returns:

the proxy username value.

See Also:

• ProxySettings.Builder.username(String)

getPassword

@Nullable
public String getPassword()

Gets the SOCKS5 proxy password.

Returns:

the proxy password value.

See Also:

• ProxySettings.Builder.password(String)

isProxyEnabled

public boolean isProxyEnabled()

Checks if the SOCKS5 proxy is enabled.

Returns:

true if the proxy is enabled, false otherwise.

See Also:

• ProxySettings.Builder.host(String)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object