LDAPDirectoryDescriptor (Nuxeo ECM Projects 7.10-SNAPSHOT API)

java.lang.Object
- org.nuxeo.ecm.directory.ldap.LDAPDirectoryDescriptor

public class LDAPDirectoryDescriptor
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LDAPDirectoryDescriptor.EntryAdaptorDescriptor

Nested Classes
Modifier and Type	Class and Description
`static class`	`LDAPDirectoryDescriptor.EntryAdaptorDescriptor`

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`cacheEntryName`
`String`	`cacheEntryWithoutReferencesName`
`String`	`creationBaseDn`
`String[]`	`creationClasses`
`static String`	`defaultSearchClassesFilter`
`static int`	`defaultSearchScope`
`String`	`emptyRefMarker`
`protected EntryAdaptor`	`entryAdaptor`
`protected LdapExceptionProcessor`	`exceptionProcessor`
`protected Class<? extends LdapExceptionProcessor>`	`exceptionProcessorClass`
`Map<String,String>`	`fieldMapping`
`protected boolean`	`followReferrals` Since 5.9.4
`String`	`idCase` Since 5.4.2: force id case to upper or lower, or leaver it unchanged.
`String`	`idField`
`static org.apache.commons.logging.Log`	`log`
`String`	`missingIdFieldCase`
`String`	`name`
`Boolean`	`negativeCaching`
`String`	`passwordField`
`String`	`passwordHashAlgorithm`
`PermissionDescriptor[]`	`permissions`
`String`	`rdnAttribute`
`boolean`	`readOnly`
`String`	`schemaName`
`String`	`searchBaseDn`
`String[]`	`searchClasses`
`String`	`searchClassesFilter`
`String`	`searchFilter`
`int`	`searchScope`
`String`	`serverName`
`String`	`substringMatchType`

Constructor Summary

Constructors
Constructor and Description

LDAPDirectoryDescriptor()

Constructors
Constructor and Description
`LDAPDirectoryDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAggregatedSearchFilter()`
`String`	`getCreationBaseDn()`
`String[]`	`getCreationClasses()`
`String`	`getEmptyRefMarker()`
`EntryAdaptor`	`getEntryAdaptor()`
`LdapExceptionProcessor`	`getExceptionProcessor()`
`Map<String,String>`	`getFieldMapping()`
`String`	`getIdCase()`
`String`	`getIdField()`
`Reference[]`	`getInverseReferences()`
`Reference[]`	`getLdapReferences()`
`String`	`getName()`
`String`	`getPasswordField()`
`String`	`getPasswordHashAlgorithmField()`
`int`	`getQuerySizeLimit()`
`int`	`getQueryTimeLimit()`
`String`	`getRdnAttribute()`
`boolean`	`getReadOnly()`
`String`	`getSchemaName()`
`String`	`getSearchBaseDn()`
`String[]`	`getSearchClasses()`
`String`	`getSearchFilter()`
`int`	`getSearchScope()`
`String`	`getServerName()`
`String`	`getSubstringMatchType()`
`void`	`setEmptyRefMarker(String emptyRefMarker)`
`void`	`setEntryAdaptor(LDAPDirectoryDescriptor.EntryAdaptorDescriptor adaptorDescriptor)`
`void`	`setFieldMapping(Map<String,String> fieldMapping)`
`void`	`setQuerySizeLimit(int querySizeLimit)`
`void`	`setQueryTimeLimit(int queryTimeLimit)`
`void`	`setReadOnly(boolean readOnly)`
`void`	`setSearchClasses(String[] searchClasses)`
`void`	`setSearchFilter(String searchFilter)`
`void`	`setSearchScope(String searchScope)`
`void`	`setSubstringMatchType(String substringMatchType)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

public static final org.apache.commons.logging.Log log

defaultSearchScope
```
public static final int defaultSearchScope
```
See Also:

Constant Field Values

defaultSearchClassesFilter

public static final String defaultSearchClassesFilter

See Also:: Constant Field Values

name
```
public String name
```

serverName
```
public String serverName
```

schemaName
```
public String schemaName
```

searchBaseDn
```
public String searchBaseDn
```

readOnly
```
public boolean readOnly
```

cacheEntryName
```
public String cacheEntryName
```

cacheEntryWithoutReferencesName

public String cacheEntryWithoutReferencesName

negativeCaching
```
public Boolean negativeCaching
```

fieldMapping
```
public Map<String,String> fieldMapping
```

searchClasses
```
public String[] searchClasses
```

searchClassesFilter
```
public String searchClassesFilter
```

searchFilter
```
public String searchFilter
```

searchScope
```
public int searchScope
```

substringMatchType
```
public String substringMatchType
```

creationBaseDn
```
public String creationBaseDn
```

creationClasses
```
public String[] creationClasses
```

idField
```
public String idField
```

rdnAttribute
```
public String rdnAttribute
```

passwordField
```
public String passwordField
```

passwordHashAlgorithm
```
public String passwordHashAlgorithm
```

permissions

public PermissionDescriptor[] permissions

emptyRefMarker
```
public String emptyRefMarker
```

missingIdFieldCase
```
public String missingIdFieldCase
```

idCase
```
public String idCase
```
Since 5.4.2: force id case to upper or lower, or leaver it unchanged.

followReferrals
```
protected boolean followReferrals
```
Since 5.9.4

entryAdaptor
```
protected EntryAdaptor entryAdaptor
```

exceptionProcessorClass
```
protected Class<? extends LdapExceptionProcessor> exceptionProcessorClass
```
Since:

5.7 : allow to contribute custom Exception Handler to extract LDAP validation error messages

exceptionProcessor

protected LdapExceptionProcessor exceptionProcessor

Constructor Detail
- LDAPDirectoryDescriptor
```
public LDAPDirectoryDescriptor()
```

Method Detail

setEntryAdaptor

public void setEntryAdaptor(LDAPDirectoryDescriptor.EntryAdaptorDescriptor adaptorDescriptor)
                     throws InstantiationException,
                            IllegalAccessException

Throws:: InstantiationException; IllegalAccessException

getRdnAttribute
```
public String getRdnAttribute()
```

getCreationBaseDn
```
public String getCreationBaseDn()
```

getCreationClasses
```
public String[] getCreationClasses()
```

getIdField
```
public String getIdField()
```

getIdCase
```
public String getIdCase()
```

getSchemaName
```
public String getSchemaName()
```

getSearchBaseDn
```
public String getSearchBaseDn()
```

setSearchClasses

public void setSearchClasses(String[] searchClasses)

getSearchClasses
```
public String[] getSearchClasses()
```

setSearchFilter

public void setSearchFilter(String searchFilter)

getSearchFilter
```
public String getSearchFilter()
```

setSearchScope

public void setSearchScope(String searchScope)
                    throws DirectoryException

Throws:: DirectoryException

getSearchScope
```
public int getSearchScope()
```

getSubstringMatchType
```
public String getSubstringMatchType()
```

setSubstringMatchType

public void setSubstringMatchType(String substringMatchType)

getName
```
public String getName()
```

getServerName
```
public String getServerName()
```

getAggregatedSearchFilter

public String getAggregatedSearchFilter()

getPasswordField
```
public String getPasswordField()
```

getPasswordHashAlgorithmField

public String getPasswordHashAlgorithmField()

getFieldMapping

public Map<String,String> getFieldMapping()

setFieldMapping

public void setFieldMapping(Map<String,String> fieldMapping)

getInverseReferences

public Reference[] getInverseReferences()

getLdapReferences

public Reference[] getLdapReferences()

getReadOnly
```
public boolean getReadOnly()
```

setReadOnly

public void setReadOnly(boolean readOnly)

getEmptyRefMarker
```
public String getEmptyRefMarker()
```

setEmptyRefMarker

public void setEmptyRefMarker(String emptyRefMarker)

getQuerySizeLimit
```
public int getQuerySizeLimit()
```

setQuerySizeLimit

public void setQuerySizeLimit(int querySizeLimit)

setQueryTimeLimit

public void setQueryTimeLimit(int queryTimeLimit)

getQueryTimeLimit
```
public int getQueryTimeLimit()
```

getEntryAdaptor
```
public EntryAdaptor getEntryAdaptor()
```

getExceptionProcessor

public LdapExceptionProcessor getExceptionProcessor()

Class LDAPDirectoryDescriptor

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

defaultSearchScope

defaultSearchClassesFilter

name

serverName

schemaName

searchBaseDn

readOnly

cacheEntryName

cacheEntryWithoutReferencesName

negativeCaching

fieldMapping

searchClasses

searchClassesFilter

searchFilter

searchScope

substringMatchType

creationBaseDn

creationClasses

idField

rdnAttribute

passwordField

passwordHashAlgorithm

permissions

emptyRefMarker

missingIdFieldCase

idCase

followReferrals

entryAdaptor

exceptionProcessorClass

exceptionProcessor

Constructor Detail

LDAPDirectoryDescriptor

Method Detail

setEntryAdaptor

getRdnAttribute

getCreationBaseDn

getCreationClasses

getIdField

getIdCase

getSchemaName

getSearchBaseDn

setSearchClasses

getSearchClasses

setSearchFilter

getSearchFilter

setSearchScope

getSearchScope

getSubstringMatchType

setSubstringMatchType

getName

getServerName

getAggregatedSearchFilter

getPasswordField

getPasswordHashAlgorithmField

getFieldMapping

setFieldMapping

getInverseReferences

getLdapReferences

getReadOnly

setReadOnly

getEmptyRefMarker

setEmptyRefMarker

getQuerySizeLimit

setQuerySizeLimit

setQueryTimeLimit

getQueryTimeLimit

getEntryAdaptor

getExceptionProcessor