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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	DBApiLayer.DeadCursor Deprecated.

Nested classes/interfaces inherited from class com.mongodb.DB

DB.CommandResultPair

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.concurrent.ConcurrentHashMap<java.lang.String,DBCollectionImpl>	_collections Deprecated.
(package private) DBTCPConnector	_connector Deprecated.
(package private) java.util.concurrent.ConcurrentLinkedQueue<DBApiLayer.DeadCursor>	_deadCursorIds Deprecated.
(package private) java.lang.String	_root Deprecated.
(package private) java.lang.String	_rootPlusDot Deprecated.
(package private) static int	NUM_CURSORS_BEFORE_KILL Deprecated. The maximum number of cursors allowed
(package private) static int	NUM_CURSORS_PER_BATCH Deprecated.

Fields inherited from class com.mongodb.DB

_mongo, _name, _options, _readOnly

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
(package private) void	addDeadCursor(DBApiLayer.DeadCursor deadCursor) Deprecated.
WriteResult	addUser(java.lang.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
(package private) CommandResult	doAuthenticate(MongoCredential credentials) Deprecated.
protected DBCollectionImpl	doGetCollection(java.lang.String name) Deprecated. Gets a collection with a given name.
java.util.Set<java.lang.String>	getCollectionNames() Deprecated. Returns a set containing the names of all collections in this database.
(package private) DBTCPConnector	getConnector() Deprecated.
private DBObject	getUserCommandDocument(java.lang.String username, char[] passwd, boolean readOnly, java.lang.String commandName) Deprecated.
private java.lang.String	getUserRoleName(boolean readOnly) Deprecated.
(package private) boolean	isServerVersionAtLeast(java.util.List<java.lang.Integer> versionList) Deprecated.
(package private) void	killCursors(ServerAddress addr, java.util.List<java.lang.Long> all) Deprecated.
WriteResult	removeUser(java.lang.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

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

Methods inherited from class java.lang.Object

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

Field Detail

NUM_CURSORS_BEFORE_KILL

static final int NUM_CURSORS_BEFORE_KILL

Deprecated.

The maximum number of cursors allowed

See Also:

Constant Field Values

NUM_CURSORS_PER_BATCH

static final int NUM_CURSORS_PER_BATCH

Deprecated.

See Also:

Constant Field Values

_root

final java.lang.String _root

Deprecated.

_rootPlusDot

final java.lang.String _rootPlusDot

Deprecated.

_connector

final DBTCPConnector _connector

Deprecated.

_collections

final java.util.concurrent.ConcurrentHashMap<java.lang.String,DBCollectionImpl> _collections

Deprecated.

_deadCursorIds

java.util.concurrent.ConcurrentLinkedQueue<DBApiLayer.DeadCursor> _deadCursorIds

Deprecated.

Constructor Detail

DBApiLayer

protected DBApiLayer(Mongo mongo,
                     java.lang.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

getConnector

DBTCPConnector getConnector()

Deprecated.

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.

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(java.lang.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(java.lang.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

getUserCommandDocument

private DBObject getUserCommandDocument(java.lang.String username,
                                        char[] passwd,
                                        boolean readOnly,
                                        java.lang.String commandName)

Deprecated.

getUserRoleName

private java.lang.String getUserRoleName(boolean readOnly)

Deprecated.

doGetCollection

protected DBCollectionImpl doGetCollection(java.lang.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

getCollectionNames

public java.util.Set<java.lang.String> getCollectionNames()

Deprecated.

Description copied from class: DB

Returns a set containing the names of all collections in this database.

Specified by:

getCollectionNames in class DB

Returns:

the names of collections in this database

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()

killCursors

void killCursors(ServerAddress addr,
                 java.util.List<java.lang.Long> all)

Deprecated.

doAuthenticate

CommandResult doAuthenticate(MongoCredential credentials)

Deprecated.

Specified by:

doAuthenticate in class DB

isServerVersionAtLeast

boolean isServerVersionAtLeast(java.util.List<java.lang.Integer> versionList)

Deprecated.

addDeadCursor

void addDeadCursor(DBApiLayer.DeadCursor deadCursor)

Deprecated.