org.nuxeo.ecm.directory.sql

Class SQLSession

java.lang.Object

org.nuxeo.ecm.directory.BaseSession

org.nuxeo.ecm.directory.sql.SQLSession

All Implemented Interfaces:

EntrySource, Session

public class SQLSession
extends BaseSession
implements EntrySource

This class represents a session against an SQLDirectory.

Constructor Summary

Constructors

Constructor and Description
SQLSession(SQLDirectory directory, SQLDirectoryDescriptor config, boolean managedSQLSession)

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.
DocumentModel	createEntry(DocumentModel entry) Creates an entry in a directory.
DocumentModel	createEntry(Map<String,Object> fieldMap) Creates an entry in a directory.
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.
Directory	getDirectory()
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.
Connection	getSqlConnection() Public getter to allow custom Reference implementation to access the current connection even if it lives in a separate java package, typically: com.company.custom.nuxeo.project.MyCustomReference
boolean	hasEntry(String id) 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
boolean	isReadOnly()
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.
String	toString()
void	updateEntry(DocumentModel docModel) Updates a directory entry.

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

computeMultiTenantDirectoryId, createEntryModel, createEntryModel, isCurrentUserAllowed, isReadOnlyEntry, setReadOnlyEntry, setReadWriteEntry

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLSession

public SQLSession(SQLDirectory directory,
                  SQLDirectoryDescriptor config,
                  boolean managedSQLSession)
           throws DirectoryException

Throws:

DirectoryException

Method Detail

getDirectory

public Directory getDirectory()

createEntry

public DocumentModel createEntry(Map<String,Object> fieldMap)
                          throws ClientException

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.

ClientException

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

getEntryFromSource

public DocumentModel getEntryFromSource(String id,
                                        boolean fetchReferences)
                                 throws DirectoryException

Specified by:

getEntryFromSource in interface EntrySource

Throws:

DirectoryException

getEntries

public DocumentModelList getEntries()
                             throws ClientException

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.

ClientException

updateEntry

public void updateEntry(DocumentModel docModel)
                 throws ClientException

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

ClientException

deleteEntry

public void deleteEntry(DocumentModel docModel)
                 throws ClientException

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

ClientException

deleteEntry

public void deleteEntry(String id)
                 throws ClientException

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

ClientException

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

Parameters:

id - the id of the entry to delete.

map - a map of seconday key values.

Throws:

DirectoryException - if a communication error occurs.

query

public DocumentModelList query(Map<String,Serializable> filter,
                               Set<String> fulltext,
                               Map<String,String> orderBy)
                        throws ClientException

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.

ClientException

query

public DocumentModelList query(Map<String,Serializable> filter,
                               Set<String> fulltext,
                               Map<String,String> orderBy,
                               boolean fetchReferences)
                        throws ClientException

Description copied from interface: Session

Executes a query with the possibility to fetch references

Specified by:

query in interface Session

Throws:

ClientException

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

Overrides:

query in class BaseSession

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)

query

public DocumentModelList query(Map<String,Serializable> filter)
                        throws ClientException

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.

ClientException

close

public void close()
           throws DirectoryException

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?

Specified by:

close in interface Session

Throws:

DirectoryException - if a communication error occurs

isLive

public boolean isLive()
               throws DirectoryException

Enable connection status checking on SQL directory connections

Throws:

DirectoryException

Since:

5.7.2

getProjection

public List<String> getProjection(Map<String,Serializable> filter,
                                  Set<String> fulltext,
                                  String columnName)
                           throws ClientException

Specified by:

getProjection in interface Session

Throws:

ClientException

getProjection

public List<String> getProjection(Map<String,Serializable> filter,
                                  String columnName)
                           throws ClientException

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

ClientException

authenticate

public boolean authenticate(String username,
                            String password)
                     throws ClientException

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.

Specified by:

authenticate in interface Session

Returns:

true is the credentials match those stored in the directory

Throws:

ClientException

isAuthenticating

public boolean isAuthenticating()
                         throws ClientException

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

Throws:

DirectoryException

ClientException

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)

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface Session

query

public DocumentModelList query(Map<String,Serializable> filter,
                               Set<String> fulltext)
                        throws ClientException

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.

ClientException

createEntry

public DocumentModel createEntry(DocumentModel entry)
                          throws ClientException

Description copied from interface: Session

Creates an entry in a directory.

Specified by:

createEntry in interface Session

Parameters:

entry - the document model representing the entry to create

Returns:

The new entry created in the directory

Throws:

ClientException - if a communication exception occurs or if an entry with the same id already exists.

hasEntry

public boolean hasEntry(String id)
                 throws ClientException

Description copied from interface: Session

Returns true if session has an entry with given id.

Specified by:

hasEntry in interface Session

Throws:

ClientException

getSqlConnection

public Connection getSqlConnection()

Public getter to allow custom Reference implementation to access the current connection even if it lives in a separate java package, typically: com.company.custom.nuxeo.project.MyCustomReference

Returns:

the current Connection instance

toString

public String toString()

Overrides:

toString in class Object