Package org.nuxeo.ecm.directory

Interface Directory

All Known Implementing Classes:
AbstractDirectory, CoreDirectory, LDAPDirectory, MemoryDirectory, MongoDBDirectory, MultiDirectory, SQLDirectory
public interface Directory
The directory interface.

This interface is implemented in order to create an NXDirectory. One should implement this interface in order to create either a new Directory implementation or a new Directory Source.

Author:
[email protected]

  • Method Details

    • initialize

      void initialize()
      INTERNAL, DO NOT CALL. Initializes the directory when Nuxeo starts. Called without a transaction.
      Since:
      10.10

    • initializeReferences

      void initializeReferences()
      INTERNAL, DO NOT CALL. Initializes the directory when Nuxeo starts. Called without a transaction.
      Since:
      10.10

    • initializeInverseReferences

      void initializeInverseReferences()
      INTERNAL, DO NOT CALL. Initializes the directory when Nuxeo starts. Called without a transaction.
      Since:
      10.10

    • loadFromCSV

      void loadFromCSV(Blob dataBlob, String dataLoadingPolicy)
      Loads a CSV into a Directory.
      Since:
      11.1
      See Also:

    • getName

      String getName()
      Gets the unique name of the directory, used for registering.
      Returns:
      the unique directory name

    • getSchema

      String getSchema()
      Gets the schema name used by this directory.
      Returns:
      the schema name

    • getParentDirectory

      String getParentDirectory()
      Gets the name of the parent directory. This is used for hierarchical vocabularies.
      Returns:
      the name of the parent directory, or null.

    • getIdField

      String getIdField()
      Gets the id field of the schema for this directory.
      Returns:
      the id field.

    • getPasswordField

      String getPasswordField()
      Gets the password field of the schema for this directory.
      Returns:
      the password field.

    • isReadOnly

      boolean isReadOnly()
      Checks if this directory is read-only.
      Since:
      8.2

    • shutdown

      void shutdown()
      Shuts down the directory.

    • getSession

      Session getSession()
      Creates a session for accessing entries in this directory.
      Returns:
      a Session object

    • getReferences

      List<Reference> getReferences(String referenceFieldName)
      Lookup the References by field name.
      Returns:
      the matching references implementation or null

    • getReferences

      Collection<Reference> getReferences()
      Lookup all References defined on the directory.
      Returns:
      all registered references

    • getCache

      DirectoryCache getCache()
      Gets the cache instance of the directory
      Returns:
      the cache of the directory

    • invalidateDirectoryCache

      void invalidateDirectoryCache()
      Invalidates the cache instance of the directory

    • isMultiTenant

      boolean isMultiTenant()
      Returns true if this directory is a multi tenant directory, false otherwise.
      Since:
      5.6

    • getTypes

      List<String> getTypes()
      Since:
      8.4

    • getDirectoryDeleteConstraints

      List<DirectoryDeleteConstraint> getDirectoryDeleteConstraints()
      Since:
      8.4

    • invalidateCaches

      void invalidateCaches()
      Invalidate caches
      Since:
      9.2

    • getSchemaFieldMap

      Map<String,Field> getSchemaFieldMap()
      Get schema field map
      Since:
      9.2

    • getDescriptor

      BaseDirectoryDescriptor getDescriptor()
      Get descriptor
      Since:
      9.2