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 |
initialize()
INTERNAL, DO NOT CALL.
|
void |
initializeInverseReferences()
INTERNAL, DO NOT CALL.
|
void |
initializeReferences()
INTERNAL, DO NOT CALL.
|
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.
|
void initialize()
void initializeReferences()
void initializeInverseReferences()
String getName()
String getParentDirectory()
String getIdField()
String getPasswordField()
boolean isReadOnly()
void shutdown()
Session getSession()
@Deprecated Reference getReference(String referenceFieldName)
getReferences(String)
insteadList<Reference> getReferences(String referenceFieldName)
Collection<Reference> getReferences()
DirectoryCache getCache()
void invalidateDirectoryCache()
boolean isMultiTenant()
true
if this directory is a multi tenant directory, false
otherwise.List<DirectoryDeleteConstraint> getDirectoryDeleteConstraints()
void invalidateCaches()
Map<String,Field> getSchemaFieldMap()
BaseDirectoryDescriptor getDescriptor()
Copyright © 2019 Nuxeo. All rights reserved.