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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LDAPDirectory.TrustingSSLSocketFactory SSLSocketFactory implementation that verifies all certificates.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	baseFilter
protected LDAPDirectoryDescriptor	config
protected Properties	contextProperties
static String	DN_SPECIAL_ATTRIBUTE_KEY
protected LDAPDirectoryFactory	factory
protected Map<String,Field>	schemaFieldMap
protected SearchControls	searchControls
protected ContextProvider	testServer

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

cache, fieldMapper, name, references, registry, sessionCount, sessionMaxCount

Constructor Summary

Constructors

Constructor and Description
LDAPDirectory(LDAPDirectoryDescriptor config)

Method Summary

Modifier and Type	Method and Description
protected Properties	computeContextProperties()
protected SearchControls	computeSearchControls() Search controls that only fetch attributes defined by the schema
protected DirContext	createContext()
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	getPasswordHashAlgorithmField() Get the value of the field passwordHashAlgorithm
List<Reference>	getReferences(String referenceFieldName) Lookup the References by field name.
String	getSchema() Gets the schema name used by this directory.
Map<String,Field>	getSchemaFieldMap()
SearchControls	getSearchControls()
SearchControls	getSearchControls(boolean fetchAllAttributes)
LDAPServerDescriptor	getServer()
Session	getSession() Creates a session for accessing entries in this directory.
protected void	initLDAPConfig() Lazy init method for ldap config
void	setTestServer(ContextProvider testServer)

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

addReference, addReferences, addSession, getCache, getFieldMapper, getReference, getReferences, invalidateCaches, invalidateDirectoryCache, isMultiTenant, isReference, orderEntries, removeSession, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

config

protected final LDAPDirectoryDescriptor config

contextProperties

protected Properties contextProperties

searchControls

protected SearchControls searchControls

schemaFieldMap

protected Map<String,Field> schemaFieldMap

factory

protected final LDAPDirectoryFactory factory

baseFilter

protected String baseFilter

testServer

protected ContextProvider testServer

Constructor Detail

LDAPDirectory

public LDAPDirectory(LDAPDirectoryDescriptor config)

Method Detail

getReferences

public List<Reference> getReferences(String referenceFieldName)

Description copied from interface: Directory

Lookup the References by field name.

Specified by:

getReferences in interface Directory

Overrides:

getReferences in class AbstractDirectory

Returns:

the matching references implementation or null

initLDAPConfig

protected void initLDAPConfig()

Lazy init method for ldap config

Since:

6.0

computeContextProperties

protected Properties computeContextProperties()
                                       throws DirectoryException

Returns:

connection parameters to use for all LDAP queries

Throws:

DirectoryException

getContextProperties

public Properties getContextProperties()

computeSearchControls

protected SearchControls computeSearchControls()
                                        throws DirectoryException

Search controls that only fetch attributes defined by the schema

Returns:

common search controls to use for all LDAP search queries

Throws:

DirectoryException

getSearchControls

public SearchControls getSearchControls()

getSearchControls

public SearchControls getSearchControls(boolean fetchAllAttributes)

createContext

protected DirContext createContext()
                            throws DirectoryException

Throws:

DirectoryException

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.

getServer

public LDAPServerDescriptor getServer()

Returns:

ldap server descriptor bound to this directory

Since:

5.7

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

getBaseFilter

public String getBaseFilter()

getConfig

public LDAPDirectoryDescriptor getConfig()

getSchemaFieldMap

public Map<String,Field> getSchemaFieldMap()

getPasswordHashAlgorithmField

public String getPasswordHashAlgorithmField()

Get the value of the field passwordHashAlgorithm

Returns:

The value

Since:

5.9.3

setTestServer

public void setTestServer(ContextProvider testServer)