com.mongodb

Class DBApiLayer

java.lang.Object

com.mongodb.DB

com.mongodb.DBApiLayer

Deprecated.

This class is NOT part of the public API. It will be dropped in 3.x releases.

@Deprecated
public class DBApiLayer
extends DB

Concrete extension of abstract DB class.

Field Summary

Fields inherited from class com.mongodb.DB

_readOnly

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DBApiLayer(Mongo mongo, String name, DBConnector connector) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
WriteResult	addUser(String username, char[] passwd, boolean readOnly) Deprecated. Adds or updates a user for this database
void	cleanCursors(boolean force) Deprecated. Forcefully kills any cursors leaked by neglecting to call DBCursor.close
protected com.mongodb.DBCollectionImpl	doGetCollection(String name) Deprecated. Gets a collection with a given name.
WriteResult	removeUser(String username) Deprecated. Removes the specified user from the database.
void	requestDone() Deprecated. Ends the current 'consistent request'.
void	requestEnsureConnection() Deprecated. Ensure that a connection is assigned to the current 'consistent request' (from primary pool, if connected to a replica set)
void	requestStart() Deprecated. Starts a new 'consistent request'.

Methods inherited from class com.mongodb.DB

addOption, addUser, authenticate, authenticateCommand, collectionExists, command, command, command, command, command, command, command, command, command, command, command, createCollection, doEval, dropDatabase, eval, forceError, getCollection, getCollectionFromString, getCollectionNames, getLastError, getLastError, getLastError, getMongo, getName, getOptions, getPreviousError, getReadPreference, getSisterDB, getStats, getWriteConcern, isAuthenticated, resetError, resetOptions, setOptions, setReadOnly, setReadPreference, setWriteConcern, slaveOk, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DBApiLayer

protected DBApiLayer(Mongo mongo,
          String name,
          DBConnector connector)

Deprecated.

Parameters:

mongo - the Mongo instance

name - the database name

connector - the connector. This must be an instance of DBTCPConnector.

Method Detail

requestStart

public void requestStart()

Deprecated.

Description copied from class: DB

Starts a new 'consistent request'.

Following this call and until DB.requestDone() is called, all db operations will use the same underlying connection.

This is useful to ensure that operations happen in a certain order with predictable results.

Specified by:

requestStart in class DB

requestDone

public void requestDone()

Deprecated.

Description copied from class: DB

Ends the current 'consistent request'.

Specified by:

requestDone in class DB

requestEnsureConnection

public void requestEnsureConnection()

Deprecated.

Description copied from class: DB

Ensure that a connection is assigned to the current 'consistent request' (from primary pool, if connected to a replica set)

Specified by:

requestEnsureConnection in class DB

addUser

public WriteResult addUser(String username,
                  char[] passwd,
                  boolean readOnly)

Deprecated.

Description copied from class: DB

Adds or updates a user for this database

Overrides:

addUser in class DB

Parameters:

username - the user name

passwd - the password

readOnly - if true, user will only be able to read

Returns:

the result of executing this operation

removeUser

public WriteResult removeUser(String username)

Deprecated.

Description copied from class: DB

Removes the specified user from the database.

Overrides:

removeUser in class DB

Parameters:

username - user to be removed

Returns:

the result of executing this operation

doGetCollection

protected com.mongodb.DBCollectionImpl doGetCollection(String name)

Deprecated.

Description copied from class: DB

Gets a collection with a given name. If the collection does not exist, a new collection is created.

This class is NOT part of the public API. Be prepared for non-binary compatible changes in minor releases.

Specified by:

doGetCollection in class DB

Parameters:

name - the name of the collection

Returns:

the collection

cleanCursors

public void cleanCursors(boolean force)

Deprecated.

Description copied from class: DB

Forcefully kills any cursors leaked by neglecting to call DBCursor.close

Specified by:

cleanCursors in class DB

Parameters:

force - true if should clean regardless of number of dead cursors

Throws:

MongoException

See Also:

DBCursor.close()