org.nuxeo.ecm.directory.api
Interface DirectoryService

All Known Subinterfaces:

DirectoryManager, DirectoryManagerLocal

All Known Implementing Classes:

DirectoryManagerBean, DirectoryServiceImpl

public interface DirectoryService

Author:

George Lefter

Field Summary

static ComponentName

NAME

Method Summary

java.util.List<Directory>	getDirectories()
Directory	getDirectory(java.lang.String name)
java.lang.String	getDirectoryIdField(java.lang.String directoryName)
java.util.List<java.lang.String>	getDirectoryNames()
java.lang.String	getDirectoryPasswordField(java.lang.String directoryName)
java.lang.String	getDirectorySchema(java.lang.String directoryName)
java.lang.String	getParentDirectoryName(java.lang.String directoryName) Returns the name of the parent directory of specified directory, if applicable.
Session	open(java.lang.String directoryName) Opens a session on specified directory.
void	registerDirectory(java.lang.String directoryName, DirectoryFactory factory)
void	unregisterDirectory(java.lang.String directoryName, DirectoryFactory factory)

Field Detail

NAME

static final ComponentName NAME

Method Detail

getDirectoryNames

java.util.List<java.lang.String> getDirectoryNames()
                                                   throws ClientException

Throws:

ClientException

getDirectorySchema

java.lang.String getDirectorySchema(java.lang.String directoryName)
                                    throws DirectoryException

Throws:

DirectoryException

open

Session open(java.lang.String directoryName)
             throws DirectoryException

Opens a session on specified directory.

This method prefers to throw rather than returning null.

Parameters:

directoryName -

Returns:

the session

Throws:

DirectoryException - in case the session cannot be created

getDirectory

Directory getDirectory(java.lang.String name)
                       throws DirectoryException

Throws:

DirectoryException

getDirectories

java.util.List<Directory> getDirectories()
                                         throws DirectoryException

Throws:

DirectoryException

registerDirectory

void registerDirectory(java.lang.String directoryName,
                       DirectoryFactory factory)

unregisterDirectory

void unregisterDirectory(java.lang.String directoryName,
                         DirectoryFactory factory)

getDirectoryIdField

java.lang.String getDirectoryIdField(java.lang.String directoryName)
                                     throws DirectoryException

Throws:

DirectoryException

getDirectoryPasswordField

java.lang.String getDirectoryPasswordField(java.lang.String directoryName)
                                           throws DirectoryException

Throws:

DirectoryException

getParentDirectoryName

java.lang.String getParentDirectoryName(java.lang.String directoryName)
                                        throws DirectoryException

Returns the name of the parent directory of specified directory, if applicable.

Parameters:

directoryName -

Returns:

the name, or null

Throws:

DirectoryException