|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.nuxeo.runtime.model.DefaultComponent org.nuxeo.ecm.directory.DirectoryServiceImpl
public class DirectoryServiceImpl
Field Summary |
---|
Fields inherited from interface org.nuxeo.ecm.directory.api.DirectoryService |
---|
NAME |
Constructor Summary | |
---|---|
DirectoryServiceImpl()
|
Method Summary | |
---|---|
void |
activate(ComponentContext context)
Activates the component. |
void |
deactivate(ComponentContext context)
Deactivates the component. |
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 |
registerExtension(Extension extension)
Registers the given extension. |
void |
unregisterDirectory(java.lang.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 |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DirectoryServiceImpl()
Method Detail |
---|
public Directory getDirectory(java.lang.String name) throws DirectoryException
getDirectory
in interface DirectoryService
DirectoryException
public java.util.List<Directory> getDirectories() throws DirectoryException
getDirectories
in interface DirectoryService
DirectoryException
public void activate(ComponentContext context) throws java.lang.Exception
Component
This method is called by the runtime when a component is activated.
activate
in interface Component
activate
in class DefaultComponent
context
- the runtime context
java.lang.Exception
- if an error occurs during activationpublic void deactivate(ComponentContext context) throws java.lang.Exception
Component
This method is called by the runtime when a component is deactivated.
deactivate
in interface Component
deactivate
in class DefaultComponent
context
- the runtime context
java.lang.Exception
- if an error occurs during activationpublic void registerExtension(Extension extension) throws java.lang.Exception
Extensible
registerExtension
in interface Extensible
registerExtension
in class DefaultComponent
extension
- the extension to register
java.lang.Exception
- if any error occurspublic void unregisterExtension(Extension extension) throws java.lang.Exception
Extensible
unregisterExtension
in interface Extensible
unregisterExtension
in class DefaultComponent
extension
- the extension to unregister
java.lang.Exception
- if any error occurspublic void registerDirectory(java.lang.String directoryName, DirectoryFactory factory)
registerDirectory
in interface DirectoryService
public void unregisterDirectory(java.lang.String directoryName, DirectoryFactory factory)
unregisterDirectory
in interface DirectoryService
public java.util.List<java.lang.String> getDirectoryNames() throws DirectoryException
getDirectoryNames
in interface DirectoryService
DirectoryException
public java.lang.String getDirectorySchema(java.lang.String directoryName) throws DirectoryException
getDirectorySchema
in interface DirectoryService
DirectoryException
public java.lang.String getDirectoryIdField(java.lang.String directoryName) throws DirectoryException
getDirectoryIdField
in interface DirectoryService
DirectoryException
public java.lang.String getDirectoryPasswordField(java.lang.String directoryName) throws DirectoryException
getDirectoryPasswordField
in interface DirectoryService
DirectoryException
public Session open(java.lang.String directoryName) throws DirectoryException
DirectoryService
This method prefers to throw rather than returning null.
open
in interface DirectoryService
DirectoryException
- in case the session cannot be createdpublic java.lang.String getParentDirectoryName(java.lang.String directoryName) throws DirectoryException
DirectoryService
getParentDirectoryName
in interface DirectoryService
DirectoryException
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |