Package org.nuxeo.ecm.directory.multi

Class MultiDirectorySession

  • All Implemented Interfaces:
    AutoCloseable, EntrySource, Session
    public class MultiDirectorySession
extends BaseSession
    Directory session aggregating entries from different sources.

    Each source can build an entry aggregating fields from one or several directories.

    Author:
    Florent Guillaume, Anahide Tchertchian

    • Constructor Detail

      • MultiDirectorySession

        public MultiDirectorySession​(MultiDirectory directory)

    • Method Detail

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

      • getName

        public String getName()

      • 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

      • getEntry

        public DocumentModel getEntry​(String id,
                              boolean fetchReferences)
        Description copied from interface: Session
        Retrieves a directory entry using its id.
        Specified by:
        getEntry in interface Session
        Overrides:
        getEntry in class BaseSession
        Parameters:
        id - the entry id
        fetchReferences - boolean stating if references have to be fetched
        Returns:
        a DocumentModel representing the entry

      • getEntries

        public DocumentModelList getEntries()
        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
        Overrides:
        getEntries in class BaseSession
        Returns:
        a collection with all the entries in the directory

      • deleteEntry

        public void deleteEntry​(String id)
        Description copied from interface: Session
        Deletes a directory entry by id.
        Specified by:
        deleteEntry in interface Session
        Overrides:
        deleteEntry in class BaseSession
        Parameters:
        id - the id of the entry to delete

      • deleteEntry

        public void deleteEntry​(String id,
                        Map<String,​String> map)
        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
        Overrides:
        deleteEntry in class BaseSession
        Parameters:
        id - the id of the entry to delete.
        map - a map of secondary key values.

      • setProperties

        protected static void setProperties​(DocumentModel doc,
                                    String schema,
                                    Map<String,​Object> map)
        Sets the properties of the given doc and schema to the values provided by the given map, ensuring that any null value gets transformed to an empty string for a string property.

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

      • query

        public DocumentModelList query​(QueryBuilder queryBuilder,
                               boolean fetchReferences)
        Description copied from interface: Session
        Executes a query with the possibility to fetch a subset of the results.
        Parameters:
        queryBuilder - the query to use, including limit, offset, ordering and countTotal
        fetchReferences - boolean stating if references have to be fetched
        Returns:
        the list of documents, where the total size may be present if countTotal was true

      • queryIds

        public List<String> queryIds​(QueryBuilder queryBuilder)
        Description copied from interface: Session
        Executes a query with the possibility to fetch a subset of the results. Returns the matching ids.
        Parameters:
        queryBuilder - the query to use, including limit, offset and ordering
        Returns:
        the list of document ids

      • createEntry

        public DocumentModel createEntry​(DocumentModel entry)
        Description copied from interface: Session
        Creates an entry in a directory.
        Specified by:
        createEntry in interface Session
        Overrides:
        createEntry in class BaseSession
        Parameters:
        entry - the document model representing the entry to create
        Returns:
        The new entry created in the directory

      • hasEntry

        public boolean hasEntry​(String id)
        Description copied from interface: Session
        Returns true if session has an entry with given id.