org.eclipse.ditto.services.utils.config

Class MongoConfig

java.lang.Object

org.eclipse.ditto.services.utils.config.MongoConfig

public final class MongoConfig
extends Object

Constructs MongoDB URL from a source URL and configuration settings.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAX_QUERY_TIME Config key of maximum query duration.
static String	OPTIONS Config key of connection string options.
static String	POOL_JMX_LISTENER_ENABLED Whether a jmx connection pool listener should be added.
static String	POOL_MAX_SIZE Config key of maximum number of connections allowed.
static String	POOL_MAX_WAIT_QUEUE_SIZE Maximum number of waiters for a connection to become available from the pool.
static String	POOL_MAX_WAIT_TIME Maximum number of seconds a thread waits for a connection to become available.
static String	SSL_ENABLED config key for mongodb ssl options.
static String	URI Config key of source MongoDB URI.

Method Summary

Modifier and Type	Method and Description
static boolean	getJmxListenerEnabled(com.typesafe.config.Config config) Whether a JMX ConnectionPoolListener should be added.
static Duration	getMaxQueryTime(com.typesafe.config.Config config) Retrieve maximum query duration.
static String	getMongoUri(com.typesafe.config.Config config) Computes MongoDB URI from configured source URI and MongoDB settings.
static int	getPoolMaxSize(com.typesafe.config.Config config) Retrieve the maximum number of connections in the connection pool.
static int	getPoolMaxWaitQueueSize(com.typesafe.config.Config config) Retrieve the maximum number of threads waiting for a connection to become available.
static Duration	getPoolMaxWaitTime(com.typesafe.config.Config config) Retrieve the maximum time to wait for a connection to become available.
static boolean	getSSLEnabled(com.typesafe.config.Config config) Retrieve the ssl option
static boolean	isUriDefined(com.typesafe.config.Config config) Tests whether Mongo URI is defined in configuration.

Methods inherited from class java.lang.Object

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

Field Detail

URI

public static final String URI

Config key of source MongoDB URI.

See Also:

Constant Field Values

OPTIONS

public static final String OPTIONS

Config key of connection string options.

See Also:

Constant Field Values

MAX_QUERY_TIME

public static final String MAX_QUERY_TIME

Config key of maximum query duration. It is up to the Mongo client to respect it.

See Also:

Constant Field Values

POOL_MAX_SIZE

public static final String POOL_MAX_SIZE

Config key of maximum number of connections allowed.

See Also:

Constant Field Values

POOL_MAX_WAIT_QUEUE_SIZE

public static final String POOL_MAX_WAIT_QUEUE_SIZE

Maximum number of waiters for a connection to become available from the pool.

See Also:

Constant Field Values

POOL_MAX_WAIT_TIME

public static final String POOL_MAX_WAIT_TIME

Maximum number of seconds a thread waits for a connection to become available.

See Also:

Constant Field Values

POOL_JMX_LISTENER_ENABLED

public static final String POOL_JMX_LISTENER_ENABLED

Whether a jmx connection pool listener should be added.

See Also:

Constant Field Values

SSL_ENABLED

public static final String SSL_ENABLED

config key for mongodb ssl options.

See Also:

Constant Field Values

Method Detail

getMaxQueryTime

public static Duration getMaxQueryTime(com.typesafe.config.Config config)

Retrieve maximum query duration.

Parameters:

config - The configuration.

Returns:

The maximum query duration.

getPoolMaxSize

public static int getPoolMaxSize(com.typesafe.config.Config config)

Retrieve the maximum number of connections in the connection pool.

Parameters:

config - The configuration.

Returns:

The maximum number of connections.

getPoolMaxWaitQueueSize

public static int getPoolMaxWaitQueueSize(com.typesafe.config.Config config)

Retrieve the maximum number of threads waiting for a connection to become available.

Parameters:

config - The configuration.

Returns:

The maximum number of waiting threads.

getPoolMaxWaitTime

public static Duration getPoolMaxWaitTime(com.typesafe.config.Config config)

Retrieve the maximum time to wait for a connection to become available.

Parameters:

config - The configuration.

Returns:

The maximum wait time.

getJmxListenerEnabled

public static boolean getJmxListenerEnabled(com.typesafe.config.Config config)

Whether a JMX ConnectionPoolListener should be added.

Parameters:

config - The configuration.

Returns:

whether the JMXConnectionPoolListener should be added.

getSSLEnabled

public static boolean getSSLEnabled(com.typesafe.config.Config config)

Retrieve the ssl option

Parameters:

config - The configuration.

Returns:

whether ssl is enabled or not.

getMongoUri

public static String getMongoUri(com.typesafe.config.Config config)

Computes MongoDB URI from configured source URI and MongoDB settings.

Parameters:

config - Config object containing source URI and MongoDB settings.

Returns:

URI adapted from source URI with parameters set according to MongoDB settings.

isUriDefined

public static boolean isUriDefined(com.typesafe.config.Config config)

Tests whether Mongo URI is defined in configuration.

Parameters:

config - The configuration object.

Returns:

Whether Mongo URI is defined.