LdapDirHandlerConfig (bw-carddav-server 4.0.2 API)

java.lang.Object
- org.bedework.util.misc.Logged
- - org.bedework.util.config.ConfigBase<T>
  - - org.bedework.util.config.HibernateConfigBase<T>
    - - org.bedework.carddav.common.config.DirHandlerConfig<LdapDirHandlerConfig>
      - org.bedework.carddav.server.config.LdapDirHandlerConfig

All Implemented Interfaces:

Serializable, Comparable<LdapDirHandlerConfig>, org.bedework.util.config.HibernateConfigI
```
public class LdapDirHandlerConfig
extends DirHandlerConfig<LdapDirHandlerConfig>
```
This class defines the various properties we need to make a connection and retrieve a group and user information via ldap.

Author:

Mike Douglass

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.bedework.util.config.ConfigBase
  ns
- Fields inherited from class org.bedework.util.misc.Logged
  auditLoggerName, debug, errorLoggerName, metricsLoggerName

Constructor Summary

Constructors
Constructor and Description

LdapDirHandlerConfig()

Constructors
Constructor and Description
`LdapDirHandlerConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAddressbookEntryIdAttr()`
`String`	`getAddressbookEntryObjectClass()`
`String`	`getAddressbookIdAttr()`
`String`	`getAddressbookObjectClass()`
`String[]`	`getAttrIdList()`
`String`	`getAttrIds()`
`String`	`getAuthDn()` If we need an id to authenticate this is it.
`String`	`getAuthPw()` If we need an id to authenticate this is it.
`String`	`getBaseDn()`
`String`	`getFolderIdAttr()`
`String`	`getFolderObjectClass()`
`String`	`getGroupMemberAttr()` Attribute we want back identifying a member
`String`	`getInitialContextFactory()`
`String`	`getPrincipalIdAttr()` Attribute we search for to get a group
`String`	`getProviderUrl()` URL of ldap server
`int`	`getQueryLimit()`
`String`	`getSecurityAuthentication()`
`String`	`getSecurityProtocol()` e.g "ssl"
`void`	`setAddressbookEntryIdAttr(String val)`
`void`	`setAddressbookEntryObjectClass(String val)`
`void`	`setAddressbookIdAttr(String val)`
`void`	`setAddressbookObjectClass(String val)`
`void`	`setAttrIds(String val)`
`void`	`setAuthDn(String val)` If we need an id to authenticate this is it.
`void`	`setAuthPw(String val)` If we need an id to authenticate this is the pw.
`void`	`setBaseDn(String val)`
`void`	`setFolderIdAttr(String val)`
`void`	`setFolderObjectClass(String val)`
`void`	`setGroupMemberAttr(String val)` Attribute we want back identifying a member
`void`	`setInitialContextFactory(String val)`
`void`	`setPrincipalIdAttr(String val)` Attribute we search for to get a principal
`void`	`setProviderUrl(String val)` URL of ldap server
`void`	`setQueryLimit(int val)` Set the query limit - 0 for no limit
`void`	`setSecurityAuthentication(String val)`
`void`	`setSecurityProtocol(String val)` e.g.

Methods inherited from class org.bedework.carddav.common.config.DirHandlerConfig
compareTo, getAddressBook, getCardKind, getCardPathPrefix, getCardPathPrefixes, getClassName, getConfBeanClass, getConfClass, getDirectory, getOwnerHref, getPathPrefix, getPrincipalPrefix, hashCode, setAddressBook, setCardKind, setCardPathPrefix, setCardPathPrefixes, setClassName, setConfBeanClass, setConfClass, setDirectory, setOwnerHref, setPathPrefix, setPrincipalPrefix, toStringSegment

Methods inherited from class org.bedework.util.config.HibernateConfigBase
addHibernateProperty, getHibernateDialect, getHibernateProperties, getHibernateProperty, removeHibernateProperty, setHibernateDialect, setHibernateProperties, setHibernateProperty, toString

Methods inherited from class org.bedework.util.config.ConfigBase
addListProperty, compareTo, fromXml, fromXml, fromXml, getLastChanged, getName, getProperty, markChanged, removeProperty, setListProperty, setName, toProperties, toXml

Methods inherited from class org.bedework.util.misc.Logged
audit, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, getAuditLoggerIfEnabled, getErrorLoggerIfEnabled, getLogger, getLogger, getMetricsLoggerIfEnabled, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsLoggerEnabled, metrics, warn

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

- Constructor Detail
  - LdapDirHandlerConfig
```
public LdapDirHandlerConfig()
```
- Method Detail
  - setInitialContextFactory
```
public void setInitialContextFactory(String val)
```
    Parameters:
    
    val -
  - getInitialContextFactory
```
public String getInitialContextFactory()
```
    Returns:
    
    String
  - setSecurityAuthentication
```
public void setSecurityAuthentication(String val)
```
    Parameters:
    
    val -
  - getSecurityAuthentication
```
public String getSecurityAuthentication()
```
    Returns:
    
    String
  - setSecurityProtocol
```
public void setSecurityProtocol(String val)
```
    e.g. "ssl"
    
    Parameters:
    
    val -
  - getSecurityProtocol
```
public String getSecurityProtocol()
```
    e.g "ssl"
    
    Returns:
    
    String val
  - setProviderUrl
```
public void setProviderUrl(String val)
```
    URL of ldap server
    
    Parameters:
    
    val -
  - getProviderUrl
```
public String getProviderUrl()
```
    URL of ldap server
    
    Returns:
    
    String val
  - setBaseDn
```
public void setBaseDn(String val)
```
    Parameters:
    
    val -
  - getBaseDn
```
public String getBaseDn()
```
    Returns:
    
    String val
  - setQueryLimit
```
public void setQueryLimit(int val)
```
    Set the query limit - 0 for no limit
    
    Parameters:
    
    val -
  - getQueryLimit
```
public int getQueryLimit()
```
    Returns:
    
    int val
  - setAttrIds
```
public void setAttrIds(String val)
```
    Parameters:
    
    val -
  - getAttrIds
```
public String getAttrIds()
```
    Returns:
    
    String val
  - setFolderObjectClass
```
public void setFolderObjectClass(String val)
```
    Parameters:
    
    val -
  - getFolderObjectClass
```
public String getFolderObjectClass()
```
    Returns:
    
    String val
  - setAddressbookObjectClass
```
public void setAddressbookObjectClass(String val)
```
    Parameters:
    
    val -
  - getAddressbookObjectClass
```
public String getAddressbookObjectClass()
```
    Returns:
    
    String val
  - setAddressbookEntryObjectClass
```
public void setAddressbookEntryObjectClass(String val)
```
    Parameters:
    
    val -
  - getAddressbookEntryObjectClass
```
public String getAddressbookEntryObjectClass()
```
    Returns:
    
    String val
  - setPrincipalIdAttr
```
public void setPrincipalIdAttr(String val)
```
    Attribute we search for to get a principal
    
    Parameters:
    
    val -
  - getPrincipalIdAttr
```
public String getPrincipalIdAttr()
```
    Attribute we search for to get a group
    
    Returns:
    
    String val
  - setFolderIdAttr
```
public void setFolderIdAttr(String val)
```
    Parameters:
    
    val -
  - getFolderIdAttr
```
public String getFolderIdAttr()
```
    Returns:
    
    String val
  - setAddressbookIdAttr
```
public void setAddressbookIdAttr(String val)
```
    Parameters:
    
    val -
  - getAddressbookIdAttr
```
public String getAddressbookIdAttr()
```
    Returns:
    
    String val
  - setAddressbookEntryIdAttr
```
public void setAddressbookEntryIdAttr(String val)
```
    Parameters:
    
    val -
  - getAddressbookEntryIdAttr
```
public String getAddressbookEntryIdAttr()
```
    Returns:
    
    String val
  - setGroupMemberAttr
```
public void setGroupMemberAttr(String val)
```
    Attribute we want back identifying a member
    
    Parameters:
    
    val -
  - getGroupMemberAttr
```
public String getGroupMemberAttr()
```
    Attribute we want back identifying a member
    
    Returns:
    
    String val
  - setAuthDn
```
public void setAuthDn(String val)
```
    If we need an id to authenticate this is it.
    
    Parameters:
    
    val -
  - getAuthDn
```
public String getAuthDn()
```
    If we need an id to authenticate this is it.
    
    Returns:
    
    String val
  - setAuthPw
```
public void setAuthPw(String val)
```
    If we need an id to authenticate this is the pw.
    
    Parameters:
    
    val -
  - getAuthPw
```
public String getAuthPw()
```
    If we need an id to authenticate this is it.
    
    Returns:
    
    String val
  - getAttrIdList
```
public String[] getAttrIdList()
```
    Returns:
    
    String[] val

Class LdapDirHandlerConfig

Field Summary

Fields inherited from class org.bedework.util.config.ConfigBase

Fields inherited from class org.bedework.util.misc.Logged

Constructor Summary

Method Summary

Methods inherited from class org.bedework.carddav.common.config.DirHandlerConfig

Methods inherited from class org.bedework.util.config.HibernateConfigBase

Methods inherited from class org.bedework.util.config.ConfigBase

Methods inherited from class org.bedework.util.misc.Logged

Methods inherited from class java.lang.Object

Constructor Detail

LdapDirHandlerConfig

Method Detail

setInitialContextFactory

getInitialContextFactory

setSecurityAuthentication

getSecurityAuthentication

setSecurityProtocol

getSecurityProtocol

setProviderUrl

getProviderUrl

setBaseDn

getBaseDn

setQueryLimit

getQueryLimit

setAttrIds

getAttrIds

setFolderObjectClass

getFolderObjectClass

setAddressbookObjectClass

getAddressbookObjectClass

setAddressbookEntryObjectClass

getAddressbookEntryObjectClass

setPrincipalIdAttr

getPrincipalIdAttr

setFolderIdAttr

getFolderIdAttr

setAddressbookIdAttr

getAddressbookIdAttr

setAddressbookEntryIdAttr

getAddressbookEntryIdAttr

setGroupMemberAttr

getGroupMemberAttr

setAuthDn

getAuthDn

setAuthPw

getAuthPw

getAttrIdList