Package com.mongodb.connection

Class SslSettings

java.lang.Object

com.mongodb.connection.SslSettings

@Immutable
public class SslSettings
extends java.lang.Object

Settings for connecting to MongoDB via SSL.

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SslSettings.Builder	A builder for creating SSLSettings.

Method Summary

Modifier and Type	Method	Description
static SslSettings.Builder	builder()	Gets a Builder for creating a new SSLSettings instance.
static SslSettings.Builder	builder(SslSettings sslSettings)	Creates a builder instance.
boolean	equals(java.lang.Object o)
javax.net.ssl.SSLContext	getContext()	Gets the SSLContext configured for use with SSL connections.
int	hashCode()
boolean	isEnabled()	Returns whether SSL is enabled.
boolean	isInvalidHostNameAllowed()	Returns whether invalid host names should be allowed.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static SslSettings.Builder builder()

Gets a Builder for creating a new SSLSettings instance.

Returns:

a new Builder for SSLSettings.

builder

public static SslSettings.Builder builder(SslSettings sslSettings)

Creates a builder instance.

Parameters:

sslSettings - existing SslSettings to default the builder settings on.

Returns:

a builder

Since:

3.7

isEnabled

public boolean isEnabled()

Returns whether SSL is enabled.

Returns:

true if SSL is enabled.

isInvalidHostNameAllowed

public boolean isInvalidHostNameAllowed()

Returns whether invalid host names should be allowed. Defaults to false. Take care before setting this to true, as it makes the application susceptible to man-in-the-middle attacks.

Returns:

true if invalid host names are allowed.

getContext

public javax.net.ssl.SSLContext getContext()

Gets the SSLContext configured for use with SSL connections.

Returns:

the SSLContext, which defaults to null if not configured. In that case SSLContext.getDefault() will be used if SSL is enabled.

Since:

3.5

See Also:

SSLContext.getDefault()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object