com.allanbank.mongodb

Class MongoDbUri

java.lang.Object

com.allanbank.mongodb.MongoDbUri

public class MongoDbUri
extends Object

MongoDbUri provides the ability to parse a MongoDB URI into fields.

The set of possible options is a combination of the standard MongoDB URI options and the complete set of fields supported by the MongoClientConfiguration class. The driver uses the Java beans standard to define the label for each field.

See the Connection String documentation for information on the standard options. The following standard options are not supported by the driver:

replicaSet

The driver does automatic cluster type discovery so this options is not needed or used.

maxIdleTimeMS

The driver does not use a specific wait time. Instead the connection is considered idle when it experiences a defined number of idle ticks. A tick is defined by the readTimeout and the number of ticks is defined by maxIdleTickCount.

waitQueueMultiple

The driver does not queue requests waiting for a socket since it is asynchronous. The closest option would be the maxPendingOperationsPerConnection which can be used to control how aggressively the driver will apply back pressure.

waitQueueTimeoutMS

Similar to waitQueueMultiple this option does not make sense for an asynchronous driver.

uuidRepresentation

The UUID representation can only be controlled via construction. See the UuidElement.UuidElement(String, byte, java.util.UUID) and UuidElement.LEGACY_UUID_SUBTTYPE.

The current set of auto-mapped fields is listed below. See the linked documentation for details on the fields values.

• autoDiscoverServers
• connectionModel
• connectTimeout
• lockType
• maxCachedStringEntries
• maxCachedStringLength
• maxConnectionCount
• maxIdleTickCount
• maxPendingOperationsPerConnection
• maxSecondaryLag
• minConnectionCount
• readTimeout
• reconnectTimeout
• usingSoKeepalive

Any credentials, default read preference, and default durability will also be determined via the URI. See the CredentialEditor, ReadPreferenceEditor, and DurabilityEditor for details

See Also:

MongoDB Connections

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2012-2014, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static String	MONGODB_URI_PREFIX The prefix for a MongoDB URI.
static String	MONGODBS_URI_PREFIX The prefix for a MongoDB URI that uses SSL.

Constructor Summary

Constructors

Constructor and Description
MongoDbUri(String mongoDbUri) Creates a new MongoDbUri.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDatabase() Returns the database contained in the URI.
List<String>	getHosts() Returns the hosts contained in the URI.
String	getOptions() Returns the options contained in the URI.
Map<String,String>	getParsedOptions() Returns the options contained in the URI parsed into a map of token values.
String	getPassword() Returns the password contained in the URI.
String	getUserName() Returns the user name contained in the URI.
List<String>	getValuesFor(String field) Returns the values for a single property.
static boolean	isUri(String mongoDbUri) Tests if the mongoDbUri starts with the correct prefix to be a MongoDB URI.
boolean	isUseSsl() Returns true if the URL uses the "mongodbs://" prefix.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MONGODB_URI_PREFIX

public static final String MONGODB_URI_PREFIX

The prefix for a MongoDB URI.

See Also:

Constant Field Values

MONGODBS_URI_PREFIX

public static final String MONGODBS_URI_PREFIX

The prefix for a MongoDB URI that uses SSL.

See Also:

Constant Field Values

Constructor Detail

MongoDbUri

public MongoDbUri(String mongoDbUri)
           throws IllegalArgumentException

Creates a new MongoDbUri.

Parameters:

mongoDbUri - The configuration for the connection to MongoDB expressed as a MongoDB URL.

Throws:

IllegalArgumentException - If the mongoDbUri is not a properly formated MongoDB style URL.

See Also:

MongoDB Connections

Method Detail

isUri

public static boolean isUri(String mongoDbUri)

Tests if the mongoDbUri starts with the correct prefix to be a MongoDB URI.

Parameters:

mongoDbUri - The presumed MongoDB URI.

Returns:

True if the mongoDbUri starts with "mongodb://" of "mongodbs://".

getDatabase

public String getDatabase()

Returns the database contained in the URI.

Returns:

The database contained in the URI.

getHosts

public List<String> getHosts()

Returns the hosts contained in the URI.

Returns:

The hosts contained in the URI.

getOptions

public String getOptions()

Returns the options contained in the URI. Will never be null bu may be an empty string.

Returns:

The options contained in the URI.

getParsedOptions

public Map<String,String> getParsedOptions()

Returns the options contained in the URI parsed into a map of token values.

Returns:

The options contained in the URI.

getPassword

public String getPassword()

Returns the password contained in the URI. May be null.

Returns:

The password contained in the URI.

getUserName

public String getUserName()

Returns the user name contained in the URI. May be null.

Returns:

The user name contained in the URI.

getValuesFor

public List<String> getValuesFor(String field)

Returns the values for a single property. This allows for duplicate values.

Parameters:

field - The field to return all values for.

Returns:

The options contained in the URI.

isUseSsl

public boolean isUseSsl()

Returns true if the URL uses the "mongodbs://" prefix.

Returns:

True if the URL uses the "mongodbs://" prefix.

toString

public String toString()

Overridden to return the string used to construct the URI.

Overrides:

toString in class Object