org.nuxeo.ecm.directory.core

Class CoreDirectorySession

java.lang.Object

org.nuxeo.ecm.directory.BaseSession

org.nuxeo.ecm.directory.core.CoreDirectorySession

All Implemented Interfaces:

AutoCloseable, EntrySource, Session

public class CoreDirectorySession
extends BaseSession

Session class for directory on repository

Since:

8.2

Field Summary

Fields

Modifier and Type	Field and Description
protected CoreSession	coreSession
protected String	createPath
protected String	docType
protected String	schemaIdField
protected String	schemaPasswordField
protected static String	UUID_FIELD

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

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

Constructor Summary

Constructors

Constructor and Description
CoreDirectorySession(CoreDirectory 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(Map<String,Object> fieldMap) 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.
CoreDirectory	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.
protected String	getMappedPrefixedFieldName(String fieldName)
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.
boolean	isAuthenticating() Tells whether the directory implementation can be used as an authenticating backend for the UserManager (based on login / password check).
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.
protected List<String>	updateEntryWithoutReferences(DocumentModel docModel) To be implemented for specific update.

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

checkDeleteConstraints, checkPermission, computeMultiTenantDirectoryId, createEntry, createEntryModel, createEntryModel, getEntry, getEntryFromSource, getIdField, getPasswordField, hasPermission, hasPermission, isReadOnly, isReadOnlyEntry, query, query, query, query, setReadAllColumns, setReadOnlyEntry, setReadWriteEntry

Methods inherited from class java.lang.Object

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

Field Detail

schemaIdField

protected final String schemaIdField

schemaPasswordField

protected final String schemaPasswordField

coreSession

protected final CoreSession coreSession

createPath

protected final String createPath

docType

protected final String docType

UUID_FIELD

protected static final String UUID_FIELD

See Also:

Constant Field Values

Constructor Detail

CoreDirectorySession

public CoreDirectorySession(CoreDirectory directory)

Method Detail

getDirectory

public CoreDirectory getDirectory()

Description copied from class: BaseSession

To be implemented with a more specific return type.

Specified by:

getDirectory in class BaseSession

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

Overrides:

getEntry in class BaseSession

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

Overrides:

getEntries in class BaseSession

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.

createEntryWithoutReferences

public DocumentModel createEntryWithoutReferences(Map<String,Object> fieldMap)
                                           throws DirectoryException

Description copied from class: BaseSession

To be implemented for specific creation.

Specified by:

createEntryWithoutReferences in class BaseSession

Throws:

DirectoryException

updateEntryWithoutReferences

protected List<String> updateEntryWithoutReferences(DocumentModel docModel)
                                             throws DirectoryException

Description copied from class: BaseSession

To be implemented for specific update.

Specified by:

updateEntryWithoutReferences in class BaseSession

Throws:

DirectoryException

deleteEntryWithoutReferences

protected void deleteEntryWithoutReferences(String id)
                                     throws DirectoryException

Description copied from class: BaseSession

To be implemented for specific deletion.

Specified by:

deleteEntryWithoutReferences in class BaseSession

Throws:

DirectoryException

createEntry

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

Description copied from interface: Session

Creates an entry in a directory.

Specified by:

createEntry in interface Session

Overrides:

createEntry in class BaseSession

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

Throws:

DirectoryException - if a communication exception occurs or if an entry with the same id already exists.

updateEntry

public void updateEntry(DocumentModel docModel)
                 throws DirectoryException

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

Throws:

DirectoryException - if a communication error occurs

deleteEntry

public void deleteEntry(DocumentModel docModel)
                 throws DirectoryException

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

Throws:

DirectoryException - if a communication error occurs

deleteEntry

public void deleteEntry(String id)
                 throws DirectoryException

Description copied from interface: Session

Deletes a directory entry by id.

Specified by:

deleteEntry in interface Session

Overrides:

deleteEntry in class BaseSession

Parameters:

id - the id of the entry to delete

Throws:

DirectoryException - if a communication error occurs

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

Specified by:

deleteEntry in interface Session

Overrides:

deleteEntry in class BaseSession

Parameters:

id - the id of the entry to delete.

map - a map of secondary key values.

Throws:

DirectoryException - if a communication error occurs.

getMappedPrefixedFieldName

protected String getMappedPrefixedFieldName(String fieldName)

query

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

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.

Specified by:

query in interface Session

Overrides:

query in class BaseSession

limit - maximum number of results ignored if less than 1

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

Throws:

DirectoryException

See Also:

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

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

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

Overrides:

getProjection in class BaseSession

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

Overrides:

getProjection in class BaseSession

Throws:

DirectoryException

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

isAuthenticating

public boolean isAuthenticating()

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

hasEntry

public boolean hasEntry(String id)

Description copied from interface: Session

Returns true if session has an entry with given id.