org.nuxeo.ecm.directory.multi

Class MultiDirectory

java.lang.Object

org.nuxeo.ecm.directory.AbstractDirectory

org.nuxeo.ecm.directory.multi.MultiDirectory

All Implemented Interfaces:

Directory

public class MultiDirectory
extends AbstractDirectory

Author:

Florent Guillaume

Constructor Summary

Constructors

Constructor and Description
MultiDirectory(MultiDirectoryDescriptor descriptor)

Method Summary

Methods

Modifier and Type	Method and Description
String	getIdField() Gets the id field of the schema for this directory.
String	getName() Gets the unique name of the directory, used for registering.
String	getParentDirectory() Gets the name of the parent directory.
String	getPasswordField() Gets the password field of the schema for this directory.
Reference	getReference(String referenceFieldName) Lookup a Reference by field name.
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.

Methods inherited from class org.nuxeo.ecm.directory.AbstractDirectory

addReference, addReferences, getCache, getFieldMapper, getReferences, invalidateCaches, isReference, orderEntries

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultiDirectory

public MultiDirectory(MultiDirectoryDescriptor descriptor)

Method Detail

getName

public String getName()

Description copied from interface: Directory

Gets the unique name of the directory, used for registering.

Returns:

the unique directory name

getSchema

public String getSchema()

Description copied from interface: Directory

Gets the schema name used by this directory.

Returns:

the schema name

getParentDirectory

public String getParentDirectory()

Description copied from interface: Directory

Gets the name of the parent directory. This is used for hierarchical vocabularies.

Returns:

the name of the parent directory, or null.

getIdField

public String getIdField()

Description copied from interface: Directory

Gets the id field of the schema for this directory.

Returns:

the id field.

getPasswordField

public String getPasswordField()

Description copied from interface: Directory

Gets the password field of the schema for this directory.

Returns:

the password field.

getSession

public Session getSession()
                   throws DirectoryException

Description copied from interface: Directory

Creates a session for accessing entries in this directory.

Returns:

a Session object

Throws:

DirectoryException - if a session cannot be created

shutdown

public void shutdown()
              throws DirectoryException

Description copied from interface: Directory

Shuts down the directory.

Throws:

DirectoryException

getReference

public Reference getReference(String referenceFieldName)

Description copied from interface: Directory

Lookup a Reference by field name.

Specified by:

getReference in interface Directory

Overrides:

getReference in class AbstractDirectory

Returns:

the matching reference implementation or null

invalidateDirectoryCache

public void invalidateDirectoryCache()
                              throws DirectoryException

Description copied from interface: Directory

Invalidates the cache instance of the directory

Specified by:

invalidateDirectoryCache in interface Directory

Overrides:

invalidateDirectoryCache in class AbstractDirectory

Throws:

DirectoryException