org.nuxeo.ecm.directory.ldap

Class LDAPReference

java.lang.Object

org.nuxeo.ecm.directory.AbstractReference

org.nuxeo.ecm.directory.ldap.LDAPReference

All Implemented Interfaces:

Reference

public class LDAPReference
extends AbstractReference

Implementation of the directory Reference interface that leverage two common ways of storing relationships in LDAP directories:

• the static attribute strategy where a multi-valued attribute store the exhaustive list of distinguished names of the refereed entries (eg. the uniqueMember attribute of the groupOfUniqueNames objectclass)
• the dynamic attribute strategy where a potentially multi-valued attribute stores a ldap urls intensively describing the refereed LDAP entries (eg. the memberURLs attribute of the groupOfURLs objectclass)

Please note that both static and dynamic references are resolved in read mode whereas only the static attribute strategy is used when creating new references or when deleting existing ones (write / update mode).

Some design considerations behind the implementation of such reference can be found at: http://jira.nuxeo.org/browse/NXP-1506

Author:

Olivier Grisel

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	EMPTY_STRING_LIST
boolean	forceDnConsistencyCheck

Constructor Summary

Constructors

Constructor and Description
LDAPReference()

Method Summary

Methods

Modifier and Type	Method and Description
void	addLinks(List<String> sourceIds, String targetId) Store new links using the LDAP staticAttributeId strategy.
void	addLinks(String sourceId, List<String> targetIds) Store new links using the LDAP staticAttributeId strategy.
LDAPReference	clone() Returns a clone, added for hot reload support.
String	getDynamicAttributeId()
List<LDAPDynamicReferenceDescriptor>	getDynamicAttributes()
List<String>	getLdapTargetIds(Attributes attributes) Optimized method to spare a LDAP request when the caller is a LDAPSession object that has already fetched the LDAP Attribute instances.
Directory	getSourceDirectory()
List<String>	getSourceIdsForTarget(String targetId) Fetch both statically and dynamically defined references and merge the results.
String	getStaticAttributeId()
String	getStaticAttributeId(DirectoryFieldMapper sourceFM)
Directory	getTargetDirectory()
List<String>	getTargetIdsForSource(String sourceId) Fetches both statically and dynamically defined references and merges the results.
boolean	isDynamic()
boolean	isStatic()
void	removeLinksForSource(String sourceId) Remove existing statically defined links for the given source id (dynamic references remain unaltered)
void	removeLinksForTarget(String targetId) Remove existing statically defined links for the given target id (dynamic references remain unaltered)
void	setFieldName(String fieldName)
void	setSourceIdsForTarget(String targetId, List<String> sourceIds) Edit the list of statically defined references for a given target (dynamic references remain unaltered)
void	setTargetDirectoryName(String targetDirectoryName)
void	setTargetIdsForSource(String sourceId, List<String> targetIds) Set the list of statically defined references for a given source (dynamic references remain unaltered)
String	toString()

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

getFieldName, setSourceDirectoryName

Methods inherited from class java.lang.Object

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

Field Detail

forceDnConsistencyCheck

public boolean forceDnConsistencyCheck

EMPTY_STRING_LIST

public static final List<String> EMPTY_STRING_LIST

Constructor Detail

LDAPReference

public LDAPReference()

Method Detail

setFieldName

public void setFieldName(String fieldName)

isStatic

public boolean isStatic()
                 throws DirectoryException

Returns:

true if the reference should resolve statically refereed entries (identified by dn-valued attribute)

Throws:

DirectoryException

getStaticAttributeId

public String getStaticAttributeId()
                            throws DirectoryException

Throws:

DirectoryException

getStaticAttributeId

public String getStaticAttributeId(DirectoryFieldMapper sourceFM)
                            throws DirectoryException

Throws:

DirectoryException

getDynamicAttributes

public List<LDAPDynamicReferenceDescriptor> getDynamicAttributes()

getDynamicAttributeId

public String getDynamicAttributeId()

isDynamic

public boolean isDynamic()

Returns:

true if the reference should resolve dynamically refereed entries (identified by a LDAP url-valued attribute)

setTargetDirectoryName

public void setTargetDirectoryName(String targetDirectoryName)

Specified by:

setTargetDirectoryName in interface Reference

Overrides:

setTargetDirectoryName in class AbstractReference

getSourceDirectory

public Directory getSourceDirectory()
                             throws DirectoryException

Specified by:

getSourceDirectory in interface Reference

Overrides:

getSourceDirectory in class AbstractReference

Throws:

DirectoryException

getTargetDirectory

public Directory getTargetDirectory()
                             throws DirectoryException

Specified by:

getTargetDirectory in interface Reference

Overrides:

getTargetDirectory in class AbstractReference

Throws:

DirectoryException

addLinks

public void addLinks(String sourceId,
            List<String> targetIds)
              throws DirectoryException

Store new links using the LDAP staticAttributeId strategy.

Throws:

DirectoryException

See Also:

Reference.addLinks(String, List)

addLinks

public void addLinks(List<String> sourceIds,
            String targetId)
              throws DirectoryException

Store new links using the LDAP staticAttributeId strategy.

Throws:

DirectoryException

See Also:

Reference.addLinks(List, String)

getSourceIdsForTarget

public List<String> getSourceIdsForTarget(String targetId)
                                   throws DirectoryException

Fetch both statically and dynamically defined references and merge the results.

Throws:

DirectoryException

See Also:

Reference.getSourceIdsForTarget(String)

getTargetIdsForSource

public List<String> getTargetIdsForSource(String sourceId)
                                   throws DirectoryException

Fetches both statically and dynamically defined references and merges the results.

Throws:

DirectoryException

See Also:

Reference.getSourceIdsForTarget(String)

getLdapTargetIds

public List<String> getLdapTargetIds(Attributes attributes)
                              throws DirectoryException

Optimized method to spare a LDAP request when the caller is a LDAPSession object that has already fetched the LDAP Attribute instances.

This method should return the same results as the sister method: org.nuxeo .ecm.directory.Reference#getTargetIdsForSource(java.lang.String)

Returns:

target reference ids

Throws:

DirectoryException

removeLinksForSource

public void removeLinksForSource(String sourceId)
                          throws DirectoryException

Remove existing statically defined links for the given source id (dynamic references remain unaltered)

Throws:

DirectoryException

See Also:

Reference.removeLinksForSource(String)

removeLinksForTarget

public void removeLinksForTarget(String targetId)
                          throws DirectoryException

Remove existing statically defined links for the given target id (dynamic references remain unaltered)

Throws:

DirectoryException

See Also:

Reference.removeLinksForTarget(String)

setSourceIdsForTarget

public void setSourceIdsForTarget(String targetId,
                         List<String> sourceIds)
                           throws DirectoryException

Edit the list of statically defined references for a given target (dynamic references remain unaltered)

Throws:

DirectoryException

See Also:

Reference.setSourceIdsForTarget(String, List)

setTargetIdsForSource

public void setTargetIdsForSource(String sourceId,
                         List<String> targetIds)
                           throws DirectoryException

Set the list of statically defined references for a given source (dynamic references remain unaltered)

Throws:

DirectoryException

See Also:

Reference.setTargetIdsForSource(String, List)

toString

public String toString()

Overrides:

toString in class Object

clone

public LDAPReference clone()

Description copied from interface: Reference

Returns a clone, added for hot reload support.

Specified by:

clone in interface Reference

Overrides:

clone in class AbstractReference

Since:

5.6