org.nuxeo.ecm.directory

Class BaseSession

java.lang.Object

org.nuxeo.ecm.directory.BaseSession

All Implemented Interfaces:

AutoCloseable, Session

Direct Known Subclasses:

CoreDirectorySession, 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

Field Summary

Fields

Modifier and Type	Field and Description
protected Directory	directory
protected static String	MULTI_TENANT_ID_FORMAT
protected PermissionDescriptor[]	permissions
protected static String	POWER_USERS_GROUP
protected static String	READONLY_ENTRY_FLAG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseSession(Directory directory)

Method Summary

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.
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.
abstract Directory	getDirectory() To be implemented with a more specific return type.
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()
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.
protected static Map<String,Object>	mkObjectMap(Map<String,Serializable> map)
protected static Map<String,Serializable>	mkSerializableMap(Map<String,Object> map)
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

clone, equals, finalize, 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, getProjection, getProjection, hasEntry, query, query, query, query, updateEntry

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

Constructor Detail

BaseSession

protected BaseSession(Directory directory)

Method Detail

getDirectory

public abstract Directory getDirectory()

To be implemented with a more specific return type.

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

mkSerializableMap

protected static Map<String,Serializable> mkSerializableMap(Map<String,Object> map)

mkObjectMap

protected static Map<String,Object> mkObjectMap(Map<String,Serializable> map)

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