public class MongoDBSession extends BaseSession implements EntrySource
Session
Modifier and Type | Field and Description |
---|---|
protected boolean |
autoincrementId |
protected com.mongodb.MongoClient |
client |
protected String |
countersCollectionName |
protected String |
dbName |
protected String |
directoryName |
protected String |
passwordHashAlgorithm |
protected Map<String,Field> |
schemaFieldMap |
protected String |
schemaName |
protected BaseDirectoryDescriptor.SubstringMatchType |
substringMatchType |
directory, MULTI_TENANT_ID_FORMAT, permissions, POWER_USERS_GROUP, readAllColumns, READONLY_ENTRY_FLAG
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) |
void |
close()
Closes the session and all open result sets obtained from this session.
|
DocumentModel |
createEntry(DocumentModel documentModel)
Creates an entry in a directory.
|
DocumentModel |
createEntry(Map<String,Object> fieldMap)
Creates an entry in a directory.
|
void |
deleteEntry(DocumentModel docModel)
Deletes a directory entry.
|
void |
deleteEntry(String id)
Deletes a directory entry by id.
|
void |
deleteEntry(String id,
Map<String,String> map)
Deletes a directory entry by id and secondary ids.
|
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.
|
DocumentModelList |
getEntries()
Retrieves all the entries in the directory.
|
DocumentModel |
getEntry(String id)
Retrieves a directory entry using its id.
|
DocumentModel |
getEntry(String id,
boolean fetchReferences)
Retrieves a directory entry using its id.
|
DocumentModel |
getEntryFromSource(String id,
boolean fetchReferences) |
List<String> |
getProjection(Map<String,Serializable> filter,
Set<String> fulltext,
String columnName) |
List<String> |
getProjection(Map<String,Serializable> filter,
String columnName)
Executes a query using filter and return only the column columnName.
|
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.
|
DocumentModelList |
query(Map<String,Serializable> filter)
Executes a simple query.
|
DocumentModelList |
query(Map<String,Serializable> filter,
Set<String> fulltext)
Executes a simple query.
|
DocumentModelList |
query(Map<String,Serializable> filter,
Set<String> fulltext,
Map<String,String> orderBy)
Executes a simple query.
|
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.
|
void |
updateEntry(DocumentModel docModel)
Updates a directory entry.
|
checkDeleteConstraints, checkPermission, computeMultiTenantDirectoryId, createEntryModel, createEntryModel, getIdField, getPasswordField, hasPermission, hasPermission, isAuthenticating, isReadOnly, isReadOnlyEntry, mkObjectMap, mkSerializableMap, setReadAllColumns, setReadOnlyEntry, setReadWriteEntry
protected com.mongodb.MongoClient client
protected String schemaName
protected String directoryName
protected BaseDirectoryDescriptor.SubstringMatchType substringMatchType
protected String countersCollectionName
protected final Map<String,Field> schemaFieldMap
protected final String passwordHashAlgorithm
protected final boolean autoincrementId
public MongoDBSession(MongoDBDirectory directory)
public MongoDBDirectory getDirectory()
BaseSession
getDirectory
in class BaseSession
public DocumentModel getEntry(String id) throws DirectoryException
Session
TODO what happens when the entry is not found? return null if not found?
getEntry
in interface Session
id
- the entry idDirectoryException
public DocumentModel getEntry(String id, boolean fetchReferences) throws DirectoryException
Session
getEntry
in interface Session
id
- the entry idfetchReferences
- boolean stating if references have to be fetchedDirectoryException
public DocumentModelList getEntries() throws DirectoryException
Session
DocumentModelList#totalsize
on the returned list will return
-2 as a special marker for truncated results.getEntries
in interface Session
DirectoryException
SizeLimitExceededException
- if the number of results is larger than the limit configured for the directory
and the server does not send partial results.public DocumentModel createEntry(Map<String,Object> fieldMap) throws DirectoryException
Session
createEntry
in interface Session
fieldMap
- A map with keys and values that should be stored in a directory
Note: The values in the map should be of type String
DirectoryException
- if a communication exception occurs or if an entry with the same id already exists.public void updateEntry(DocumentModel docModel) throws DirectoryException
Session
updateEntry
in interface Session
docModel
- The entry to updateDirectoryException
- if a communication error occurspublic void deleteEntry(DocumentModel docModel) throws DirectoryException
Session
deleteEntry
in interface Session
docModel
- The entry to deleteDirectoryException
- if a communication error occurspublic void deleteEntry(String id) throws DirectoryException
Session
deleteEntry
in interface Session
id
- the id of the entry to deleteDirectoryException
- if a communication error occurspublic void deleteEntry(String id, Map<String,String> map) throws DirectoryException
Session
This is used for hierarchical vocabularies, where the actual unique key is the couple (parent, id).
deleteEntry
in interface Session
id
- the id of the entry to delete.map
- a map of seconday key values.DirectoryException
- if a communication error occurs.public DocumentModelList query(Map<String,Serializable> filter) throws DirectoryException
Session
Does not fetch reference fields.
If the remote server issues a size limit exceeded error while sending partial results up to that limit, the methodDocumentModelList#totalsize
on the returned list will return -2 as a special marker for truncated
results.query
in interface Session
filter
- a filter to apply to entries in directoryDirectoryException
- if a communication error occursSizeLimitExceededException
- if the number of results is larger than the limit configured for the directory
and the server does not send partial results.public DocumentModelList query(Map<String,Serializable> filter, Set<String> fulltext) throws DirectoryException
Session
fieldNames present in the fulltext set are treated as a fulltext match. Does not fetch reference fields.
If the remote server issues a size limit exceeded error while sending partial results up to that limit, the methodDocumentModelList#totalsize
on the returned list will return -2 as a special marker for truncated
results.query
in interface Session
filter
- a filter to apply to entries in directoryfulltext
- a set of field that should be treated as a fulltext searchDirectoryException
- if a communication error occursSizeLimitExceededException
- if the number of results is larger than the limit configured for the directory
and the server does not send partial results.public DocumentModelList query(Map<String,Serializable> filter, Set<String> fulltext, Map<String,String> orderBy) throws DirectoryException
Session
fieldNames present in the fulltext set are treated as a fulltext match. Does not fetch reference fields.
If the remote server issues a size limit exceeded error while sending partial results up to that limit, the methodDocumentModelList#totalsize
on the returned list will return -2 as a special marker for truncated
results.query
in interface Session
filter
- a filter to apply to entries in directoryfulltext
- a set of field that should be treated as a fulltext searchorderBy
- a LinkedHashMap with the 'order by' criterias.The key of an entry of this map represents the
column name and the value of the same entry represent the column order,which may be 'asc' or 'desc'.DirectoryException
- if a communication error occursSizeLimitExceededException
- if the number of results is larger than the limit configured for the directory
and the server does not send partial results.public DocumentModelList query(Map<String,Serializable> filter, Set<String> fulltext, Map<String,String> orderBy, boolean fetchReferences) throws DirectoryException
Session
query
in interface Session
DirectoryException
Session.query(Map, Set, Map)
public DocumentModelList query(Map<String,Serializable> filter, Set<String> fulltext, Map<String,String> orderBy, boolean fetchReferences, int limit, int offset) throws DirectoryException
Session
query
in interface Session
query
in class BaseSession
limit
- maximum number of results ignored if less than 1offset
- number of rows skipped before starting, will be 0 if less than 0.DirectoryException
Session.query(Map, Set, Map, boolean)
protected org.bson.Document buildQuery(Map<String,Serializable> fieldMap, Set<String> fulltext)
public void close() throws DirectoryException
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?
close
in interface AutoCloseable
close
in interface Session
DirectoryException
- if a communication error occurspublic List<String> getProjection(Map<String,Serializable> filter, String columnName) throws DirectoryException
Session
getProjection
in interface Session
filter
- the filter for the querycolumnName
- the column whose content should be returnedDirectoryException
SizeLimitExceededException
- if the number of results is larger than the limit configured for the directorypublic List<String> getProjection(Map<String,Serializable> filter, Set<String> fulltext, String columnName) throws DirectoryException
getProjection
in interface Session
DirectoryException
public boolean authenticate(String username, String password) throws DirectoryException
Session
authenticate
in interface Session
DirectoryException
public boolean hasEntry(String id)
Session
public DocumentModel createEntry(DocumentModel documentModel)
Session
createEntry
in interface Session
documentModel
- the document model representing the entry to createpublic DocumentModel getEntryFromSource(String id, boolean fetchReferences) throws DirectoryException
getEntryFromSource
in interface EntrySource
DirectoryException
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)
Copyright © 2017 Nuxeo. All rights reserved.