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.

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-2013, 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.

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.
String	getPassword() Returns the password contained in the URI.
String	getUserName() Returns the user name contained in the URI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

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

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.

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.