public class MultiDirectorySession extends BaseSession
Each source can build an entry aggregating fields from one or several directories.
Modifier and Type | Class and Description |
---|---|
protected static class |
MultiDirectorySession.SourceInfo |
protected class |
MultiDirectorySession.SubDirectoryInfo |
autoincrementId, directory, directoryName, MULTI_TENANT_ID_FORMAT, passwordHashAlgorithm, permissions, POWER_USERS_GROUP, readAllColumns, READONLY_ENTRY_FLAG, referenceClass, schemaName, substringMatchType
Constructor and Description |
---|
MultiDirectorySession(MultiDirectory directory) |
Modifier and Type | Method and Description |
---|---|
boolean |
authenticate(String username,
String password)
Checks that the credentials provided by the UserManager match those registered in the directory.
|
void |
close()
Closes the session and all open result sets obtained from this session.
|
DocumentModel |
createEntry(DocumentModel entry)
Creates an entry in a directory.
|
DocumentModel |
createEntryWithoutReferences(Map<String,Object> fieldMap)
To be implemented for specific creation.
|
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 void |
deleteEntryWithoutReferences(String id)
To be implemented for specific deletion.
|
MultiDirectory |
getDirectory()
To be implemented with a more specific return type.
|
DocumentModelList |
getEntries()
Retrieves all the entries in the directory.
|
DocumentModel |
getEntry(String id,
boolean fetchReferences)
Retrieves a directory entry using its id.
|
String |
getName() |
List<String> |
getProjection(Map<String,Serializable> filter,
Set<String> fulltext,
String columnName) |
boolean |
hasEntry(String id)
Returns true if session has an entry with given id.
|
DocumentModelList |
query(Map<String,Serializable> filter,
Set<String> fulltext,
Map<String,String> orderBy,
boolean fetchReferences)
Executes a query with the possibility to fetch references
|
void |
updateEntry(DocumentModel docModel)
Updates a directory entry.
|
protected List<String> |
updateEntryWithoutReferences(DocumentModel docModel)
To be implemented for specific update.
|
checkDeleteConstraints, checkPermission, computeMultiTenantDirectoryId, createEntry, createEntryModel, createEntryModel, getEntry, getEntryFromSource, getIdField, getPasswordField, getProjection, hasPermission, hasPermission, isAuthenticating, isReadOnly, isReadOnlyEntry, query, query, query, query, setReadAllColumns, setReadOnlyEntry, setReadWriteEntry
public MultiDirectorySession(MultiDirectory directory)
public MultiDirectory getDirectory()
BaseSession
getDirectory
in class BaseSession
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?
DirectoryException
- if a communication error occurspublic boolean authenticate(String username, String password)
Session
public DocumentModel getEntry(String id, boolean fetchReferences) throws DirectoryException
Session
getEntry
in interface Session
getEntry
in class BaseSession
id
- the entry idfetchReferences
- boolean stating if references have to be fetchedDirectoryException
public DocumentModelList getEntries()
Session
DocumentModelList#totalsize
on the returned list will return
-2 as a special marker for truncated results.getEntries
in interface Session
getEntries
in class BaseSession
public DocumentModel createEntryWithoutReferences(Map<String,Object> fieldMap) throws DirectoryException
BaseSession
createEntryWithoutReferences
in class BaseSession
DirectoryException
protected List<String> updateEntryWithoutReferences(DocumentModel docModel) throws DirectoryException
BaseSession
updateEntryWithoutReferences
in class BaseSession
DirectoryException
protected void deleteEntryWithoutReferences(String id) throws DirectoryException
BaseSession
deleteEntryWithoutReferences
in class BaseSession
DirectoryException
public void deleteEntry(DocumentModel docModel)
Session
deleteEntry
in interface Session
deleteEntry
in class BaseSession
docModel
- The entry to deletepublic void deleteEntry(String id)
Session
deleteEntry
in interface Session
deleteEntry
in class BaseSession
id
- the id of the entry to deletepublic 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
deleteEntry
in class BaseSession
id
- the id of the entry to delete.map
- a map of secondary key values.DirectoryException
- if a communication error occurs.public void updateEntry(DocumentModel docModel)
Session
updateEntry
in interface Session
updateEntry
in class BaseSession
docModel
- The entry to updatepublic DocumentModelList query(Map<String,Serializable> filter, Set<String> fulltext, Map<String,String> orderBy, boolean fetchReferences)
Session
query
in interface Session
query
in class BaseSession
Session.query(Map, Set, Map)
public List<String> getProjection(Map<String,Serializable> filter, Set<String> fulltext, String columnName)
getProjection
in interface Session
getProjection
in class BaseSession
public DocumentModel createEntry(DocumentModel entry)
Session
createEntry
in interface Session
createEntry
in class BaseSession
entry
- the document model representing the entry to createCopyright © 2018 Nuxeo. All rights reserved.