org.nuxeo.ecm.directory.ldap

Class LDAPSession

java.lang.Object

org.nuxeo.ecm.directory.BaseSession

org.nuxeo.ecm.directory.ldap.LDAPSession

All Implemented Interfaces:

AutoCloseable, EntrySource, Session

public class LDAPSession
extends BaseSession
implements EntrySource

This class represents a session against an LDAPDirectory.

Author:

Olivier Grisel

Field Summary

Fields

Modifier and Type	Field and Description
protected DirContext	dirContext
protected Set<String>	emptySet
protected String	idAttribute
protected String	idCase
protected static String	MISSING_ID_LOWER_CASE
protected static String	MISSING_ID_UPPER_CASE
protected String	passwordHashAlgorithm
protected String	rdnAttribute
protected String	rdnField
protected Map<String,Field>	schemaFieldMap
protected String	schemaName
protected String	searchBaseDn
protected String	sid
protected BaseDirectoryDescriptor.SubstringMatchType	substringMatchType

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
LDAPSession(LDAPDirectory directory, DirContext dirContext)

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.
protected String	changeEntryIdCase(String id, String idFieldCase)
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 dm) 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)
protected Attribute	getAttributeValue(String fieldName, Object value)
DirContext	getContext()
LDAPDirectory	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)
protected Object	getFieldValue(Attribute attribute, String fieldName, String entryId, boolean fetchReferences)
protected SearchResult	getLdapEntry(String id)
protected SearchResult	getLdapEntry(String id, boolean fetchAllAttributes)
protected List<String>	getMandatoryAttributes()
protected List<String>	getMandatoryAttributes(Attribute objectClassesAttribute)
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.
protected void	handleException(Exception e, String message)
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).
protected DocumentModelList	ldapResultsToDocumentModels(NamingEnumeration<SearchResult> results, boolean fetchReferences)
protected DocumentModel	ldapResultToDocumentModel(SearchResult result, String entryId, boolean fetchReferences)
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, boolean fetchReferences, Map<String,String> orderBy)
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
boolean	rdnMatchesIdField()
String	toString()
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, isReadOnly, isReadOnlyEntry, mkObjectMap, mkSerializableMap, query, setReadOnlyEntry, setReadWriteEntry

Methods inherited from class java.lang.Object

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

Field Detail

MISSING_ID_LOWER_CASE

protected static final String MISSING_ID_LOWER_CASE

See Also:

Constant Field Values

MISSING_ID_UPPER_CASE

protected static final String MISSING_ID_UPPER_CASE

See Also:

Constant Field Values

schemaName

protected final String schemaName

dirContext

protected final DirContext dirContext

idAttribute

protected final String idAttribute

idCase

protected final String idCase

searchBaseDn

protected final String searchBaseDn

emptySet

protected final Set<String> emptySet

sid

protected final String sid

schemaFieldMap

protected final Map<String,Field> schemaFieldMap

substringMatchType

protected BaseDirectoryDescriptor.SubstringMatchType substringMatchType

rdnAttribute

protected final String rdnAttribute

rdnField

protected final String rdnField

passwordHashAlgorithm

protected final String passwordHashAlgorithm

Constructor Detail

LDAPSession

public LDAPSession(LDAPDirectory directory,
                   DirContext dirContext)

Method Detail

getDirectory

public LDAPDirectory getDirectory()

Description copied from class: BaseSession

To be implemented with a more specific return type.

Specified by:

getDirectory in class BaseSession

getContext

public DirContext getContext()

createEntry

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

Description copied from interface: Session

Creates an entry in a directory.

Specified by:

createEntry in interface Session

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

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?

Specified by:

getEntry in interface Session

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.

Specified by:

getEntry in interface Session

Parameters:

id - the entry id

fetchReferences - boolean stating if references have to be fetched

Returns:

a DocumentModel representing the entry

Throws:

DirectoryException

getEntryFromSource

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

Specified by:

getEntryFromSource in interface EntrySource

Throws:

DirectoryException

hasEntry

public boolean hasEntry(String id)
                 throws DirectoryException

Description copied from interface: Session

Returns true if session has an entry with given id.

Specified by:

hasEntry in interface Session

Throws:

DirectoryException

getLdapEntry

protected SearchResult getLdapEntry(String id)
                             throws NamingException,
                                    DirectoryException

Throws:

NamingException

DirectoryException

getLdapEntry

protected SearchResult getLdapEntry(String id,
                                    boolean fetchAllAttributes)
                             throws NamingException

Throws:

NamingException

getEntries

public DocumentModelList getEntries()
                             throws DirectoryException

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.

Specified by:

getEntries in interface Session

Returns:

a collection with all the entries in the directory

Throws:

DirectoryException

SizeLimitExceededException - if the number of results is larger than the limit configured for the directory and the server does not send partial results.

updateEntry

public void updateEntry(DocumentModel docModel)

Description copied from interface: Session

Updates a directory entry.

Specified by:

updateEntry in interface Session

Parameters:

docModel - The entry to update

handleException

protected void handleException(Exception e,
                               String message)

deleteEntry

public void deleteEntry(DocumentModel dm)

Description copied from interface: Session

Deletes a directory entry.

Specified by:

deleteEntry in interface Session

Parameters:

dm - The entry to delete

deleteEntry

public void deleteEntry(String id)

Description copied from interface: Session

Deletes a directory entry by id.

Specified by:

deleteEntry in interface Session

Parameters:

id - the id of the entry to delete

deleteEntry

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

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

Specified by:

deleteEntry in interface Session

Parameters:

id - the id of the entry to delete.

map - a map of seconday key values.

query

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

Throws:

DirectoryException

query

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

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.

Specified by:

query in interface Session

Parameters:

filter - a filter to apply to entries in directory

Returns:

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

Throws:

DirectoryException - if a communication error occurs

SizeLimitExceededException - if the number of results is larger than the limit configured for the directory and the server does not send partial results.

query

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

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.

Specified by:

query in interface Session

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

Throws:

DirectoryException - if a communication error occurs

SizeLimitExceededException - if the number of results is larger than the limit configured for the directory and the server does not send partial results.

query

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

Description copied from interface: Session

Executes a query with the possibility to fetch references

Specified by:

query in interface Session

Throws:

DirectoryException

See Also:

Session.query(Map, Set, Map)

query

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

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.

Specified by:

query in interface Session

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

Throws:

DirectoryException - if a communication error occurs

SizeLimitExceededException - if the number of results is larger than the limit configured for the directory and the server does not send partial results.

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?

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Session

Throws:

DirectoryException - if a communication error occurs

getProjection

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

Description copied from interface: Session

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

Specified by:

getProjection in interface Session

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

Throws:

DirectoryException

SizeLimitExceededException - if the number of results is larger than the limit configured for the directory

getProjection

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

Specified by:

getProjection in interface Session

Throws:

DirectoryException

fieldMapToDocumentModel

protected DocumentModel fieldMapToDocumentModel(Map<String,Object> fieldMap)
                                         throws DirectoryException

Throws:

DirectoryException

getFieldValue

protected Object getFieldValue(Attribute attribute,
                               String fieldName,
                               String entryId,
                               boolean fetchReferences)
                        throws DirectoryException

Throws:

DirectoryException

getAttributeValue

protected Attribute getAttributeValue(String fieldName,
                                      Object value)
                               throws DirectoryException

Throws:

DirectoryException

ldapResultsToDocumentModels

protected DocumentModelList ldapResultsToDocumentModels(NamingEnumeration<SearchResult> results,
                                                        boolean fetchReferences)
                                                 throws DirectoryException,
                                                        NamingException

Throws:

DirectoryException

NamingException

ldapResultToDocumentModel

protected DocumentModel ldapResultToDocumentModel(SearchResult result,
                                                  String entryId,
                                                  boolean fetchReferences)
                                           throws DirectoryException,
                                                  NamingException

Throws:

DirectoryException

NamingException

changeEntryIdCase

protected String changeEntryIdCase(String id,
                                   String idFieldCase)

authenticate

public boolean authenticate(String username,
                            String password)
                     throws DirectoryException

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.

Specified by:

authenticate in interface Session

Returns:

true is the credentials match those stored in the directory

Throws:

DirectoryException

isAuthenticating

public boolean isAuthenticating()
                         throws DirectoryException

Description copied from interface: Session

Tells whether the directory implementation can be used as an authenticating backend for the UserManager (based on login / password check).

Specified by:

isAuthenticating in interface Session

Overrides:

isAuthenticating in class BaseSession

Returns:

true is the directory is authentication aware

Throws:

DirectoryException

rdnMatchesIdField

public boolean rdnMatchesIdField()

getMandatoryAttributes

protected List<String> getMandatoryAttributes(Attribute objectClassesAttribute)
                                       throws DirectoryException

Throws:

DirectoryException

getMandatoryAttributes

protected List<String> getMandatoryAttributes()
                                       throws DirectoryException

Throws:

DirectoryException

toString

public String toString()

Overrides:

toString in class Object

createEntry

public DocumentModel createEntry(DocumentModel entry)

Description copied from interface: Session

Creates an entry in a directory.

Specified by:

createEntry in interface Session

Parameters:

entry - the document model representing the entry to create

Returns:

The new entry created in the directory