Package org.nuxeo.ecm.directory.sql

Class SQLSession

java.lang.Object

org.nuxeo.ecm.directory.BaseSession

org.nuxeo.ecm.directory.sql.SQLSession

All Implemented Interfaces:

AutoCloseable, EntrySource, Session

public class SQLSession
extends BaseSession

This class represents a session against an SQLDirectory.

Nested Class Summary

Nested classes/interfaces inherited from class org.nuxeo.ecm.directory.BaseSession

BaseSession.FieldDetector

Field Summary

Fields

Modifier and Type	Field	Description
protected final Dialect	dialect
protected JDBCLogger	logger
protected SQLStaticFilter[]	staticFilters

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

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

Constructor Summary

Constructors

Constructor	Description
SQLSession(SQLDirectory directory, SQLDirectoryDescriptor config)

Method Summary

Modifier and Type	Method	Description
protected void	addFilterValues(PreparedStatement ps, int startIdx)
protected void	addFilterValuesForLog(List<Serializable> values)
protected String	addFilterWhereClause(String whereClause)
protected void	addFilterWhereClause(StringBuilder clause, List<SQLQueryBuilder.ColumnAndValue> params)
boolean	authenticate(String username, String password)	Checks that the credentials provided by the UserManager match those registered in the directory.
protected String	buildIdWhereClause()
protected void	checkConcurrentUpdate(Throwable e)	Checks the SQL error we got and determine if a concurrent update happened.
void	close()	Closes the session and all open result sets obtained from this session.
protected DocumentModel	createEntryWithoutReferences(Map<String,Object> fieldMap)	Creates an entry to the directory without creating its references.
protected DocumentModel	doCreateEntryWithoutReferences(Map<String,Object> fieldMap)	To be implemented for specific creation.
void	doDeleteEntryWithoutReferences(String entryId)	To be implemented for specific deletion.
protected DocumentModelList	doQuery(DirectoryQueryBuilder queryBuilder)	To be implemented for specific querying.
protected List<String>	doQueryIds(DirectoryQueryBuilder queryBuilder)	To be implemented for specific querying.
protected List<String>	doUpdateEntryWithoutReferences(DocumentModel docModel)	To be implemented for specific update.
protected DocumentModel	fieldMapToDocumentModel(Map<String,Object> fieldMap)
protected Serializable	fieldValueForWrite(Object value, Column column)
protected void	fillPreparedStatementFields(Map<String,Object> filterMap, List<Column> orderedColumns, PreparedStatement ps)
SQLDirectory	getDirectory()	To be implemented with a more specific return type.
DocumentModel	getEntryFromSource(String idOrSysId, boolean fetchReferences)
protected Column	getIdColumn()
protected String	getPassword(String id)	Internal method to read the hashed password for authentication.
protected List<Column>	getReadColumns()
protected String	getReadColumnsSQL()
boolean	hasEntry(String idOrSysId)	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).
boolean	isLive()	Enable connection status checking on SQL directory connections
protected PreparedStatement	prepareStatementWithAutoKeys(String sql)	Create a PreparedStatement returning the id key if it is auto-incremented and dialect has identity generated key (Dialect.hasIdentityGeneratedKey()).
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. org.nuxeo.ecm.directory.BaseSession provides a default implementation fetching all results to return the subset.
protected void	setIdFieldInMap(ResultSet rs, Column column, String idFieldName, Map<String,Object> fieldMap)
String	toString()

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

addTenantId, applyQueryLimits, applyQueryLimits, canDeleteMultiTenantEntry, canDeleteMultiTenantEntry, checkDeleteConstraints, checkPermission, computeMultiTenantDirectoryId, createEntry, createEntry, createEntryModel, createEntryModel, createEntryModel, createEntryModel, createEntryModel, createEntryModel, createQueryBuilderForIds, createQueryBuilderWithConfiguredFiltering, createQueryBuilderWithConfiguredFiltering, deleteEntry, deleteEntry, deleteEntryWithoutReferences, getCurrentTenantId, getEntry, getIdField, getPasswordField, getPrefixedFieldName, getPrefixedIdField, getProjection, getProjection, hasPermission, hasPermission, isMultiTenant, isReadOnly, isReadOnlyEntry, query, query, query, query, query, query, queryIds, setReadAllColumns, setReadOnlyEntry, setReadWriteEntry, toStringList, updateEntry, updateEntryWithoutReferences

Methods inherited from class java.lang.Object

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

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

createEntryModel, getEntry

Field Details

staticFilters

protected SQLStaticFilter[] staticFilters

dialect

protected final Dialect dialect

logger

protected JDBCLogger logger

Constructor Details

SQLSession

public SQLSession(SQLDirectory directory,
 SQLDirectoryDescriptor config)

Method Details

getDirectory

public SQLDirectory getDirectory()

Description copied from class: BaseSession

To be implemented with a more specific return type.

Specified by:

getDirectory in class BaseSession

getEntryFromSource

public DocumentModel getEntryFromSource(String idOrSysId,
 boolean fetchReferences)

Specified by:

getEntryFromSource in interface EntrySource

Overrides:

getEntryFromSource in class BaseSession

getReadColumns

protected List<Column> getReadColumns()

getReadColumnsSQL

protected String getReadColumnsSQL()

getIdColumn

protected Column getIdColumn()

fieldMapToDocumentModel

protected DocumentModel fieldMapToDocumentModel(Map<String,Object> fieldMap)

checkConcurrentUpdate

protected void checkConcurrentUpdate(Throwable e)
                              throws ConcurrentUpdateException

Checks the SQL error we got and determine if a concurrent update happened. Throws if that's the case.

Parameters:

e - the exception

Throws:

ConcurrentUpdateException

Since:

7.10-HF04, 8.2

buildIdWhereClause

protected String buildIdWhereClause()

addFilterWhereClause

protected String addFilterWhereClause(String whereClause)

addFilterWhereClause

protected void addFilterWhereClause(StringBuilder clause,
 List<SQLQueryBuilder.ColumnAndValue> params)

addFilterValues

protected void addFilterValues(PreparedStatement ps,
 int startIdx)

addFilterValuesForLog

protected void addFilterValuesForLog(List<Serializable> values)

getPassword

protected String getPassword(String id)

Internal method to read the hashed password for authentication.

Since:

9.1

query

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

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.

Parameters:

limit - maximum number of results ignored if less than 1

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

See Also:

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

doQuery

protected DocumentModelList doQuery(DirectoryQueryBuilder queryBuilder)

Description copied from class: BaseSession

To be implemented for specific querying.

Overrides:

doQuery in class BaseSession

See Also:

• BaseSession.query(QueryBuilder)

doQueryIds

protected List<String> doQueryIds(DirectoryQueryBuilder queryBuilder)

Description copied from class: BaseSession

To be implemented for specific querying.

Overrides:

doQueryIds in class BaseSession

See Also:

• BaseSession.queryIds(QueryBuilder)

createEntryWithoutReferences

protected DocumentModel createEntryWithoutReferences(Map<String,Object> fieldMap)

Description copied from class: BaseSession

Creates an entry to the directory without creating its references.

Overrides:

createEntryWithoutReferences in class BaseSession

doCreateEntryWithoutReferences

protected DocumentModel doCreateEntryWithoutReferences(Map<String,Object> fieldMap)

Description copied from class: BaseSession

To be implemented for specific creation.

Overrides:

doCreateEntryWithoutReferences in class BaseSession

setIdFieldInMap

protected void setIdFieldInMap(ResultSet rs,
 Column column,
 String idFieldName,
 Map<String,Object> fieldMap)
                        throws SQLException

Throws:

SQLException

prepareStatementWithAutoKeys

protected PreparedStatement prepareStatementWithAutoKeys(String sql)
                                                  throws SQLException

Create a PreparedStatement returning the id key if it is auto-incremented and dialect has identity generated key (Dialect.hasIdentityGeneratedKey()).

Throws:

SQLException

Since:

10.1

doUpdateEntryWithoutReferences

protected List<String> doUpdateEntryWithoutReferences(DocumentModel docModel)

Description copied from class: BaseSession

To be implemented for specific update.

Overrides:

doUpdateEntryWithoutReferences in class BaseSession

doDeleteEntryWithoutReferences

public void doDeleteEntryWithoutReferences(String entryId)

Description copied from class: BaseSession

To be implemented for specific deletion.

Overrides:

doDeleteEntryWithoutReferences in class BaseSession

fillPreparedStatementFields

protected void fillPreparedStatementFields(Map<String,Object> filterMap,
 List<Column> orderedColumns,
 PreparedStatement ps)

fieldValueForWrite

protected Serializable fieldValueForWrite(Object value,
 Column column)

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?

isLive

public boolean isLive()

Enable connection status checking on SQL directory connections

Since:

5.7.2

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

Description copied from interface: Session

Returns true if session has an entry with given id.

Specified by:

hasEntry in interface Session

Overrides:

hasEntry in class BaseSession

toString

public String toString()

Overrides:

toString in class Object