|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Session
A session used to access entries in a directory.
This class is used to create, obtain, modify and delete entries in a directory.
,
Directory.getSession()
Method Summary | |
---|---|
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. |
void |
commit()
Deprecated. do not use, the container manages transactions. |
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. |
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. |
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 |
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 |
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 |
void |
rollback()
Deprecated. do not use, the container manages transactions. |
void |
updateEntry(DocumentModel docModel)
Updates a directory entry. |
Method Detail |
---|
DocumentModel getEntry(String id) throws DirectoryException
TODO what happens when the entry is not found? return null if not found?
id
- the entry id
DirectoryException
DocumentModel getEntry(String id, boolean fetchReferences) throws DirectoryException
id
- the entry idfetchReferences
- boolean stating if references have to be fetched
DirectoryException
DocumentModelList getEntries() throws ClientException, DirectoryException
DirectoryException
SizeLimitExceededException
- if the number of results is larger
than the limit configured for the directory
ClientException
DocumentModel createEntry(Map<String,Object> fieldMap) throws ClientException, DirectoryException
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
UnsupportedOperationException
- if the directory does not allow the
creation of new entries
DirectoryException
- if a communication exception occurs or if an
entry with the same id already exists.
ClientException
void updateEntry(DocumentModel docModel) throws ClientException, DirectoryException
docModel
- The entry to update
UnsupportedOperationException
- if the directory does not support
entry updating
DirectoryException
- if a communication error occurs
ClientException
void deleteEntry(DocumentModel docModel) throws ClientException, DirectoryException
docModel
- The entry to delete
UnsupportedOperationException
- if the directory does not support
entry deleting
DirectoryException
- if a communication error occurs
ClientException
void deleteEntry(String id) throws ClientException, DirectoryException
id
- the id of the entry to delete
UnsupportedOperationException
- if the directory does not support
entry deleting
DirectoryException
- if a communication error occurs
ClientException
void deleteEntry(String id, Map<String,String> map) throws DirectoryException
This is used for hierarchical vocabularies, where the actual unique key is the couple (parent, id).
id
- the id of the entry to delete.map
- a map of seconday key values.
DirectoryException
- if a communication error occurs.DocumentModelList query(Map<String,Serializable> filter) throws ClientException, DirectoryException
Does not fetch reference fields.
filter
- a filter to apply to entries in directory
DirectoryException
- if a communication error occurs
SizeLimitExceededException
- if the number of results is larger
than the limit configured for the directory
ClientException
DocumentModelList query(Map<String,Serializable> filter, Set<String> fulltext) throws ClientException, DirectoryException
fieldNames present in the fulltext set are treated as a fulltext match. Does not fetch reference fields.
filter
- a filter to apply to entries in directoryfulltext
- a set of field that should be treated as a fulltext
search
DirectoryException
- if a communication error occurs
SizeLimitExceededException
- if the number of results is larger
than the limit configured for the directory
ClientException
DocumentModelList query(Map<String,Serializable> filter, Set<String> fulltext, Map<String,String> orderBy) throws ClientException, DirectoryException
fieldNames present in the fulltext set are treated as a fulltext match. Does not fetch reference fields.
filter
- a filter to apply to entries in directoryorderBy
- 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'.fulltext
- a set of field that should be treated as a fulltext
search
DirectoryException
- if a communication error occurs
SizeLimitExceededException
- if the number of results is larger
than the limit configured for the directory
ClientException
DocumentModelList query(Map<String,Serializable> filter, Set<String> fulltext, Map<String,String> orderBy, boolean fetchReferences) throws ClientException, DirectoryException
ClientException
DirectoryException
query(Map, Set, Map)
@Deprecated void commit() throws ClientException, DirectoryException
ClientException
DirectoryException
@Deprecated void rollback() throws ClientException, DirectoryException
ClientException
DirectoryException
void close() throws DirectoryException
Releases this Connection object's resources immediately instead of waiting for them to be automatically released.
TODO: should this operation auto-commit pending changes?
DirectoryException
- if a communication error occursList<String> getProjection(Map<String,Serializable> filter, String columnName) throws ClientException, DirectoryException
filter
- the filter for the querycolumnName
- the column whose content should be returned
DirectoryException
SizeLimitExceededException
- if the number of results is larger
than the limit configured for the directory
ClientException
List<String> getProjection(Map<String,Serializable> filter, Set<String> fulltext, String columnName) throws ClientException, DirectoryException
ClientException
DirectoryException
boolean isAuthenticating() throws ClientException, DirectoryException
DirectoryException
ClientException
boolean authenticate(String username, String password) throws ClientException, DirectoryException
username
- password
-
ClientException
DirectoryException
String getIdField() throws ClientException
ClientException
String getPasswordField() throws ClientException
ClientException
boolean isReadOnly() throws ClientException
ClientException
boolean hasEntry(String id) throws ClientException
ClientException
DocumentModel createEntry(DocumentModel entry) throws ClientException
entry
- the document model representing the entry to create
UnsupportedOperationException
- if the directory does not allow the
creation of new entries
ClientException
- if a communication exception occurs or if an
entry with the same id already exists.
|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |