BaseSession (Nuxeo ECM Projects 9.10-SNAPSHOT API)

java.lang.Object
- org.nuxeo.ecm.directory.BaseSession

All Implemented Interfaces:

AutoCloseable, EntrySource, Session

Direct Known Subclasses:

CoreDirectorySession, LDAPSession, MemoryDirectorySession, MongoDBSession, MultiDirectorySession, SQLSession
```
public abstract class BaseSession
extends Object
implements Session, EntrySource
```
Base session class with helper methods common to all kinds of directory sessions.

Since:

5.2M4

Author:

Anahide Tchertchian

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`autoincrementId`
`protected Directory`	`directory`
`protected String`	`directoryName`
`protected static String`	`MULTI_TENANT_ID_FORMAT`
`protected String`	`passwordHashAlgorithm`
`protected PermissionDescriptor[]`	`permissions`
`protected static String`	`POWER_USERS_GROUP`
`protected boolean`	`readAllColumns`
`protected static String`	`READONLY_ENTRY_FLAG`
`protected Class<? extends Reference>`	`referenceClass`
`protected String`	`schemaName`
`protected BaseDirectoryDescriptor.SubstringMatchType`	`substringMatchType`

Constructor Summary

Constructors
Modifier Constructor and Description

protected BaseSession(Directory directory, Class<? extends Reference> referenceClass)

Constructors
Modifier	Constructor and Description
`protected`	`BaseSession(Directory directory, Class<? extends Reference> referenceClass)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`checkDeleteConstraints(String entryId)` Checks that there are no constraints for deleting the given entry id.
`void`	`checkPermission(String permission)` Checks the current user rights for the given permission against the read-only flag and the permission descriptor.
`static String`	`computeMultiTenantDirectoryId(String tenantId, String id)` Compute a multi tenant directory id based on the given `tenantId`.
`DocumentModel`	`createEntry(DocumentModel documentModel)` Creates an entry in a directory.
`DocumentModel`	`createEntry(Map<String,Object> fieldMap)` Creates an entry in a directory.
`static DocumentModel`	`createEntryModel(String sessionId, String schema, String id, Map<String,Object> values)` Returns a bare document model suitable for directory implementations.
`static DocumentModel`	`createEntryModel(String sessionId, String schema, String id, Map<String,Object> values, boolean readOnly)` Returns a bare document model suitable for directory implementations.
`protected abstract 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)` Deprecated.
`protected abstract void`	`deleteEntryWithoutReferences(String id)` To be implemented for specific deletion.
`abstract Directory`	`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)`
`String`	`getIdField()` The Id field is the name of the field that is used a primary key: unique and not null value in the whole directory.
`String`	`getPasswordField()`
`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`	`hasPermission(String permission)` Checks the current user rights for the given permission against the read-only flag and the permission descriptor.
`protected boolean`	`hasPermission(String permission, String username, List<String> groups)`
`boolean`	`isAuthenticating()` Tells whether the directory implementation can be used as an authenticating backend for the UserManager (based on login / password check).
`boolean`	`isReadOnly()`
`static boolean`	`isReadOnlyEntry(DocumentModel entry)` Test whether entry comes from a read-only back-end directory.
`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
`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`	`setReadAllColumns(boolean readAllColumns)` For test framework.
`static void`	`setReadOnlyEntry(DocumentModel entry)` Set the read-only flag of a directory entry.
`static void`	`setReadWriteEntry(DocumentModel entry)` Unset the read-only flag of a directory entry.
`void`	`updateEntry(DocumentModel docModel)` Updates a directory entry.
`protected abstract List<String>`	`updateEntryWithoutReferences(DocumentModel docModel)` To be implemented for specific update.

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
authenticate, close, hasEntry

- Field Detail
  - POWER_USERS_GROUP
```
protected static final String POWER_USERS_GROUP
```
    See Also:
    
    Constant Field Values
  - READONLY_ENTRY_FLAG
```
protected static final String READONLY_ENTRY_FLAG
```
    See Also:
    
    Constant Field Values
  - MULTI_TENANT_ID_FORMAT
```
protected static final String MULTI_TENANT_ID_FORMAT
```
    See Also:
    
    Constant Field Values
  - directory
```
protected final Directory directory
```
  - permissions
```
protected PermissionDescriptor[] permissions
```
  - readAllColumns
```
protected boolean readAllColumns
```
  - schemaName
```
protected String schemaName
```
  - directoryName
```
protected String directoryName
```
  - substringMatchType
```
protected BaseDirectoryDescriptor.SubstringMatchType substringMatchType
```
  - referenceClass
```
protected Class<? extends Reference> referenceClass
```
  - passwordHashAlgorithm
```
protected String passwordHashAlgorithm
```
  - autoincrementId
```
protected boolean autoincrementId
```
- Constructor Detail
  - BaseSession
```
protected BaseSession(Directory directory,
                      Class<? extends Reference> referenceClass)
```
- Method Detail
  - getDirectory
```
public abstract Directory getDirectory()
```
    To be implemented with a more specific return type.
  - setReadAllColumns
```
public void setReadAllColumns(boolean readAllColumns)
```
    Description copied from interface: Session
    
    For test framework. Changes the read/query methods to return all of the entries, including the password field.
    
    Specified by:
    
    setReadAllColumns in interface Session
    
    Parameters:
    
    readAllColumns - whether to read all columns
  - getIdField
```
public String getIdField()
```
    Description copied from interface: Session
    
    The Id field is the name of the field that is used a primary key: unique and not null value in the whole directory. This field is also used as login field if the directory is authenticating.
    
    Specified by:
    
    getIdField in interface Session
    
    Returns:
    
    the name of the id field
  - getPasswordField
```
public String getPasswordField()
```
    Specified by:
    
    getPasswordField in interface Session
    
    Returns:
    
    the name of the field to store the password if the directory is authenticating (can be null)
  - 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
    
    Returns:
    
    true is the directory is authentication aware
  - isReadOnly
```
public boolean isReadOnly()
```
    Specified by:
    
    isReadOnly in interface Session
  - checkPermission
```
public void checkPermission(String permission)
```
    Checks the current user rights for the given permission against the read-only flag and the permission descriptor.
    Throws DirectorySecurityException if the user does not have adequate privileges.
    
    Throws:
    
    DirectorySecurityException - if access is denied
    
    Since:
    
    8.3
  - checkDeleteConstraints
```
public void checkDeleteConstraints(String entryId)
```
    Checks that there are no constraints for deleting the given entry id.
    
    Since:
    
    8.4
  - hasPermission
```
public boolean hasPermission(String permission)
```
    Checks the current user rights for the given permission against the read-only flag and the permission descriptor.
    Returns false if the user does not have adequate privileges.
    
    Returns:
    
    false if access is denied
    
    Since:
    
    8.3
  - hasPermission
```
protected boolean hasPermission(String permission,
                                String username,
                                List<String> groups)
```
  - createEntryModel
```
public static DocumentModel createEntryModel(String sessionId,
                                             String schema,
                                             String id,
                                             Map<String,Object> values)
                                      throws PropertyException
```
    Returns a bare document model suitable for directory implementations.
    Can be used for creation screen.
    
    Throws:
    
    PropertyException
    
    Since:
    
    5.2M4
  - createEntryModel
```
public static DocumentModel createEntryModel(String sessionId,
                                             String schema,
                                             String id,
                                             Map<String,Object> values,
                                             boolean readOnly)
                                      throws PropertyException
```
    Returns a bare document model suitable for directory implementations.
    Allow setting the readonly entry flag to Boolean.TRUE. See Session#isReadOnlyEntry(DocumentModel)
    
    Throws:
    
    PropertyException
    
    Since:
    
    5.3.1
  - isReadOnlyEntry
```
public static boolean isReadOnlyEntry(DocumentModel entry)
```
    Test whether entry comes from a read-only back-end directory.
    
    Since:
    
    5.3.1
  - setReadOnlyEntry
```
public static void setReadOnlyEntry(DocumentModel entry)
```
    Set the read-only flag of a directory entry. To be used by EntryAdaptor implementations for instance.
    
    Since:
    
    5.3.2
  - setReadWriteEntry
```
public static void setReadWriteEntry(DocumentModel entry)
```
    Unset the read-only flag of a directory entry. To be used by EntryAdaptor implementations for instance.
    
    Since:
    
    5.3.2
  - computeMultiTenantDirectoryId
```
public static String computeMultiTenantDirectoryId(String tenantId,
                                                   String id)
```
    Compute a multi tenant directory id based on the given tenantId.
    
    Returns:
    
    the computed directory id
    
    Since:
    
    5.6
  - 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
  - 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.
  - getEntryFromSource
```
public DocumentModel getEntryFromSource(String id,
                                        boolean fetchReferences)
                                 throws DirectoryException
```
    Specified by:
    
    getEntryFromSource in interface EntrySource
    
    Throws:
    
    DirectoryException
  - createEntry
```
public DocumentModel createEntry(DocumentModel documentModel)
```
    Description copied from interface: Session
    
    Creates an entry in a directory.
    
    Specified by:
    
    createEntry in interface Session
    
    Parameters:
    
    documentModel - the document model representing the entry to create
    
    Returns:
    
    The new entry created in the directory
  - 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
    
    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
    
    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
    
    Parameters:
    
    docModel - The entry to delete
    
    Throws:
    
    DirectoryException - if a communication error occurs
  - deleteEntry
```
@Deprecated
public void deleteEntry(String id,
                                    Map<String,String> map)
                             throws DirectoryException
```
    Deprecated.
    
    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 secondary key values.
    
    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
    
    Parameters:
    
    id - the id of the entry to delete
    
    Throws:
    
    DirectoryException - if a communication error occurs
  - 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)
                        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.
  - 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,
                               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
    
    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)
  - 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
  - createEntryWithoutReferences
```
protected abstract DocumentModel createEntryWithoutReferences(Map<String,Object> fieldMap)
```
    To be implemented for specific creation.
  - updateEntryWithoutReferences
```
protected abstract List<String> updateEntryWithoutReferences(DocumentModel docModel)
                                                      throws DirectoryException
```
    To be implemented for specific update.
    
    Throws:
    
    DirectoryException
  - deleteEntryWithoutReferences
```
protected abstract void deleteEntryWithoutReferences(String id)
                                              throws DirectoryException
```
    To be implemented for specific deletion.
    
    Throws:
    
    DirectoryException

Class BaseSession

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

POWER_USERS_GROUP

READONLY_ENTRY_FLAG

MULTI_TENANT_ID_FORMAT

directory

permissions

readAllColumns

schemaName

directoryName

substringMatchType

referenceClass

passwordHashAlgorithm

autoincrementId

Constructor Detail

BaseSession

Method Detail

getDirectory

setReadAllColumns

getIdField

getPasswordField

isAuthenticating

isReadOnly

checkPermission

checkDeleteConstraints

hasPermission

hasPermission

createEntryModel

createEntryModel

isReadOnlyEntry

setReadOnlyEntry

setReadWriteEntry

computeMultiTenantDirectoryId

getEntry

getEntry

getEntries

getEntryFromSource

createEntry

createEntry

updateEntry

deleteEntry

deleteEntry

deleteEntry

query

query

query

query

query

getProjection

getProjection

createEntryWithoutReferences

updateEntryWithoutReferences

deleteEntryWithoutReferences