Package com.mongodb.connection

Class SslSettings.Builder

java.lang.Object

com.mongodb.connection.SslSettings.Builder

Enclosing class:

SslSettings

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

A builder for creating SSLSettings.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SslSettings.Builder	applyConnectionString(ConnectionString connectionString) Take the settings from the given ConnectionString and set them in this 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

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

Constructor Detail

Builder

public Builder()

Method Detail

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)

Take the settings from the given ConnectionString and set them in this builder.

Parameters:

connectionString - a URI with details on 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