public class LDAPReference extends AbstractReference implements Cloneable
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
Modifier and Type | Field and Description |
---|---|
protected String |
dynamicAttributeId |
boolean |
forceDnConsistencyCheck |
protected String |
staticAttributeId |
protected LDAPDirectoryDescriptor |
targetDirectoryDescriptor |
fieldName, sourceDirectory, sourceDirectoryName, targetDirectory, targetDirectoryName
Constructor and Description |
---|
LDAPReference() |
LDAPReference(ReferenceDescriptor referenceDescriptor) |
Modifier and Type | Method and Description |
---|---|
void |
addLinks(List<String> sourceIds,
String targetId)
Store new links using the LDAP staticAttributeId strategy.
|
void |
addLinks(List<String> sourceIds,
String targetId,
Session session)
Adds the links between the source ids and the target id
|
void |
addLinks(String sourceId,
List<String> targetIds)
Store new links using the LDAP staticAttributeId strategy.
|
void |
addLinks(String sourceId,
List<String> targetIds,
Session session)
Adds the links between the source id and the target ids
|
LDAPReference |
clone() |
String |
getDynamicAttributeId() |
List<LDAPDynamicReferenceDescriptor> |
getDynamicAttributes() |
protected String |
getIdForDn(LDAPSession session,
String dn) |
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.
|
protected LDAPDirectory |
getSourceLDAPDirectory() |
String |
getStaticAttributeId() |
String |
getStaticAttributeId(DirectoryFieldMapper sourceFM) |
Directory |
getTargetDirectory() |
protected LDAPDirectoryDescriptor |
getTargetDirectoryDescriptor() |
List<String> |
getTargetIdsForSource(String sourceId)
Fetches both statically and dynamically defined references and merges the results.
|
protected LDAPDirectory |
getTargetLDAPDirectory() |
boolean |
isDynamic() |
boolean |
isStatic() |
protected static String |
pseudoNormalizeDn(String dn)
Simple helper that replaces ", " by "," in the provided dn and returns the lower case version of the result for
comparison purpose.
|
void |
removeLinksForSource(String sourceId)
Remove existing statically defined links for the given source id (dynamic references remain unaltered)
|
void |
removeLinksForSource(String sourceId,
Session session)
Removes all the links for a given source id
|
void |
removeLinksForTarget(String targetId)
Remove existing statically defined links for the given target id (dynamic references remain unaltered)
|
void |
removeLinksForTarget(String targetId,
Session session)
Removes all the links for a given target id
|
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 |
setSourceIdsForTarget(String targetId,
List<String> sourceIds,
Session session)
Sets all source ids to be associated to the given target id
|
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)
|
void |
setTargetIdsForSource(String sourceId,
List<String> targetIds,
Session session)
Sets all target ids to be associated to the given source id
|
String |
toString() |
getFieldName, setSourceDirectoryName
public boolean forceDnConsistencyCheck
protected LDAPDirectoryDescriptor targetDirectoryDescriptor
protected String staticAttributeId
protected String dynamicAttributeId
public LDAPReference()
public LDAPReference(ReferenceDescriptor referenceDescriptor)
public void setFieldName(String fieldName)
public boolean isStatic()
public String getStaticAttributeId()
public String getStaticAttributeId(DirectoryFieldMapper sourceFM)
public List<LDAPDynamicReferenceDescriptor> getDynamicAttributes()
public String getDynamicAttributeId()
public boolean isDynamic()
public void setTargetDirectoryName(String targetDirectoryName)
setTargetDirectoryName
in interface Reference
setTargetDirectoryName
in class AbstractReference
public Directory getSourceDirectory()
getSourceDirectory
in interface Reference
getSourceDirectory
in class AbstractReference
public Directory getTargetDirectory()
getTargetDirectory
in interface Reference
getTargetDirectory
in class AbstractReference
protected LDAPDirectory getTargetLDAPDirectory()
protected LDAPDirectory getSourceLDAPDirectory()
protected LDAPDirectoryDescriptor getTargetDirectoryDescriptor()
public void addLinks(String sourceId, List<String> targetIds)
addLinks
in interface Reference
Reference.addLinks(String, List)
public void addLinks(List<String> sourceIds, String targetId)
addLinks
in interface Reference
Reference.addLinks(List, String)
public List<String> getSourceIdsForTarget(String targetId)
getSourceIdsForTarget
in interface Reference
Reference.getSourceIdsForTarget(String)
public List<String> getTargetIdsForSource(String sourceId)
getTargetIdsForSource
in interface Reference
Reference.getSourceIdsForTarget(String)
protected static String pseudoNormalizeDn(String dn) throws InvalidNameException
dn
- the raw unnormalized dnInvalidNameException
public List<String> getLdapTargetIds(Attributes attributes)
This method should return the same results as the sister method: org.nuxeo .ecm.directory.Reference#getTargetIdsForSource(java.lang.String)
protected String getIdForDn(LDAPSession session, String dn)
public void removeLinksForSource(String sourceId)
removeLinksForSource
in interface Reference
Reference.removeLinksForSource(String)
public void removeLinksForTarget(String targetId)
removeLinksForTarget
in interface Reference
Reference.removeLinksForTarget(String)
public void setSourceIdsForTarget(String targetId, List<String> sourceIds)
setSourceIdsForTarget
in interface Reference
Reference.setSourceIdsForTarget(String, List)
public void setSourceIdsForTarget(String targetId, List<String> sourceIds, Session session)
Reference
setSourceIdsForTarget
in interface Reference
targetId
- the target idsourceIds
- the source idssession
- the sessionpublic void setTargetIdsForSource(String sourceId, List<String> targetIds)
setTargetIdsForSource
in interface Reference
Reference.setTargetIdsForSource(String, List)
public void setTargetIdsForSource(String sourceId, List<String> targetIds, Session session)
Reference
setTargetIdsForSource
in interface Reference
sourceId
- the source idtargetIds
- the target idssession
- the sessionpublic void removeLinksForTarget(String targetId, Session session)
Reference
removeLinksForTarget
in interface Reference
targetId
- the target idsession
- the sessionpublic void removeLinksForSource(String sourceId, Session session)
Reference
removeLinksForSource
in interface Reference
sourceId
- the source idsession
- the sessionpublic LDAPReference clone()
public void addLinks(String sourceId, List<String> targetIds, Session session)
Reference
Copyright © 2019 Nuxeo. All rights reserved.