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

All Implemented Interfaces:: Cloneable

public class LDAPDirectoryDescriptor
extends BaseDirectoryDescriptor

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class LDAPDirectoryDescriptor.EntryAdaptorDescriptor
- Nested classes/interfaces inherited from class org.nuxeo.ecm.directory.BaseDirectoryDescriptor
  BaseDirectoryDescriptor.SubstringMatchType

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`creationBaseDn`
`String[]`	`creationClasses`
`static String`	`DEFAULT_EMPTY_REF_MARKER`
`static boolean`	`DEFAULT_FOLLOW_REFERRALS`
`static String`	`DEFAULT_ID_CASE`
`static String`	`DEFAULT_MISSING_ID_FIELD_CASE`
`static int`	`DEFAULT_QUERY_SIZE_LIMIT`
`static int`	`DEFAULT_QUERY_TIME_LIMIT`
`static String`	`DEFAULT_SEARCH_CLASSES_FILTER`
`static int`	`DEFAULT_SEARCH_SCOPE`
`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.
`static Log`	`log`
`String`	`missingIdFieldCase`
`String`	`rdnAttribute`
`String`	`searchBaseDn`
`String[]`	`searchClasses`
`String`	`searchClassesFilter`
`String`	`searchFilter`
`Integer`	`searchScope`
`String`	`serverName`

Fields inherited from class org.nuxeo.ecm.directory.BaseDirectoryDescriptor
AUTO_INCREMENT_ID_FIELD_DEFAULT, autoincrementIdField, CACHE_MAX_SIZE_DEFAULT, CACHE_TIMEOUT_DEFAULT, cacheEntryName, cacheEntryWithoutReferencesName, cacheMaxSize, cacheTimeout, computeMultiTenantId, CREATE_TABLE_POLICIES, CREATE_TABLE_POLICY_ALWAYS, CREATE_TABLE_POLICY_DEFAULT, CREATE_TABLE_POLICY_NEVER, CREATE_TABLE_POLICY_ON_MISSING_COLUMNS, createTablePolicy, DATA_LOADING_POLICIES, DATA_LOADING_POLICY_LEGACY, DATA_LOADING_POLICY_NEVER_LOAD, DATA_LOADING_POLICY_REJECT_DUPLICATE, DATA_LOADING_POLICY_SKIP_DUPLICATE, DATA_LOADING_POLICY_UPDATE_DUPLICATE, dataFileCharacterSeparator, dataFileName, dataLoadingPolicy, DEFAULT_DATA_FILE_CHARACTER_SEPARATOR, extendz, idField, name, negativeCaching, parentDirectory, passwordField, passwordHashAlgorithm, permissions, READ_ONLY_DEFAULT, readOnly, remove, schemaName, SUBSTRING_MATCH_TYPE_DEFAULT, substringMatchType, tableName, template, types

Constructor Summary

Constructors
Constructor Description

LDAPDirectoryDescriptor()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`LDAPDirectoryDescriptor`	`clone()`	Sub-classes MUST OVERRIDE and use a more specific return type.
`String`	`getAggregatedSearchFilter()`
`String`	`getCreationBaseDn()`
`String[]`	`getCreationClasses()`
`String`	`getEmptyRefMarker()`
`EntryAdaptor`	`getEntryAdaptor()`
`LdapExceptionProcessor`	`getExceptionProcessor()`
`Map<String,String>`	`getFieldMapping()`
`boolean`	`getFollowReferrals()`
`String`	`getIdCase()`
`Reference[]`	`getLdapReferences()`
`String`	`getMissingIdFieldCase()`
`int`	`getQuerySizeLimit()`
`int`	`getQueryTimeLimit()`
`String`	`getRdnAttribute()`
`String`	`getSearchBaseDn()`
`String[]`	`getSearchClasses()`
`String`	`getSearchFilter()`
`int`	`getSearchScope()`
`String`	`getServerName()`
`void`	`merge(BaseDirectoryDescriptor other)`
`protected void`	`merge(LDAPDirectoryDescriptor other)`
`LDAPDirectory`	`newDirectory()`	Creates a new `Directory` instance from this `BaseDirectoryDescriptor`.
`void`	`setEmptyRefMarker(String emptyRefMarker)`
`void`	`setEntryAdaptor(LDAPDirectoryDescriptor.EntryAdaptorDescriptor adaptorDescriptor)`
`void`	`setFieldMapping(Map<String,String> fieldMapping)`
`void`	`setQuerySizeLimit(int querySizeLimit)`
`void`	`setQueryTimeLimit(int queryTimeLimit)`
`void`	`setSearchClasses(String[] searchClasses)`
`void`	`setSearchFilter(String searchFilter)`
`void`	`setSearchScope(String searchScope)`

Methods inherited from class org.nuxeo.ecm.directory.BaseDirectoryDescriptor
checkDataLoadingPolicy, getCacheMaxSize, getCacheTimeout, getCreateTablePolicy, getDataFileCharacterSeparator, getDataFileName, getDataLoadingPolicy, getDeleteConstraints, getInverseReferences, getReferences, getSubstringMatchType, isAutoincrementIdField, isComputeMultiTenantId, isReadOnly, setAutoincrementIdField, setReadOnly

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

Field Detail

log
```
public static final Log log
```

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

Constant Field Values

DEFAULT_SEARCH_CLASSES_FILTER

public static final String DEFAULT_SEARCH_CLASSES_FILTER

See Also:: Constant Field Values

DEFAULT_EMPTY_REF_MARKER

public static final String DEFAULT_EMPTY_REF_MARKER

See Also:: Constant Field Values

DEFAULT_MISSING_ID_FIELD_CASE

public static final String DEFAULT_MISSING_ID_FIELD_CASE

See Also:: Constant Field Values

DEFAULT_ID_CASE

public static final String DEFAULT_ID_CASE

See Also:: Constant Field Values

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

Constant Field Values

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

Constant Field Values

DEFAULT_FOLLOW_REFERRALS
```
public static final boolean DEFAULT_FOLLOW_REFERRALS
```
See Also:

Constant Field Values

serverName
```
public String serverName
```

searchBaseDn
```
public String searchBaseDn
```

fieldMapping

public Map<String,String> fieldMapping

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

searchClassesFilter
```
public String searchClassesFilter
```

searchFilter
```
public String searchFilter
```

searchScope
```
public Integer searchScope
```

creationBaseDn
```
public String creationBaseDn
```

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

rdnAttribute
```
public String rdnAttribute
```

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

getMissingIdFieldCase
```
public String getMissingIdFieldCase()
```

getFollowReferrals
```
public boolean getFollowReferrals()
```

setEntryAdaptor

public void setEntryAdaptor(LDAPDirectoryDescriptor.EntryAdaptorDescriptor adaptorDescriptor)
                     throws ReflectiveOperationException

Throws:: ReflectiveOperationException

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

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

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

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

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)

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

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

getAggregatedSearchFilter

public String getAggregatedSearchFilter()

getFieldMapping

public Map<String,String> getFieldMapping()

setFieldMapping

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

getLdapReferences

public Reference[] getLdapReferences()

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()

merge

public void merge(BaseDirectoryDescriptor other)

Overrides:: merge in class BaseDirectoryDescriptor

merge

protected void merge(LDAPDirectoryDescriptor other)

clone
```
public LDAPDirectoryDescriptor clone()
```
Description copied from class: BaseDirectoryDescriptor

Sub-classes MUST OVERRIDE and use a more specific return type.
Usually it's bad to use clone(), and a copy-constructor is preferred, but here we want the copy method to be inheritable so clone() is appropriate.

Overrides:

clone in class BaseDirectoryDescriptor

newDirectory
```
public LDAPDirectory newDirectory()
```
Description copied from class: BaseDirectoryDescriptor

Creates a new Directory instance from this BaseDirectoryDescriptor.

Overrides:

newDirectory in class BaseDirectoryDescriptor

Class LDAPDirectoryDescriptor

Nested Class Summary

Nested classes/interfaces inherited from class org.nuxeo.ecm.directory.BaseDirectoryDescriptor

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

log

DEFAULT_SEARCH_SCOPE

DEFAULT_SEARCH_CLASSES_FILTER

DEFAULT_EMPTY_REF_MARKER

DEFAULT_MISSING_ID_FIELD_CASE

DEFAULT_ID_CASE

DEFAULT_QUERY_SIZE_LIMIT

DEFAULT_QUERY_TIME_LIMIT

DEFAULT_FOLLOW_REFERRALS

serverName

searchBaseDn

fieldMapping

searchClasses

searchClassesFilter

searchFilter

searchScope

creationBaseDn

creationClasses

rdnAttribute

emptyRefMarker

missingIdFieldCase

idCase

followReferrals

entryAdaptor

exceptionProcessorClass

exceptionProcessor

Constructor Detail

LDAPDirectoryDescriptor

Method Detail

getMissingIdFieldCase

getFollowReferrals

setEntryAdaptor

getRdnAttribute

getCreationBaseDn

getCreationClasses

getIdCase

getSearchBaseDn

setSearchClasses

getSearchClasses

setSearchFilter

getSearchFilter

setSearchScope

getSearchScope

getServerName

getAggregatedSearchFilter

getFieldMapping

setFieldMapping

getLdapReferences

getEmptyRefMarker

setEmptyRefMarker

getQuerySizeLimit

setQuerySizeLimit

setQueryTimeLimit

getQueryTimeLimit

getEntryAdaptor

getExceptionProcessor

merge

merge

clone

newDirectory