|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
DirectoryCache |
getCache()
Gets the cache instance of the directory |
java.lang.String |
getIdField()
Gets the id field of the schema for this directory. |
IdGenerator |
getIdGenerator()
Gets the ID generator used when creating new entries in this directory. |
java.lang.String |
getName()
Gets the unique name of the directory, used for registering. |
java.lang.String |
getParentDirectory()
Gets the name of the parent directory. |
java.lang.String |
getPasswordField()
Gets the password field of the schema for this directory. |
Reference |
getReference(java.lang.String referenceFieldName)
Lookup a Reference by field name. |
java.util.Collection<Reference> |
getReferences()
Lookup all References defined on the directory. |
java.lang.String |
getSchema()
Gets the schema name used by this directory. |
Session |
getSession()
Creates a session for accessing entries in this directory. |
void |
invalidateDirectoryCache()
Invalidates the cache instance of the directory |
void |
shutdown()
Shuts down the directory. |
Method Detail |
---|
java.lang.String getName() throws DirectoryException
DirectoryException
java.lang.String getSchema() throws DirectoryException
DirectoryException
java.lang.String getParentDirectory() throws DirectoryException
DirectoryException
java.lang.String getIdField() throws DirectoryException
DirectoryException
java.lang.String getPasswordField() throws DirectoryException
DirectoryException
IdGenerator getIdGenerator() throws DirectoryException
DirectoryException
void shutdown() throws DirectoryException
DirectoryException
Session getSession() throws DirectoryException
DirectoryException
- if a session cannot be createdReference getReference(java.lang.String referenceFieldName) throws DirectoryException
DirectoryException
java.util.Collection<Reference> getReferences() throws DirectoryException
DirectoryException
DirectoryCache getCache() throws DirectoryException
DirectoryException
void invalidateDirectoryCache() throws DirectoryException
DirectoryException
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |