com.mongodb.connection

Class SslSettings.Builder

java.lang.Object

com.mongodb.connection.SslSettings.Builder

Enclosing class:

SslSettings

@NotThreadSafe
public static final class SslSettings.Builder
extends java.lang.Object

A builder for creating SSLSettings.

Method Summary

Modifier and Type	Method and Description
SslSettings.Builder	applyConnectionString(ConnectionString connectionString) Takes the settings from the given ConnectionString and applies them to the builder
SslSettings.Builder	applySettings(SslSettings sslSettings) Applies the sslSettings to the builder
SslSettings	build() Create a new SSLSettings from the settings in this builder.
SslSettings.Builder	context(javax.net.ssl.SSLContext context) Sets the SSLContext for use when SSL is enabled.
SslSettings.Builder	enabled(boolean enabled) Define whether SSL should be enabled.
SslSettings.Builder	invalidHostNameAllowed(boolean invalidHostNameAllowed) Define whether invalid host names should be allowed.

Methods inherited from class java.lang.Object

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

Method Detail

applySettings

public SslSettings.Builder applySettings(SslSettings sslSettings)

Applies the sslSettings to the builder

Note: Overwrites all existing settings

Parameters:

sslSettings - the sslSettings

Returns:

this

Since:

3.7

enabled

public SslSettings.Builder enabled(boolean enabled)

Define whether SSL should be enabled.

Parameters:

enabled - should be true if SSL is to be enabled.

Returns:

this

invalidHostNameAllowed

public SslSettings.Builder invalidHostNameAllowed(boolean invalidHostNameAllowed)

Define 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.

Parameters:

invalidHostNameAllowed - whether invalid host names are allowed.

Returns:

this

context

public SslSettings.Builder context(javax.net.ssl.SSLContext context)

Sets the SSLContext for use when SSL is enabled.

Parameters:

context - the SSLContext to use for connections. Ignored if SSL is not enabled.

Returns:

this

Since:

3.5

applyConnectionString

public SslSettings.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

build

public SslSettings build()

Create a new SSLSettings from the settings in this builder.

Returns:

a new SSL settings

Throws:

MongoInternalException - if enabled is true, invalidHostNameAllowed is false, and the "java.version" system property starts with 1.6