public class MongoDBSession extends BaseSession
Session
Modifier and Type | Class and Description |
---|---|
class |
MongoDBSession.MongoDBDirectoryQueryBuilder
MongoDB Query Builder that knows how to resolved directory properties.
|
BaseSession.FieldDetector
Modifier and Type | Field and Description |
---|---|
protected String |
countersCollectionName |
protected com.mongodb.client.MongoDatabase |
database |
static String |
DIRECTORY_CONNECTION_PREFIX
Prefix used to retrieve a MongoDB connection from
MongoDBConnectionService . |
autoincrementId, computeMultiTenantId, directory, directoryName, MULTI_TENANT_ID_FORMAT, passwordHashAlgorithm, permissions, POWER_USERS_GROUP, readAllColumns, READONLY_ENTRY_FLAG, referenceClass, schemaName, substringMatchType, TENANT_ID_FIELD
Constructor and Description |
---|
MongoDBSession(MongoDBDirectory directory) |
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) |
protected boolean |
checkEntryTenantId(String entryTenantId) |
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 DocumentModelList |
doQuery(Map<String,Serializable> filter,
Set<String> fulltext,
Map<String,String> orderBy,
boolean fetchReferences,
int limit,
int offset,
boolean checkTenantId) |
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.
|
DocumentModel |
getEntryFromSource(String id,
boolean fetchReferences) |
protected String |
getIdFromState(State state) |
protected String |
getPrefixedIdField() |
protected String |
getPrefixedPasswordField() |
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,
int limit,
int offset)
Executes a query with the possibility to fetch a subset of the results.
|
DocumentModelList |
query(QueryBuilder queryBuilder,
boolean fetchReferences)
Executes a query with the possibility to fetch a subset of the results.
|
List<String> |
queryIds(QueryBuilder queryBuilder)
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.
|
addTenantId, applyQueryLimits, applyQueryLimits, canDeleteMultiTenantEntry, checkDeleteConstraints, checkPermission, computeMultiTenantDirectoryId, createEntry, createEntry, createEntryModel, createEntryModel, deleteEntry, deleteEntry, deleteEntry, getCurrentTenantId, getEntries, getEntry, getEntry, getIdField, getPasswordField, getProjection, getProjection, hasPermission, hasPermission, isMultiTenant, isReadOnly, isReadOnlyEntry, query, query, query, query, setReadAllColumns, setReadOnlyEntry, setReadWriteEntry, toStringList, updateEntry
public static final String DIRECTORY_CONNECTION_PREFIX
MongoDBConnectionService
.
The connection id will be directory/[DIRECTORY_NAME]
.protected final com.mongodb.client.MongoDatabase database
protected String countersCollectionName
public MongoDBSession(MongoDBDirectory directory)
public MongoDBDirectory getDirectory()
BaseSession
getDirectory
in class BaseSession
public DocumentModel getEntryFromSource(String id, boolean fetchReferences)
getEntryFromSource
in interface EntrySource
getEntryFromSource
in class BaseSession
protected DocumentModel createEntryWithoutReferences(Map<String,Object> fieldMap)
BaseSession
createEntryWithoutReferences
in class BaseSession
protected List<String> updateEntryWithoutReferences(DocumentModel docModel)
BaseSession
updateEntryWithoutReferences
in class BaseSession
public void deleteEntryWithoutReferences(String id)
BaseSession
deleteEntryWithoutReferences
in class BaseSession
public DocumentModelList query(Map<String,Serializable> filter, Set<String> fulltext, Map<String,String> orderBy, boolean fetchReferences, int limit, int offset)
Session
limit
- maximum number of results ignored if less than 1offset
- number of rows skipped before starting, will be 0 if less than 0.Session.query(Map, Set, Map, boolean)
protected DocumentModelList doQuery(Map<String,Serializable> filter, Set<String> fulltext, Map<String,String> orderBy, boolean fetchReferences, int limit, int offset, boolean checkTenantId)
protected org.bson.Document buildQuery(Map<String,Serializable> fieldMap, Set<String> fulltext)
public DocumentModelList query(QueryBuilder queryBuilder, boolean fetchReferences)
Session
queryBuilder
- the query to use, including limit, offset, ordering and countTotalfetchReferences
- boolean stating if references have to be fetchedpublic List<String> queryIds(QueryBuilder queryBuilder)
Session
queryBuilder
- the query to use, including limit, offset and orderingpublic void close()
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?
public boolean authenticate(String username, String password)
Session
public boolean isAuthenticating()
Session
isAuthenticating
in interface Session
isAuthenticating
in class BaseSession
public boolean hasEntry(String id)
Session
public com.mongodb.client.MongoCollection<org.bson.Document> getCollection(String collection)
collection
- the collection namepublic com.mongodb.client.MongoCollection<org.bson.Document> getCollection()
public boolean hasCollection(String collection)
collection
- the collection nameprotected DocumentModel fieldMapToDocumentModel(Map<String,Object> fieldMap)
protected String getIdFromState(State state)
protected boolean checkEntryTenantId(String entryTenantId)
protected String getPrefixedIdField()
protected String getPrefixedPasswordField()
Copyright © 2018 Nuxeo. All rights reserved.