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

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

Field Detail

NAME

static final ComponentName NAME

Method Detail

getDirectoryNames

List<String> getDirectoryNames()
                               throws ClientException

Throws:

ClientException

getDirectorySchema

String getDirectorySchema(String directoryName)
                          throws DirectoryException

Throws:

DirectoryException

open

Session open(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(String name)
                       throws DirectoryException

Throws:

DirectoryException

getDirectories

List<Directory> getDirectories()
                               throws DirectoryException

Throws:

DirectoryException

registerDirectory

void registerDirectory(String directoryName,
                       DirectoryFactory factory)

unregisterDirectory

void unregisterDirectory(String directoryName,
                         DirectoryFactory factory)

getDirectoryIdField

String getDirectoryIdField(String directoryName)
                           throws DirectoryException

Throws:

DirectoryException

getDirectoryPasswordField

String getDirectoryPasswordField(String directoryName)
                                 throws DirectoryException

Throws:

DirectoryException

getParentDirectoryName

String getParentDirectoryName(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