org.nuxeo.directory.mongodb

Class MongoDBSession

java.lang.Object

org.nuxeo.ecm.directory.BaseSession

org.nuxeo.directory.mongodb.MongoDBSession

All Implemented Interfaces:

AutoCloseable, EntrySource, Session

public class MongoDBSession
extends BaseSession

MongoDB implementation of a Session

Since:

9.1

Field Summary

Fields

Modifier and Type	Field and Description
protected com.mongodb.MongoClient	client
protected String	countersCollectionName
protected String	dbName

Fields inherited from class org.nuxeo.ecm.directory.BaseSession

autoincrementId, directory, directoryName, MULTI_TENANT_ID_FORMAT, passwordHashAlgorithm, permissions, POWER_USERS_GROUP, readAllColumns, READONLY_ENTRY_FLAG, referenceClass, schemaFieldMap, schemaName, substringMatchType

Constructor Summary

Constructors

Constructor and Description
MongoDBSession(MongoDBDirectory directory)

Method Summary

Modifier and Type	Method and Description
protected void	addField(org.bson.Document bson, String key, Object value)
boolean	authenticate(String username, String password) Checks that the credentials provided by the UserManager match those registered in the directory.
protected org.bson.Document	buildQuery(Map<String,Serializable> fieldMap, Set<String> fulltext)
void	close() Closes the session and all open result sets obtained from this session.
protected DocumentModel	createEntryWithoutReferences(Map<String,Object> fieldMap) To be implemented for specific creation.
void	deleteEntryWithoutReferences(String id) To be implemented for specific deletion.
protected DocumentModel	fieldMapToDocumentModel(Map<String,Object> fieldMap)
com.mongodb.client.MongoCollection<org.bson.Document>	getCollection() Retrieve the collection associated to this directory
com.mongodb.client.MongoCollection<org.bson.Document>	getCollection(String collection) Retrieve a collection
MongoDBDirectory	getDirectory() To be implemented with a more specific return type.
boolean	hasCollection(String collection) Check if the MongoDB server has the collection
boolean	hasEntry(String id) Returns true if session has an entry with given id.
boolean	isAuthenticating() Tells whether the directory implementation can be used as an authenticating backend for the UserManager (based on login / password check).
DocumentModelList	query(Map<String,Serializable> filter, Set<String> fulltext, Map<String,String> orderBy, boolean fetchReferences) Executes a query with the possibility to fetch references
DocumentModelList	query(Map<String,Serializable> filter, Set<String> fulltext, Map<String,String> orderBy, boolean fetchReferences, int limit, int offset) Executes a query with the possibility to fetch a subset of the results.
protected List<String>	updateEntryWithoutReferences(DocumentModel docModel) To be implemented for specific update.

Methods inherited from class org.nuxeo.ecm.directory.BaseSession

checkDeleteConstraints, checkPermission, computeMultiTenantDirectoryId, createEntry, createEntry, createEntryModel, createEntryModel, deleteEntry, deleteEntry, deleteEntry, getEntries, getEntry, getEntry, getEntryFromSource, getIdField, getPasswordField, getProjection, getProjection, hasPermission, hasPermission, isReadOnly, isReadOnlyEntry, query, query, query, setReadAllColumns, setReadOnlyEntry, setReadWriteEntry, updateEntry

Methods inherited from class java.lang.Object

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

Field Detail

client

protected com.mongodb.MongoClient client

dbName

protected String dbName

countersCollectionName

protected String countersCollectionName

Constructor Detail

MongoDBSession

public MongoDBSession(MongoDBDirectory directory)

Method Detail

getDirectory

public MongoDBDirectory getDirectory()

Description copied from class: BaseSession

To be implemented with a more specific return type.

Specified by:

getDirectory in class BaseSession

createEntryWithoutReferences

protected DocumentModel createEntryWithoutReferences(Map<String,Object> fieldMap)

Description copied from class: BaseSession

To be implemented for specific creation.

Specified by:

createEntryWithoutReferences in class BaseSession

updateEntryWithoutReferences

protected List<String> updateEntryWithoutReferences(DocumentModel docModel)
                                             throws DirectoryException

Description copied from class: BaseSession

To be implemented for specific update.

Specified by:

updateEntryWithoutReferences in class BaseSession

Throws:

DirectoryException

deleteEntryWithoutReferences

public void deleteEntryWithoutReferences(String id)
                                  throws DirectoryException

Description copied from class: BaseSession

To be implemented for specific deletion.

Specified by:

deleteEntryWithoutReferences in class BaseSession

Throws:

DirectoryException

query

public DocumentModelList query(Map<String,Serializable> filter,
                               Set<String> fulltext,
                               Map<String,String> orderBy,
                               boolean fetchReferences)
                        throws DirectoryException

Description copied from interface: Session

Executes a query with the possibility to fetch references

Specified by:

query in interface Session

Overrides:

query in class BaseSession

Throws:

DirectoryException

See Also:

Session.query(Map, Set, Map)

query

public DocumentModelList query(Map<String,Serializable> filter,
                               Set<String> fulltext,
                               Map<String,String> orderBy,
                               boolean fetchReferences,
                               int limit,
                               int offset)
                        throws DirectoryException

Description copied from interface: Session

Executes a query with the possibility to fetch a subset of the results. org.nuxeo.ecm.directory.BaseSession provides a default implementation fetching all results to return the subset. Not recommended.

Specified by:

query in interface Session

Overrides:

query in class BaseSession

limit - maximum number of results ignored if less than 1

offset - number of rows skipped before starting, will be 0 if less than 0.

Throws:

DirectoryException

See Also:

Session.query(Map, Set, Map, boolean)

buildQuery

protected org.bson.Document buildQuery(Map<String,Serializable> fieldMap,
                                       Set<String> fulltext)

addField

protected void addField(org.bson.Document bson,
                        String key,
                        Object value)

close

public void close()
           throws DirectoryException

Description copied from interface: Session

Closes the session and all open result sets obtained from this session.

Releases this Connection object's resources immediately instead of waiting for them to be automatically released.

TODO: should this operation auto-commit pending changes?

Throws:

DirectoryException - if a communication error occurs

authenticate

public boolean authenticate(String username,
                            String password)
                     throws DirectoryException

Description copied from interface: Session

Checks that the credentials provided by the UserManager match those registered in the directory. If username is not in the directory, this should return false instead of throrwing an exception.

Returns:

true is the credentials match those stored in the directory

Throws:

DirectoryException

isAuthenticating

public boolean isAuthenticating()

Description copied from interface: Session

Tells whether the directory implementation can be used as an authenticating backend for the UserManager (based on login / password check).

Specified by:

isAuthenticating in interface Session

Overrides:

isAuthenticating in class BaseSession

Returns:

true is the directory is authentication aware

hasEntry

public boolean hasEntry(String id)

Description copied from interface: Session

Returns true if session has an entry with given id.

getCollection

public com.mongodb.client.MongoCollection<org.bson.Document> getCollection(String collection)

Retrieve a collection

Parameters:

collection - the collection name

Returns:

the MongoDB collection

getCollection

public com.mongodb.client.MongoCollection<org.bson.Document> getCollection()

Retrieve the collection associated to this directory

Returns:

the MongoDB collection

hasCollection

public boolean hasCollection(String collection)

Check if the MongoDB server has the collection

Parameters:

collection - the collection name

Returns:

true if the server has the collection, false otherwise

fieldMapToDocumentModel

protected DocumentModel fieldMapToDocumentModel(Map<String,Object> fieldMap)