com.allanbank.mongodb.client

Class MongoDatabaseImpl

java.lang.Object

com.allanbank.mongodb.client.MongoDatabaseImpl

All Implemented Interfaces:

MongoDatabase

public class MongoDatabaseImpl
extends Object
implements MongoDatabase

Implementation of the MongoDatabase interface.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

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

Field Summary

Fields

Modifier and Type	Field and Description
static Document	EMPTY_QUERY An empty query document.
protected Client	myClient The client for interacting with MongoDB.

Fields inherited from interface com.allanbank.mongodb.MongoDatabase

ADMIN_NAME, CONFIG_NAME, LOCAL_NAME, TEST_NAME

Constructor Summary

Constructors

Constructor and Description
MongoDatabaseImpl(MongoClient mongoClient, Client client, String name) Create a new MongoDatabaseClient.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addOptions(String command, DocumentAssignable options, DocumentBuilder builder) Adds the options to the document builder.
boolean	createCappedCollection(String name, long size) Creates the capped collection with the specified name and size on the server.
boolean	createCollection(String name, DocumentAssignable options) Creates the collection with the specified name on the server.
boolean	drop() Drops the database.
boolean	exists() Returns true if this database already exists on the server.
MongoCollection	getCollection(String name) Returns the MongoCollection with the specified name.
Durability	getDurability() Returns the durability for write operations sent to the server from this MongoDatabase instance.
protected LockType	getLockType() Returns the type of lock to use.
String	getName() Returns the name of the database.
ProfilingStatus	getProfilingStatus() Retrieves the profiling level for the database.
ReadPreference	getReadPreference() Returns the read preference for queries from this MongoDatabase instance.
List<String>	listCollectionNames() Returns the list of the collections contained within the database.
List<String>	listCollections() Deprecated.
Document	runAdminCommand(String command) Runs an administrative command against the 'admin' database.
Document	runAdminCommand(String command, DocumentAssignable options) Runs an administrative command against the 'admin' database.
Document	runAdminCommand(String commandName, String commandValue, DocumentAssignable options) Runs an administrative command against the 'admin' database.
Document	runCommand(DocumentAssignable command) Runs a command against the database.
Document	runCommand(String command) Runs a command against the database.
Document	runCommand(String command, DocumentAssignable options) Runs a command against the database.
Document	runCommand(String commandName, int commandValue, DocumentAssignable options) Runs a command against the database.
Document	runCommand(String commandName, String commandValue, DocumentAssignable options) Runs a command against the database.
void	runCommandAsync(Callback<Document> reply, DocumentAssignable command) Runs a command against the database.
void	runCommandAsync(Callback<Document> reply, DocumentAssignable command, Version requireServerVersion) Runs a command against the database.
void	runCommandAsync(Callback<Document> reply, String command) Runs a command against the database.
void	runCommandAsync(Callback<Document> reply, String command, DocumentAssignable options) Runs a command against the database.
void	runCommandAsync(Callback<Document> reply, String commandName, int commandValue, DocumentAssignable options) Runs a command against the database.
void	runCommandAsync(Callback<Document> reply, String commandName, String commandValue, DocumentAssignable options) Runs a command against the database.
ListenableFuture<Document>	runCommandAsync(DocumentAssignable command) Runs a command against the database.
void	runCommandAsync(LambdaCallback<Document> reply, DocumentAssignable command) Runs a command against the database.
void	runCommandAsync(LambdaCallback<Document> reply, DocumentAssignable command, Version requiredServerVersion) Runs a command against the database.
void	runCommandAsync(LambdaCallback<Document> reply, String command) Runs a command against the database.
void	runCommandAsync(LambdaCallback<Document> reply, String command, DocumentAssignable options) Runs a command against the database.
void	runCommandAsync(LambdaCallback<Document> reply, String commandName, int commandValue, DocumentAssignable options) Runs a command against the database.
void	runCommandAsync(LambdaCallback<Document> reply, String commandName, String commandValue, DocumentAssignable options) Runs a command against the database.
ListenableFuture<Document>	runCommandAsync(String command) Runs a command against the database.
ListenableFuture<Document>	runCommandAsync(String command, DocumentAssignable options) Runs a command against the database.
ListenableFuture<Document>	runCommandAsync(String commandName, int commandValue, DocumentAssignable options) Runs a command against the database.
ListenableFuture<Document>	runCommandAsync(String commandName, String commandValue, DocumentAssignable options) Runs a command against the database.
void	setDurability(Durability durability) Sets the durability for write operations from this MongoDatabase instance.
boolean	setProfilingStatus(ProfilingStatus profileLevel) Sets the profiling level for the database.
void	setReadPreference(ReadPreference readPreference) Sets the value of the read preference for a queries from this MongoDatabase instance.
Document	stats() Returns the statistics for the database.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_QUERY

public static final Document EMPTY_QUERY

An empty query document.

myClient

protected final Client myClient

The client for interacting with MongoDB.

Constructor Detail

MongoDatabaseImpl

public MongoDatabaseImpl(MongoClient mongoClient,
                 Client client,
                 String name)

Create a new MongoDatabaseClient.

Parameters:

mongoClient - The MongoClient.

client - The client for interacting with MongoDB.

name - The name of the database we interact with.

Method Detail

createCappedCollection

public boolean createCappedCollection(String name,
                             long size)
                               throws MongoDbException

Creates the capped collection with the specified name and size on the server.

Issues a command to create the collection with the specified name and options.

Specified by:

createCappedCollection in interface MongoDatabase

Parameters:

name - The name of the collection.

size - The size of the collection in bytes.

Returns:

True if the collection was created, false otherwise (including it already exists).

Throws:

MongoDbException - On a failure to create the collection.

createCollection

public boolean createCollection(String name,
                       DocumentAssignable options)
                         throws MongoDbException

Creates the collection with the specified name on the server.

Issues a command to create the collection with the specified name and options.

Specified by:

createCollection in interface MongoDatabase

Parameters:

name - The name of the collection.

options - The options for the collection being created.

Returns:

True if the collection was created, false otherwise (including it already exists).

Throws:

MongoDbException - On a failure to create the collection.

drop

public boolean drop()

Drops the database.

Overridden to issue a "dropDatabase" command.

Specified by:

drop in interface MongoDatabase

Returns:

True if the database was successfully dropped, false otherwise.

See Also:

MongoDatabase.drop()

exists

public boolean exists()

Returns true if this database already exists on the server.

This method is simply a helper name to check if this database's name appears in the parent client's list of databases.

Specified by:

exists in interface MongoDatabase

Returns:

True if the parent client's returns this database's name in its list of database's names.

getCollection

public MongoCollection getCollection(String name)

Returns the MongoCollection with the specified name. This method does not validate that the collection already exists in the MongoDB database.

Overridden to create a new SynchronousMongoCollectionImpl.

Specified by:

getCollection in interface MongoDatabase

Parameters:

name - The name of the collection.

Returns:

The MongoCollection.

See Also:

MongoDatabase.getCollection(String)

getDurability

public Durability getDurability()

Returns the durability for write operations sent to the server from this MongoDatabase instance.

Defaults to the Durability from the Mongo's configuration.

Specified by:

getDurability in interface MongoDatabase

Returns:

The durability for write operations on the server.

See Also:

MongoClientConfiguration.getDefaultDurability()

getName

public String getName()

Returns the name of the database.

Specified by:

getName in interface MongoDatabase

Returns:

The name of the database.

getProfilingStatus

public ProfilingStatus getProfilingStatus()
                                   throws MongoDbException

Retrieves the profiling level for the database.

Overridden to query the system.namespace collection for the names of all of the collections.

Specified by:

getProfilingStatus in interface MongoDatabase

Returns:

The current profiling level.

Throws:

MongoDbException - On a failure to create the collection.

See Also:

MongoDatabase.getProfilingStatus()

getReadPreference

public ReadPreference getReadPreference()

Returns the read preference for queries from this MongoDatabase instance.

Defaults to ReadPreference from the Mongo's configuration.

Specified by:

getReadPreference in interface MongoDatabase

Returns:

The default read preference for a query.

See Also:

MongoClientConfiguration.getDefaultReadPreference()

listCollectionNames

public List<String> listCollectionNames()

Returns the list of the collections contained within the database.

Overridden to query the system.namespace collection for the names of all of the collections.

Specified by:

listCollectionNames in interface MongoDatabase

Returns:

The list of the collections contained within the database.

See Also:

MongoDatabase.listCollectionNames()

listCollections

@Deprecated
public List<String> listCollections()

Deprecated.

Returns the list of the collections contained within the database.

Overridden to query the system.namespace collection for the names of all of the collections.

Specified by:

listCollections in interface MongoDatabase

Returns:

The list of the collections contained within the database.

See Also:

MongoDatabase.listCollectionNames()

runAdminCommand

public Document runAdminCommand(String command)
                         throws MongoDbException

Runs an administrative command against the 'admin' database.

Overridden to call runCommand(String) on the 'admin' database.

Specified by:

runAdminCommand in interface MongoDatabase

Parameters:

command - The name of the command to run.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

See Also:

runCommandAsync(String, DocumentAssignable)

runAdminCommand

public Document runAdminCommand(String command,
                       DocumentAssignable options)
                         throws MongoDbException

Runs an administrative command against the 'admin' database.

Overridden to call the runCommandAsync(String, DocumentAssignable) method.

Specified by:

runAdminCommand in interface MongoDatabase

Parameters:

command - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

See Also:

runCommandAsync(String, DocumentAssignable)

runAdminCommand

public Document runAdminCommand(String commandName,
                       String commandValue,
                       DocumentAssignable options)
                         throws MongoDbException

Runs an administrative command against the 'admin' database.

Overridden to call the runCommandAsync(String, String, DocumentAssignable) method.

Specified by:

runAdminCommand in interface MongoDatabase

Parameters:

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

See Also:

runCommandAsync(String, String, DocumentAssignable)

runCommand

public Document runCommand(DocumentAssignable command)
                    throws MongoDbException

Runs a command against the database.

Overridden to call the runCommandAsync(DocumentAssignable) method.

Specified by:

runCommand in interface MongoDatabase

Parameters:

command - The command document to run.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

See Also:

runCommandAsync(DocumentAssignable)

runCommand

public Document runCommand(String command)
                    throws MongoDbException

Runs a command against the database.

Overridden to call the runCommandAsync(String, DocumentAssignable) method with null options.

Specified by:

runCommand in interface MongoDatabase

Parameters:

command - The name of the command to run.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

See Also:

runCommandAsync(String, DocumentAssignable)

runCommand

public Document runCommand(String command,
                  DocumentAssignable options)
                    throws MongoDbException

Runs a command against the database.

Overridden to call the runCommandAsync(String, DocumentAssignable) method.

Specified by:

runCommand in interface MongoDatabase

Parameters:

command - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

See Also:

runCommandAsync(String, DocumentAssignable)

runCommand

public Document runCommand(String commandName,
                  int commandValue,
                  DocumentAssignable options)
                    throws MongoDbException

Runs a command against the database.

Overridden to call the runCommandAsync(String, int, DocumentAssignable) method.

Specified by:

runCommand in interface MongoDatabase

Parameters:

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

See Also:

runCommandAsync(String, int, DocumentAssignable)

runCommand

public Document runCommand(String commandName,
                  String commandValue,
                  DocumentAssignable options)
                    throws MongoDbException

Runs a command against the database.

Overridden to call the runCommandAsync(String, String, DocumentAssignable) method.

Specified by:

runCommand in interface MongoDatabase

Parameters:

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

See Also:

runCommandAsync(String, String, DocumentAssignable)

runCommandAsync

public void runCommandAsync(Callback<Document> reply,
                   DocumentAssignable command)
                     throws MongoDbException

Runs a command against the database.

Overridden to call the runCommandAsync(Callback, DocumentAssignable, Version) method with null as the version.

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

reply - Callback that will be notified of the command results.

command - The command document to run.

Throws:

MongoDbException - On an error issuing the command or in running the command

See Also:

runCommandAsync(Callback, DocumentAssignable, Version)

runCommandAsync

public void runCommandAsync(Callback<Document> reply,
                   DocumentAssignable command,
                   Version requireServerVersion)
                     throws MongoDbException

Runs a command against the database.

Overridden to build a Command message and send it to the server.

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

reply - Callback that will be notified of the command results.

command - The command document to run.

requireServerVersion - The minimum required server version to support the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

public void runCommandAsync(Callback<Document> reply,
                   String command)
                     throws MongoDbException

Runs a command against the database.

Overridden to call the runCommandAsync(Callback, String, DocumentAssignable) method with null for the options.

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

reply - Callback that will be notified of the command results.

command - The name of the command to run.

Throws:

MongoDbException - On an error issuing the command or in running the command

See Also:

runCommandAsync(Callback, String, DocumentAssignable)

runCommandAsync

public void runCommandAsync(Callback<Document> reply,
                   String command,
                   DocumentAssignable options)
                     throws MongoDbException

Runs a command against the database.

Overridden to build the command document and call runCommandAsync(Callback, DocumentAssignable).

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

reply - Callback that will be notified of the command results.

command - The name of the command to run.

options - Optional (may be null) options for the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

public void runCommandAsync(Callback<Document> reply,
                   String commandName,
                   int commandValue,
                   DocumentAssignable options)
                     throws MongoDbException

Runs a command against the database.

Overridden to build the command document and call runCommandAsync(Callback, DocumentAssignable).

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

reply - Callback that will be notified of the command results.

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

public void runCommandAsync(Callback<Document> reply,
                   String commandName,
                   String commandValue,
                   DocumentAssignable options)
                     throws MongoDbException

Runs a command against the database.

Overridden to build the command document and call runCommandAsync(Callback, DocumentAssignable).

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

reply - Callback that will be notified of the command results.

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

public ListenableFuture<Document> runCommandAsync(DocumentAssignable command)
                                           throws MongoDbException

Runs a command against the database.

Overridden to call the runCommandAsync(Callback, DocumentAssignable) method.

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

command - The command document to run.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

See Also:

runCommandAsync(Callback, DocumentAssignable)

runCommandAsync

public void runCommandAsync(LambdaCallback<Document> reply,
                   DocumentAssignable command)
                     throws MongoDbException

Runs a command against the database.

Overridden to call runCommandAsync(Callback, DocumentAssignable) with an adapter for the LambdaCallback.

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

reply - LambdaCallback that will be notified of the command results.

command - The command document to run.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

public void runCommandAsync(LambdaCallback<Document> reply,
                   DocumentAssignable command,
                   Version requiredServerVersion)
                     throws MongoDbException

Runs a command against the database.

Overridden to call runCommandAsync(Callback, DocumentAssignable, Version) with an adapter for the LambdaCallback.

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

reply - LambdaCallback that will be notified of the command results.

command - The command document to run.

requiredServerVersion - The minimum required server version to support the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

public void runCommandAsync(LambdaCallback<Document> reply,
                   String command)
                     throws MongoDbException

Runs a command against the database.

Overridden to call runCommandAsync(Callback, String) with an adapter for the LambdaCallback.

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

reply - LambdaCallback that will be notified of the command results.

command - The name of the command to run.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

public void runCommandAsync(LambdaCallback<Document> reply,
                   String command,
                   DocumentAssignable options)
                     throws MongoDbException

Runs a command against the database.

Overridden to call runCommandAsync(Callback, String, DocumentAssignable) with an adapter for the LambdaCallback.

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

reply - LambdaCallback that will be notified of the command results.

command - The name of the command to run.

options - Optional (may be null) options for the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

public void runCommandAsync(LambdaCallback<Document> reply,
                   String commandName,
                   int commandValue,
                   DocumentAssignable options)
                     throws MongoDbException

Runs a command against the database.

Overridden to call runCommandAsync(Callback, String, int, DocumentAssignable) with an adapter for the LambdaCallback.

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

reply - LambdaCallback that will be notified of the command results.

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

public void runCommandAsync(LambdaCallback<Document> reply,
                   String commandName,
                   String commandValue,
                   DocumentAssignable options)
                     throws MongoDbException

Runs a command against the database.

Overridden to call runCommandAsync(Callback, String, String, DocumentAssignable) with an adapter for the LambdaCallback.

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

reply - LambdaCallback that will be notified of the command results.

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

public ListenableFuture<Document> runCommandAsync(String command)
                                           throws MongoDbException

Runs a command against the database.

Overridden to call the runCommandAsync(Callback, String, DocumentAssignable) method with null options.

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

command - The name of the command to run.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

See Also:

runCommandAsync(Callback, String, DocumentAssignable)

runCommandAsync

public ListenableFuture<Document> runCommandAsync(String command,
                                         DocumentAssignable options)
                                           throws MongoDbException

Runs a command against the database.

Overridden to call the runCommandAsync(Callback, String, DocumentAssignable) method.

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

command - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

See Also:

runCommandAsync(Callback, String, DocumentAssignable)

runCommandAsync

public ListenableFuture<Document> runCommandAsync(String commandName,
                                         int commandValue,
                                         DocumentAssignable options)
                                           throws MongoDbException

Runs a command against the database.

Overridden to call the runCommandAsync(Callback, String, int, DocumentAssignable) method.

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

See Also:

runCommandAsync(Callback, String, int, DocumentAssignable)

runCommandAsync

public ListenableFuture<Document> runCommandAsync(String commandName,
                                         String commandValue,
                                         DocumentAssignable options)
                                           throws MongoDbException

Runs a command against the database.

Overridden to call the runCommandAsync(Callback, String, String, DocumentAssignable) method.

Specified by:

runCommandAsync in interface MongoDatabase

Parameters:

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

See Also:

runCommandAsync(Callback, String, String, DocumentAssignable)

setDurability

public void setDurability(Durability durability)

Sets the durability for write operations from this MongoDatabase instance.

Defaults to the Durability from the Mongo's configuration if set to null.

Specified by:

setDurability in interface MongoDatabase

Parameters:

durability - The durability for write operations on the server.

See Also:

MongoClientConfiguration.getDefaultDurability()

setProfilingStatus

public boolean setProfilingStatus(ProfilingStatus profileLevel)
                           throws MongoDbException

Sets the profiling level for the database.

Overridden to update the databases profile level.

Specified by:

setProfilingStatus in interface MongoDatabase

Parameters:

profileLevel - The desired profiling level

Returns:

True if the profiling level was changed. Note if the level provided matches the profiling level already set then this method returns false.

Throws:

MongoDbException - On a failure to create the collection.

See Also:

MongoDatabase.setProfilingStatus(com.allanbank.mongodb.ProfilingStatus)

setReadPreference

public void setReadPreference(ReadPreference readPreference)

Sets the value of the read preference for a queries from this MongoDatabase instance.

Defaults to the ReadPreference from the Mongo's configuration if set to null.

Specified by:

setReadPreference in interface MongoDatabase

Parameters:

readPreference - The read preference for a query.

See Also:

MongoClientConfiguration.getDefaultReadPreference()

stats

public Document stats()
               throws MongoDbException

Returns the statistics for the database.

Overridden to send a dbStats command to the MongoDB server.

Specified by:

stats in interface MongoDatabase

Returns:

The results document with the database statistics.

Throws:

MongoDbException - On an error collecting the database statistics.

See Also:

MongoDatabase.stats()

addOptions

protected void addOptions(String command,
              DocumentAssignable options,
              DocumentBuilder builder)

Adds the options to the document builder.

Parameters:

command - The command to make sure is removed from the options.

options - The options to be added. May be null.

builder - The builder to add the options to.

getLockType

protected LockType getLockType()

Returns the type of lock to use.

Returns:

The type of lock to use.