org.nuxeo.ecm.directory.ldap

Class LDAPDirectory

java.lang.Object

org.nuxeo.ecm.directory.AbstractDirectory

org.nuxeo.ecm.directory.ldap.LDAPDirectory

All Implemented Interfaces:

Directory

public class LDAPDirectory
extends AbstractDirectory

Implementation of the Directory interface for servers implementing the Lightweight Directory Access Protocol.

Author:

ogrisel, Robert Browning

Field Summary

Fields

Modifier and Type	Field and Description
static String	DN_SPECIAL_ATTRIBUTE_KEY

Constructor Summary

Constructors

Constructor and Description
LDAPDirectory(LDAPDirectoryDescriptor config)

Method Summary

Methods

Modifier and Type	Method and Description
void	addSession(Session session)
String	getBaseFilter()
LDAPDirectoryDescriptor	getConfig()
Properties	getContextProperties()
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.
String	getSchema() Gets the schema name used by this directory.
Map<String,Field>	getSchemaFieldMap()
SearchControls	getSearchControls()
SearchControls	getSearchControls(boolean fetchAllAttributes)
Session	getSession() Creates a session for accessing entries in this directory.
void	removeSession(Session session)
void	setTestServer(ContextProvider testServer)
void	shutdown() Shuts down the directory.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

DN_SPECIAL_ATTRIBUTE_KEY

public static final String DN_SPECIAL_ATTRIBUTE_KEY

See Also:

Constant Field Values

Constructor Detail

LDAPDirectory

public LDAPDirectory(LDAPDirectoryDescriptor config)
              throws ClientException

Throws:

ClientException

Method Detail

getContextProperties

public Properties getContextProperties()

getSearchControls

public SearchControls getSearchControls()

getSearchControls

public SearchControls getSearchControls(boolean fetchAllAttributes)

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

removeSession

public void removeSession(Session session)

addSession

public void addSession(Session session)

shutdown

public void shutdown()

Description copied from interface: Directory

Shuts down the directory.

getBaseFilter

public String getBaseFilter()

getConfig

public LDAPDirectoryDescriptor getConfig()

getSchemaFieldMap

public Map<String,Field> getSchemaFieldMap()

setTestServer

public void setTestServer(ContextProvider testServer)