org.nuxeo.ecm.directory.memory

Class MemoryDirectorySession

java.lang.Object

org.nuxeo.ecm.directory.BaseSession

org.nuxeo.ecm.directory.memory.MemoryDirectorySession

All Implemented Interfaces:

AutoCloseable, EntrySource, Session

public class MemoryDirectorySession
extends BaseSession

Trivial in-memory implementation of a Directory to use in unit tests.

Author:

Florent Guillaume

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Map<String,Object>>	data

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
MemoryDirectorySession(MemoryDirectory 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.
void	commit()
DocumentModel	createEntry(DocumentModel entry) Creates an entry in a directory.
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.
MemoryDirectory	getDirectory() To be implemented with a more specific type.
DocumentModelList	getEntries() Retrieves all the entries in the directory.
DocumentModel	getEntry(String id, boolean fetchReferences) Retrieves a directory entry using its id.
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	rollback()
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, createEntryModel, createEntryModel, getEntry, getEntryFromSource, getIdField, getPasswordField, getProjection, getProjection, hasPermission, hasPermission, isAuthenticating, 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

data

protected final Map<String,Map<String,Object>> data

Constructor Detail

MemoryDirectorySession

public MemoryDirectorySession(MemoryDirectory directory)

Method Detail

getDirectory

public MemoryDirectory getDirectory()

To be implemented with a more specific type.

Specified by:

getDirectory in class BaseSession

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.

Returns:

true is the credentials match those stored in the directory

Throws:

DirectoryException

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?

commit

public void commit()

rollback

public void rollback()
              throws DirectoryException

Throws:

DirectoryException

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

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.

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.

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

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

Overrides:

query in class BaseSession

Throws:

DirectoryException

See Also:

Session.query(Map, Set, Map)

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

Description copied from interface: Session

Returns true if session has an entry with given id.