Nuxeo Enterprise Platform 5.4

org.nuxeo.ecm.directory.ldap
Class LDAPTreeReference

java.lang.Object
  extended by org.nuxeo.ecm.directory.AbstractReference
      extended by org.nuxeo.ecm.directory.ldap.LDAPTreeReference
All Implemented Interfaces:
Reference

public class LDAPTreeReference
extends AbstractReference

Implementation of the directory Reference interface that makes it possible to retrieve children of a node in the LDAP tree structure.

Author:
Anahide Tchertchian

Field Summary
static java.util.List<java.lang.String> EMPTY_STRING_LIST
           
 
Constructor Summary
LDAPTreeReference()
           
 
Method Summary
 void addLinks(java.util.List<java.lang.String> sourceIds, java.lang.String targetId)
          NOT IMPLEMENTED: Store new links.
 void addLinks(java.lang.String sourceId, java.util.List<java.lang.String> targetIds)
          NOT IMPLEMENTED: Store new links
 int getScope()
           
 Directory getSourceDirectory()
           
 java.util.List<java.lang.String> getSourceIdsForTarget(java.lang.String targetId)
          Fetches single parent, cutting the dn and trying to get the given entry.
 Directory getTargetDirectory()
           
 java.util.List<java.lang.String> getTargetIdsForSource(java.lang.String sourceId)
          Fetches children, onelevel or subtree given the reference configuration.
 void removeLinksForSource(java.lang.String sourceId)
          NOT IMPLEMENTED: Remove existing statically defined links for the given source id
 void removeLinksForTarget(java.lang.String targetId)
          NOT IMPLEMENTED: Remove existing statically defined links for the given target id
 void setFieldName(java.lang.String fieldName)
           
 void setScope(java.lang.String scope)
           
 void setSourceIdsForTarget(java.lang.String targetId, java.util.List<java.lang.String> sourceIds)
          NOT IMPLEMENTED: Edit the list of statically defined references for a given target
 void setTargetDirectoryName(java.lang.String targetDirectoryName)
           
 void setTargetIdsForSource(java.lang.String sourceId, java.util.List<java.lang.String> targetIds)
          NOT IMPLEMENTED: Set the list of statically defined references for a given source
 java.lang.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

EMPTY_STRING_LIST

public static final java.util.List<java.lang.String> EMPTY_STRING_LIST
Constructor Detail

LDAPTreeReference

public LDAPTreeReference()
Method Detail

setFieldName

public void setFieldName(java.lang.String fieldName)

setTargetDirectoryName

public void setTargetDirectoryName(java.lang.String targetDirectoryName)
Specified by:
setTargetDirectoryName in interface Reference
Overrides:
setTargetDirectoryName in class AbstractReference

getScope

public int getScope()

setScope

public void setScope(java.lang.String scope)
              throws DirectoryException
Throws:
DirectoryException

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(java.lang.String sourceId,
                     java.util.List<java.lang.String> targetIds)
              throws DirectoryException
NOT IMPLEMENTED: Store new links

Throws:
DirectoryException
See Also:
Reference.addLinks(String, List)

addLinks

public void addLinks(java.util.List<java.lang.String> sourceIds,
                     java.lang.String targetId)
              throws DirectoryException
NOT IMPLEMENTED: Store new links.

Throws:
DirectoryException
See Also:
Reference.addLinks(List, String)

getSourceIdsForTarget

public java.util.List<java.lang.String> getSourceIdsForTarget(java.lang.String targetId)
                                                       throws DirectoryException
Fetches single parent, cutting the dn and trying to get the given entry.

Throws:
DirectoryException
See Also:
Reference.getSourceIdsForTarget(String)

getTargetIdsForSource

public java.util.List<java.lang.String> getTargetIdsForSource(java.lang.String sourceId)
                                                       throws DirectoryException
Fetches children, onelevel or subtree given the reference configuration.

Removes entries with same id than parent to only get real children.

Throws:
DirectoryException
See Also:
Reference.getTargetIdsForSource(String)

removeLinksForSource

public void removeLinksForSource(java.lang.String sourceId)
                          throws DirectoryException
NOT IMPLEMENTED: Remove existing statically defined links for the given source id

Throws:
DirectoryException
See Also:
Reference.removeLinksForSource(String)

removeLinksForTarget

public void removeLinksForTarget(java.lang.String targetId)
                          throws DirectoryException
NOT IMPLEMENTED: Remove existing statically defined links for the given target id

Throws:
DirectoryException
See Also:
Reference.removeLinksForTarget(String)

setSourceIdsForTarget

public void setSourceIdsForTarget(java.lang.String targetId,
                                  java.util.List<java.lang.String> sourceIds)
                           throws DirectoryException
NOT IMPLEMENTED: Edit the list of statically defined references for a given target

Throws:
DirectoryException
See Also:
Reference.setSourceIdsForTarget(String, List)

setTargetIdsForSource

public void setTargetIdsForSource(java.lang.String sourceId,
                                  java.util.List<java.lang.String> targetIds)
                           throws DirectoryException
NOT IMPLEMENTED: Set the list of statically defined references for a given source

Throws:
DirectoryException
See Also:
Reference.setTargetIdsForSource(String, List)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Nuxeo Enterprise Platform 5.4

Copyright © 2010 Nuxeo SAS. All Rights Reserved.