Nuxeo Enterprise Platform 5.1

org.nuxeo.ecm.directory
Class DirectoryServiceImpl

java.lang.Object
  extended by org.nuxeo.runtime.model.DefaultComponent
      extended by org.nuxeo.ecm.directory.DirectoryServiceImpl
All Implemented Interfaces:
DirectoryService, Adaptable, Component, Extensible

public class DirectoryServiceImpl
extends DefaultComponent
implements DirectoryService


Field Summary
static ComponentName NAME
           
 
Constructor Summary
DirectoryServiceImpl()
           
 
Method Summary
 void activate(ComponentContext context)
          Activates the component.
 void deactivate(ComponentContext context)
          Deactivates the component.
 List<Directory> getDirectories()
           
 Directory getDirectory(String name)
           
 String getDirectoryIdField(String directoryName)
           
 List<String> getDirectoryNames()
           
 String getDirectoryPasswordField(String directoryName)
           
 String getDirectorySchema(String directoryName)
           
 Session open(String directoryName)
           
 void registerDirectory(String directoryName, DirectoryFactory factory)
           
 void registerExtension(Extension extension)
          Registers the given extension.
 void unregisterDirectory(String directoryName, DirectoryFactory factory)
           
 void unregisterExtension(Extension extension)
          Unregisters the given extension.
 
Methods inherited from class org.nuxeo.runtime.model.DefaultComponent
getAdapter, registerContribution, unregisterContribution
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAME

public static final ComponentName NAME
Constructor Detail

DirectoryServiceImpl

public DirectoryServiceImpl()
Method Detail

getDirectory

public Directory getDirectory(String name)
                       throws DirectoryException
Throws:
DirectoryException

getDirectories

public List<Directory> getDirectories()
                               throws DirectoryException
Throws:
DirectoryException

activate

public void activate(ComponentContext context)
              throws Exception
Description copied from interface: Component
Activates the component.

This method will be called by the runtime when a component is activated.

Specified by:
activate in interface Component
Overrides:
activate in class DefaultComponent
Parameters:
context - the runtime context
Throws:
Exception - if an error occurs during activation

deactivate

public void deactivate(ComponentContext context)
                throws Exception
Description copied from interface: Component
Deactivates the component.

This method will be called by the runtime when a component is deactivated.

Specified by:
deactivate in interface Component
Overrides:
deactivate in class DefaultComponent
Parameters:
context - the runtime context
Throws:
Exception - if an error occurs during activation

registerExtension

public void registerExtension(Extension extension)
                       throws Exception
Description copied from interface: Extensible
Registers the given extension.

Specified by:
registerExtension in interface Extensible
Overrides:
registerExtension in class DefaultComponent
Parameters:
extension - the extension to register
Throws:
Exception - if any error occurs

unregisterExtension

public void unregisterExtension(Extension extension)
                         throws Exception
Description copied from interface: Extensible
Unregisters the given extension.

Specified by:
unregisterExtension in interface Extensible
Overrides:
unregisterExtension in class DefaultComponent
Parameters:
extension - the extension to unregister
Throws:
Exception - if any error occurs

registerDirectory

public void registerDirectory(String directoryName,
                              DirectoryFactory factory)

unregisterDirectory

public void unregisterDirectory(String directoryName,
                                DirectoryFactory factory)

getDirectoryNames

public List<String> getDirectoryNames()
                               throws DirectoryException
Specified by:
getDirectoryNames in interface DirectoryService
Throws:
DirectoryException

getDirectorySchema

public String getDirectorySchema(String directoryName)
                          throws DirectoryException
Specified by:
getDirectorySchema in interface DirectoryService
Throws:
DirectoryException

getDirectoryIdField

public String getDirectoryIdField(String directoryName)
                           throws DirectoryException
Throws:
DirectoryException

getDirectoryPasswordField

public String getDirectoryPasswordField(String directoryName)
                                 throws DirectoryException
Throws:
DirectoryException

open

public Session open(String directoryName)
             throws DirectoryException
Specified by:
open in interface DirectoryService
Throws:
DirectoryException

Nuxeo Enterprise Platform 5.1

Copyright ? 2007 Nuxeo SAS. All Rights Reserved.