public interface Directory
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.
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.
|
String getName() throws DirectoryException
DirectoryException
String getSchema() throws DirectoryException
DirectoryException
String getParentDirectory() throws DirectoryException
DirectoryException
String getIdField() throws DirectoryException
DirectoryException
String getPasswordField() throws DirectoryException
DirectoryException
boolean isReadOnly()
void shutdown() throws DirectoryException
DirectoryException
Session getSession() throws DirectoryException
DirectoryException
- if a session cannot be created@Deprecated Reference getReference(String referenceFieldName) throws DirectoryException
getReferences(String)
insteadDirectoryException
List<Reference> getReferences(String referenceFieldName) throws DirectoryException
DirectoryException
Collection<Reference> getReferences() throws DirectoryException
DirectoryException
DirectoryCache getCache() throws DirectoryException
DirectoryException
void invalidateDirectoryCache() throws DirectoryException
DirectoryException
boolean isMultiTenant() throws DirectoryException
true
if this directory is a multi tenant directory, false
otherwise.DirectoryException
List<DirectoryDeleteConstraint> getDirectoryDeleteConstraints()
void invalidateCaches() throws DirectoryException
DirectoryException
Map<String,Field> getSchemaFieldMap()
BaseDirectoryDescriptor getDescriptor()
Copyright © 2017 Nuxeo. All rights reserved.