org.nuxeo.ecm.directory.multi

Class MultiDirectorySession

java.lang.Object

org.nuxeo.ecm.directory.BaseSession

org.nuxeo.ecm.directory.multi.MultiDirectorySession

All Implemented Interfaces:

AutoCloseable, Session

public class MultiDirectorySession
extends BaseSession

Directory session aggregating entries from different sources.

Each source can build an entry aggregating fields from one or several directories.

Author:

Florent Guillaume, Anahide Tchertchian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MultiDirectorySession.SourceInfo
protected class	MultiDirectorySession.SubDirectoryInfo

Field Summary

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

directory, MULTI_TENANT_ID_FORMAT, permissions, POWER_USERS_GROUP, READONLY_ENTRY_FLAG

Constructor Summary

Constructors

Constructor and Description
MultiDirectorySession(MultiDirectory directory)

Method Summary

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	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.
MultiDirectory	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.
String	getName()
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	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
void	updateEntry(DocumentModel docModel) Updates a directory entry.

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

checkDeleteConstraints, checkPermission, computeMultiTenantDirectoryId, createEntryModel, createEntryModel, getIdField, getPasswordField, hasPermission, hasPermission, isAuthenticating, isReadOnly, isReadOnlyEntry, mkObjectMap, mkSerializableMap, query, setReadOnlyEntry, setReadWriteEntry

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiDirectorySession

public MultiDirectorySession(MultiDirectory directory)

Method Detail

getDirectory

public MultiDirectory getDirectory()

Description copied from class: BaseSession

To be implemented with a more specific return type.

Specified by:

getDirectory in class BaseSession

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

getName

public String getName()

authenticate

public boolean authenticate(String username,
                            String password)

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

getEntry

public DocumentModel getEntry(String id)
                       throws DirectoryException

Description copied from interface: Session

Retrieves a directory entry using its id.

TODO what happens when the entry is not found? return null if not found?

Parameters:

id - the entry id

Returns:

a DocumentModel representing the entry

Throws:

DirectoryException

getEntry

public DocumentModel getEntry(String id,
                              boolean fetchReferences)
                       throws DirectoryException

Description copied from interface: Session

Retrieves a directory entry using its id.

Parameters:

id - the entry id

fetchReferences - boolean stating if references have to be fetched

Returns:

a DocumentModel representing the entry

Throws:

DirectoryException

getEntries

public DocumentModelList getEntries()

Description copied from interface: Session

Retrieves all the entries in the directory. If the remote server issues a size limit exceeded error while sending partial results up to that limit, the method DocumentModelList#totalsize on the returned list will return -2 as a special marker for truncated results.

Returns:

a collection with all the entries in the directory

createEntry

public DocumentModel createEntry(Map<String,Object> fieldMap)

Description copied from interface: Session

Creates an entry in a directory.

Parameters:

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

Returns:

The new entry created in the directory

deleteEntry

public void deleteEntry(DocumentModel docModel)

Description copied from interface: Session

Deletes a directory entry.

Parameters:

docModel - The entry to delete

deleteEntry

public void deleteEntry(String id)

Description copied from interface: Session

Deletes a directory entry by id.

Parameters:

id - the id of the entry to delete

deleteEntry

public void deleteEntry(String id,
                        Map<String,String> map)
                 throws DirectoryException

Description copied from interface: Session

Deletes a directory entry by id and secondary ids.

This is used for hierarchical vocabularies, where the actual unique key is the couple (parent, id).

Parameters:

id - the id of the entry to delete.

map - a map of seconday key values.

Throws:

DirectoryException - if a communication error occurs.

updateEntry

public void updateEntry(DocumentModel docModel)

Description copied from interface: Session

Updates a directory entry.

Parameters:

docModel - The entry to update

query

public DocumentModelList query(Map<String,Serializable> filter)

Description copied from interface: Session

Executes a simple query. The conditions will be 'AND'-ed. Search is done with exact 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 method DocumentModelList#totalsize on the returned list will return -2 as a special marker for truncated results.

Parameters:

filter - a filter to apply to entries in directory

Returns:

a list of document models containing the entries matched by the query

query

public DocumentModelList query(Map<String,Serializable> filter,
                               Set<String> fulltext)

Description copied from interface: Session

Executes a simple query. The conditions will be 'AND'-ed.

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 method DocumentModelList#totalsize on the returned list will return -2 as a special marker for truncated results.

Parameters:

filter - a filter to apply to entries in directory

fulltext - a set of field that should be treated as a fulltext search

Returns:

a list of document models containing the entries matched by the query

query

public DocumentModelList query(Map<String,Serializable> filter,
                               Set<String> fulltext,
                               Map<String,String> orderBy)

Description copied from interface: Session

Executes a simple query. The conditions will be 'AND'-ed and the result will be sorted by the orderBy criteria list.

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 method DocumentModelList#totalsize on the returned list will return -2 as a special marker for truncated results.

Parameters:

filter - a filter to apply to entries in directory

fulltext - a set of field that should be treated as a fulltext search

orderBy - 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'.

Returns:

a list of document models containing the entries matched by the query

query

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

Description copied from interface: Session

Executes a query with the possibility to fetch references

See Also:

Session.query(Map, Set, Map)

getProjection

public List<String> getProjection(Map<String,Serializable> filter,
                                  String columnName)

Description copied from interface: Session

Executes a query using filter and return only the column columnName.

Parameters:

filter - the filter for the query

columnName - the column whose content should be returned

Returns:

the list with the values of columnName for the entries matching filter

getProjection

public List<String> getProjection(Map<String,Serializable> filter,
                                  Set<String> fulltext,
                                  String columnName)

createEntry

public DocumentModel createEntry(DocumentModel entry)

Description copied from interface: Session

Creates an entry in a directory.

Parameters:

entry - the document model representing the entry to create

Returns:

The new entry created in the directory

hasEntry

public boolean hasEntry(String id)

Description copied from interface: Session

Returns true if session has an entry with given id.