org.nuxeo.ecm.directory

Class BaseSession

java.lang.Object

org.nuxeo.ecm.directory.BaseSession

All Implemented Interfaces:

Session

Direct Known Subclasses:

LDAPSession, MemoryDirectorySession, MultiDirectorySession, SQLSession

public abstract class BaseSession
extends Object
implements Session

Base session class with helper methods common to all kinds of directory sessions.

Since:

5.2M4

Author:

Anahide Tchertchian

Constructor Summary

Constructors

Constructor and Description
BaseSession()

Method Summary

Methods

Modifier and Type	Method and Description
static String	computeMultiTenantDirectoryId(String tenantId, String id) Compute a multi tenant directory id based on the given tenantId.
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.
boolean	isCurrentUserAllowed(String permissionTocheck) Check the current user rights for the given permission against the permission descriptor
static boolean	isReadOnlyEntry(DocumentModel entry) Test whether entry comes from a read-only back-end directory.
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.
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.

Methods inherited from class java.lang.Object

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

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

authenticate, close, createEntry, createEntry, deleteEntry, deleteEntry, deleteEntry, getEntries, getEntry, getEntry, getIdField, getPasswordField, getProjection, getProjection, hasEntry, isAuthenticating, isReadOnly, query, query, query, query, updateEntry

Constructor Detail

BaseSession

public BaseSession()

Method Detail

isCurrentUserAllowed

public boolean isCurrentUserAllowed(String permissionTocheck)

Check the current user rights for the given permission against the permission descriptor

Returns:

true if the user

Since:

6.0

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

query

public DocumentModelList query(Map<String,Serializable> filter,
                      Set<String> fulltext,
                      Map<String,String> orderBy,
                      boolean fetchReferences,
                      int limit,
                      int offset)
                        throws ClientException,
                               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:

ClientException

DirectoryException

See Also:

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