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:

glefter@nuxeo.com

Method Summary

Modifier and Type	Method and Description
DirectoryCache	getCache() Gets the cache instance of the directory
BaseDirectoryDescriptor	getDescriptor() Get descriptor
List<DirectoryDeleteConstraint>	getDirectoryDeleteConstraints()
String	getIdField() Gets the id field of the schema for this directory.
String	getName() Gets the unique name of the directory, used for registering.
String	getParentDirectory() Gets the name of the parent directory.
String	getPasswordField() Gets the password field of the schema for this directory.
Reference	getReference(String referenceFieldName) Deprecated. since 7.4, kept for compatibility with old code, use getReferences(String) instead
Collection<Reference>	getReferences() Lookup all References defined on the directory.
List<Reference>	getReferences(String referenceFieldName) Lookup the References by field name.
String	getSchema() Gets the schema name used by this directory.
Map<String,Field>	getSchemaFieldMap() Get schema field map
Session	getSession() Creates a session for accessing entries in this directory.
List<String>	getTypes()
void	invalidateCaches() Invalidate caches
void	invalidateDirectoryCache() Invalidates the cache instance of the directory
boolean	isMultiTenant() Returns true if this directory is a multi tenant directory, false otherwise.
boolean	isReadOnly() Checks if this directory is read-only.
void	shutdown() Shuts down the directory.

Method Detail

getName

String getName()
        throws DirectoryException

Gets the unique name of the directory, used for registering.

Returns:

the unique directory name

Throws:

DirectoryException

getSchema

String getSchema()
          throws DirectoryException

Gets the schema name used by this directory.

Returns:

the schema name

Throws:

DirectoryException

getParentDirectory

String getParentDirectory()
                   throws DirectoryException

Gets the name of the parent directory. This is used for hierarchical vocabularies.

Returns:

the name of the parent directory, or null.

Throws:

DirectoryException

getIdField

String getIdField()
           throws DirectoryException

Gets the id field of the schema for this directory.

Returns:

the id field.

Throws:

DirectoryException

getPasswordField

String getPasswordField()
                 throws DirectoryException

Gets the password field of the schema for this directory.

Returns:

the password field.

Throws:

DirectoryException

isReadOnly

boolean isReadOnly()

Checks if this directory is read-only.

Since:

8.2

shutdown

void shutdown()
       throws DirectoryException

Shuts down the directory.

Throws:

DirectoryException

getSession

Session getSession()
            throws DirectoryException

Creates a session for accessing entries in this directory.

Returns:

a Session object

Throws:

DirectoryException - if a session cannot be created

getReference

@Deprecated
Reference getReference(String referenceFieldName)
                            throws DirectoryException

Deprecated. since 7.4, kept for compatibility with old code, use getReferences(String) instead

Lookup a Reference by field name.

Returns:

the matching reference implementation or null

Throws:

DirectoryException

getReferences

List<Reference> getReferences(String referenceFieldName)
                       throws DirectoryException

Lookup the References by field name.

Returns:

the matching references implementation or null

Throws:

DirectoryException

getReferences

Collection<Reference> getReferences()
                             throws DirectoryException

Lookup all References defined on the directory.

Returns:

all registered references

Throws:

DirectoryException

getCache

DirectoryCache getCache()
                 throws DirectoryException

Gets the cache instance of the directory

Returns:

the cache of the directory

Throws:

DirectoryException

invalidateDirectoryCache

void invalidateDirectoryCache()
                       throws DirectoryException

Invalidates the cache instance of the directory

Throws:

DirectoryException

isMultiTenant

boolean isMultiTenant()
               throws DirectoryException

Returns true if this directory is a multi tenant directory, false otherwise.

Throws:

DirectoryException

Since:

5.6

getTypes

List<String> getTypes()

Since:

8.4

getDirectoryDeleteConstraints

List<DirectoryDeleteConstraint> getDirectoryDeleteConstraints()

Since:

8.4

invalidateCaches

void invalidateCaches()
               throws DirectoryException

Invalidate caches

Throws:

DirectoryException

Since:

9.2

getSchemaFieldMap

Map<String,Field> getSchemaFieldMap()

Get schema field map

Since:

9.2

getDescriptor

BaseDirectoryDescriptor getDescriptor()

Get descriptor

Since:

9.2