Package 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, EntrySource, 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	Description
protected static class	MultiDirectorySession.SourceInfo
protected class	MultiDirectorySession.SubDirectoryInfo

Nested classes/interfaces inherited from class org.nuxeo.ecm.directory.BaseSession

BaseSession.FieldDetector

Field Summary

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

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

Constructor Summary

Constructors

Constructor	Description
MultiDirectorySession(MultiDirectory directory)

Method Summary

Modifier and Type	Method	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.
protected DocumentModel	createEntryWithoutReferences(Map<String,Object> fieldMap)	Creates an entry to the directory without creating its references.
void	deleteEntry(String idOrSysId)	Deletes a directory entry by id.
void	deleteEntry(DocumentModel docModel)	Deletes a directory entry.
DocumentModel	doCreateEntryWithoutReferences(Map<String,Object> fieldMap)	To be implemented for specific creation.
protected void	doDeleteEntryWithoutReferences(String entryId)	To be implemented for specific deletion.
protected DocumentModelList	doQuery(DirectoryQueryBuilder queryBuilder)	To be implemented for specific querying.
protected List<String>	doQueryIds(DirectoryQueryBuilder queryBuilder)	To be implemented for specific querying.
protected List<String>	doUpdateEntryWithoutReferences(DocumentModel docModel)	To be implemented for specific update.
MultiDirectory	getDirectory()	To be implemented with a more specific return type.
DocumentModel	getEntry(String idOrSysId, 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 idOrSysId)	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, int limit, int offset)	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.
protected static void	setProperties(DocumentModel doc, String schema, Map<String,Object> map)	Sets the properties of the given doc and schema to the values provided by the given map, ensuring that any null value gets transformed to an empty string for a string property.
void	updateEntry(DocumentModel docModel)	Updates a directory entry.

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

addTenantId, applyQueryLimits, applyQueryLimits, canDeleteMultiTenantEntry, canDeleteMultiTenantEntry, checkDeleteConstraints, checkPermission, computeMultiTenantDirectoryId, createEntry, createEntryModel, createEntryModel, createEntryModel, createEntryModel, createEntryModel, createEntryModel, createQueryBuilderForIds, createQueryBuilderWithConfiguredFiltering, createQueryBuilderWithConfiguredFiltering, deleteEntryWithoutReferences, getCurrentTenantId, getEntryFromSource, getIdField, getPasswordField, getPrefixedFieldName, getPrefixedIdField, getProjection, hasPermission, hasPermission, isAuthenticating, isMultiTenant, isReadOnly, isReadOnlyEntry, query, query, query, query, query, query, queryIds, setReadAllColumns, setReadOnlyEntry, setReadWriteEntry, toStringList, updateEntryWithoutReferences

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.directory.Session

createEntryModel, getEntry

Constructor Details

MultiDirectorySession

public MultiDirectorySession(MultiDirectory directory)

Method Details

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()

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?

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 idOrSysId,
 boolean fetchReferences)

Description copied from interface: Session

Retrieves a directory entry using its id.

Specified by:

getEntry in interface Session

Overrides:

getEntry in class BaseSession

Parameters:

idOrSysId - the entry id

fetchReferences - boolean stating if references have to be fetched

Returns:

a DocumentModel representing the entry

createEntryWithoutReferences

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

Description copied from class: BaseSession

Creates an entry to the directory without creating its references.

Overrides:

createEntryWithoutReferences in class BaseSession

Implementation Note:

Do not execute generic code because multi directory is a bridge to directories which will execute it

doCreateEntryWithoutReferences

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

Description copied from class: BaseSession

To be implemented for specific creation.

Overrides:

doCreateEntryWithoutReferences in class BaseSession

doUpdateEntryWithoutReferences

protected List<String> doUpdateEntryWithoutReferences(DocumentModel docModel)

Description copied from class: BaseSession

To be implemented for specific update.

Overrides:

doUpdateEntryWithoutReferences in class BaseSession

doDeleteEntryWithoutReferences

protected void doDeleteEntryWithoutReferences(String entryId)

Description copied from class: BaseSession

To be implemented for specific deletion.

Overrides:

doDeleteEntryWithoutReferences in class BaseSession

deleteEntry

public void deleteEntry(DocumentModel docModel)

Description copied from interface: Session

Deletes a directory entry.

Specified by:

deleteEntry in interface Session

Overrides:

deleteEntry in class BaseSession

Parameters:

docModel - The entry to delete

deleteEntry

public void deleteEntry(String idOrSysId)

Description copied from interface: Session

Deletes a directory entry by id.

Specified by:

deleteEntry in interface Session

Overrides:

deleteEntry in class BaseSession

Parameters:

idOrSysId - the id of the entry to delete

setProperties

protected static void setProperties(DocumentModel doc,
 String schema,
 Map<String,Object> map)

Sets the properties of the given doc and schema to the values provided by the given map, ensuring that any null value gets transformed to an empty string for a string property.

updateEntry

public void updateEntry(DocumentModel docModel)

Description copied from interface: Session

Updates a directory entry.

Specified by:

updateEntry in interface Session

Overrides:

updateEntry in class BaseSession

Parameters:

docModel - The entry to update

query

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

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.

limit - maximum number of results ignored if less than 1

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

See Also:

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

doQuery

protected DocumentModelList doQuery(DirectoryQueryBuilder queryBuilder)

Description copied from class: BaseSession

To be implemented for specific querying.

Overrides:

doQuery in class BaseSession

See Also:

• BaseSession.query(QueryBuilder)

doQueryIds

protected List<String> doQueryIds(DirectoryQueryBuilder queryBuilder)

Description copied from class: BaseSession

To be implemented for specific querying.

Overrides:

doQueryIds in class BaseSession

See Also:

• BaseSession.queryIds(QueryBuilder)

getProjection

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

Specified by:

getProjection in interface Session

Overrides:

getProjection in class BaseSession

createEntry

public DocumentModel createEntry(DocumentModel entry)

Description copied from interface: Session

Creates an entry in a directory.

Specified by:

createEntry in interface Session

Overrides:

createEntry in class BaseSession

Parameters:

entry - the document model representing the entry to create

Returns:

The new entry created in the directory

hasEntry

public boolean hasEntry(String idOrSysId)

Description copied from interface: Session

Returns true if session has an entry with given id.

Specified by:

hasEntry in interface Session

Overrides:

hasEntry in class BaseSession