LdapServerBean (ApacheDS Server Config 2.0.0.AM25 API)

java.lang.Object
- org.apache.directory.server.config.beans.AdsBaseBean
- - org.apache.directory.server.config.beans.ServerBean
  - - org.apache.directory.server.config.beans.DSBasedServerBean
    - - org.apache.directory.server.config.beans.LdapServerBean

```
public class LdapServerBean
extends DSBasedServerBean
```
A class used to store the LdapServer configuration.

Author:

Apache Directory Project

Constructor Summary

Constructors
Constructor and Description

LdapServerBean()
Create a new LdapServerBean instance

Constructors
Constructor and Description
`LdapServerBean()` Create a new LdapServerBean instance

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExtendedOps(ExtendedOpHandlerBean... extendedOps)`
`void`	`addReplConsumers(ReplConsumerBean... replConsumers)`
`void`	`addSaslRealms(String... ldapServerSaslRealms)`
`List<ExtendedOpHandlerBean>`	`getExtendedOps()`
`String`	`getLdapServerCertificatePassword()`
`String`	`getLdapServerKeystoreFile()`
`int`	`getLdapServerMaxSizeLimit()`
`int`	`getLdapServerMaxTimeLimit()`
`String`	`getLdapServerSaslHost()`
`String`	`getLdapServerSaslPrincipal()`
`List<String>`	`getLdapServerSaslRealms()`
`int`	`getMaxPDUSize()`
`List<ReplConsumerBean>`	`getReplConsumers()`
`int`	`getReplPingerSleep()`
`String`	`getReplReqHandler()`
`List<SaslMechHandlerBean>`	`getSaslMechHandlers()`
`boolean`	`isLdapServerConfidentialityRequired()`
`boolean`	`isReplEnabled()`
`void`	`setExtendedOps(List<ExtendedOpHandlerBean> extendedOps)`
`void`	`setLdapServerCertificatePassword(String ldapServerCertificatePassword)`
`void`	`setLdapServerConfidentialityRequired(boolean ldapServerConfidentialityRequired)`
`void`	`setLdapServerKeystoreFile(String ldapServerKeystoreFile)`
`void`	`setLdapServerMaxSizeLimit(int ldapServerMaxSizeLimit)`
`void`	`setLdapServerMaxTimeLimit(int ldapServerMaxTimeLimit)`
`void`	`setLdapServerSaslHost(String ldapServerSaslHost)`
`void`	`setLdapServerSaslPrincipal(String ldapServerSaslPrincipal)`
`void`	`setLdapServerSaslRealms(List<String> ldapServerSaslRealms)`
`void`	`setMaxPDUSize(int maxPDUSize)`
`void`	`setReplConsumer(List<ReplConsumerBean> replConsumers)`
`void`	`setReplEnabled(boolean replEnabled)` Enable or disable the replication
`void`	`setReplPingerSleep(int replPingerSleep)`
`void`	`setReplReqHandler(String replReqHandler)`
`void`	`setSaslMechHandlers(List<SaslMechHandlerBean> saslMechHandlers)`
`void`	`setSaslMechHandlers(SaslMechHandlerBean... saslMechHandlers)`
`String`	`toString()`
`String`	`toString(String tabs)`

Methods inherited from class org.apache.directory.server.config.beans.DSBasedServerBean
getSearchBaseDn, setSearchBaseDn

Methods inherited from class org.apache.directory.server.config.beans.ServerBean
addTransports, getServerId, getTransports, setServerId, setTransports

Methods inherited from class org.apache.directory.server.config.beans.AdsBaseBean
getDescription, getDn, isDisabled, isEnabled, setDescription, setDn, setEnabled, toString, toString, toString, toString

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

- Constructor Detail
  - LdapServerBean
```
public LdapServerBean()
```
    Create a new LdapServerBean instance
- Method Detail
  - isLdapServerConfidentialityRequired
```
public boolean isLdapServerConfidentialityRequired()
```
    Returns:
    
    the ldapServerConfidentialityRequired
  - setLdapServerConfidentialityRequired
```
public void setLdapServerConfidentialityRequired(boolean ldapServerConfidentialityRequired)
```
    Parameters:
    
    ldapServerConfidentialityRequired - the ldapServerConfidentialityRequired to set
  - getLdapServerMaxSizeLimit
```
public int getLdapServerMaxSizeLimit()
```
    Returns:
    
    the ldapServerMaxSizeLimit
  - setLdapServerMaxSizeLimit
```
public void setLdapServerMaxSizeLimit(int ldapServerMaxSizeLimit)
```
    Parameters:
    
    ldapServerMaxSizeLimit - the ldapServerMaxSizeLimit to set
  - getLdapServerMaxTimeLimit
```
public int getLdapServerMaxTimeLimit()
```
    Returns:
    
    the ldapServerMaxTimeLimit
  - setLdapServerMaxTimeLimit
```
public void setLdapServerMaxTimeLimit(int ldapServerMaxTimeLimit)
```
    Parameters:
    
    ldapServerMaxTimeLimit - the ldapServerMaxTimeLimit to set
  - getLdapServerSaslHost
```
public String getLdapServerSaslHost()
```
    Returns:
    
    the ldapServerSaslHost
  - setLdapServerSaslHost
```
public void setLdapServerSaslHost(String ldapServerSaslHost)
```
    Parameters:
    
    ldapServerSaslHost - the ldapServerSaslHost to set
  - getLdapServerSaslPrincipal
```
public String getLdapServerSaslPrincipal()
```
    Returns:
    
    the ldapServerSaslPrincipal
  - setLdapServerSaslPrincipal
```
public void setLdapServerSaslPrincipal(String ldapServerSaslPrincipal)
```
    Parameters:
    
    ldapServerSaslPrincipal - the ldapServerSaslPrincipal to set
  - getLdapServerSaslRealms
```
public List<String> getLdapServerSaslRealms()
```
    Returns:
    
    the ldapServerSaslRealms
  - setLdapServerSaslRealms
```
public void setLdapServerSaslRealms(List<String> ldapServerSaslRealms)
```
    Parameters:
    
    ldapServerSaslRealms - the ldapServerSaslRealms to set
  - addSaslRealms
```
public void addSaslRealms(String... ldapServerSaslRealms)
```
    Parameters:
    
    ldapServerSaslRealms - the ldapServerSaslRealms to add
  - getLdapServerKeystoreFile
```
public String getLdapServerKeystoreFile()
```
    Returns:
    
    the ldapServerKeystoreFile
  - setLdapServerKeystoreFile
```
public void setLdapServerKeystoreFile(String ldapServerKeystoreFile)
```
    Parameters:
    
    ldapServerKeystoreFile - the ldapServerKeystoreFile to set
  - getLdapServerCertificatePassword
```
public String getLdapServerCertificatePassword()
```
    Returns:
    
    the ldapServerCertificatePassword
  - setLdapServerCertificatePassword
```
public void setLdapServerCertificatePassword(String ldapServerCertificatePassword)
```
    Parameters:
    
    ldapServerCertificatePassword - the ldapServerCertificatePassword to set
  - getReplReqHandler
```
public String getReplReqHandler()
```
    Returns:
    
    the replReqHandler
  - setReplReqHandler
```
public void setReplReqHandler(String replReqHandler)
```
    Parameters:
    
    replReqHandler - the replReqHandler to set
  - getSaslMechHandlers
```
public List<SaslMechHandlerBean> getSaslMechHandlers()
```
    Returns:
    
    the saslMechHandlers
  - setSaslMechHandlers
```
public void setSaslMechHandlers(List<SaslMechHandlerBean> saslMechHandlers)
```
    Parameters:
    
    saslMechHandlers - the saslMechHandlers to set
  - setSaslMechHandlers
```
public void setSaslMechHandlers(SaslMechHandlerBean... saslMechHandlers)
```
    Parameters:
    
    saslMechHandlers - the saslMechHandlers to add
  - getExtendedOps
```
public List<ExtendedOpHandlerBean> getExtendedOps()
```
    Returns:
    
    the extendedOps
  - setExtendedOps
```
public void setExtendedOps(List<ExtendedOpHandlerBean> extendedOps)
```
    Parameters:
    
    extendedOps - the extendedOps to set
  - addExtendedOps
```
public void addExtendedOps(ExtendedOpHandlerBean... extendedOps)
```
    Parameters:
    
    extendedOps - the extendedOps to add
  - getReplConsumers
```
public List<ReplConsumerBean> getReplConsumers()
```
    Returns:
    
    the Replication Consumer Bean
  - setReplConsumer
```
public void setReplConsumer(List<ReplConsumerBean> replConsumers)
```
    Parameters:
    
    replConsumers - the Replication Consumer Bean to set
  - addReplConsumers
```
public void addReplConsumers(ReplConsumerBean... replConsumers)
```
    Parameters:
    
    replConsumers - the Replication Consumer Bean to set
  - getMaxPDUSize
```
public int getMaxPDUSize()
```
    Returns:
    
    the maxPDUSize
  - setMaxPDUSize
```
public void setMaxPDUSize(int maxPDUSize)
```
    Parameters:
    
    maxPDUSize - the maxPDUSize to set
  - toString
```
public String toString(String tabs)
```
    Overrides:
    
    toString in class DSBasedServerBean
  - isReplEnabled
```
public boolean isReplEnabled()
```
    Returns:
    
    True if the replication service should be enabled
  - setReplEnabled
```
public void setReplEnabled(boolean replEnabled)
```
    Enable or disable the replication
    
    Parameters:
    
    replEnabled - The new value
  - getReplPingerSleep
```
public int getReplPingerSleep()
```
  - setReplPingerSleep
```
public void setReplPingerSleep(int replPingerSleep)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class DSBasedServerBean

Class LdapServerBean

Constructor Summary

Method Summary

Methods inherited from class org.apache.directory.server.config.beans.DSBasedServerBean

Methods inherited from class org.apache.directory.server.config.beans.ServerBean

Methods inherited from class org.apache.directory.server.config.beans.AdsBaseBean

Methods inherited from class java.lang.Object

Constructor Detail

LdapServerBean

Method Detail

isLdapServerConfidentialityRequired

setLdapServerConfidentialityRequired

getLdapServerMaxSizeLimit

setLdapServerMaxSizeLimit

getLdapServerMaxTimeLimit

setLdapServerMaxTimeLimit

getLdapServerSaslHost

setLdapServerSaslHost

getLdapServerSaslPrincipal

setLdapServerSaslPrincipal

getLdapServerSaslRealms

setLdapServerSaslRealms

addSaslRealms

getLdapServerKeystoreFile

setLdapServerKeystoreFile

getLdapServerCertificatePassword

setLdapServerCertificatePassword

getReplReqHandler

setReplReqHandler

getSaslMechHandlers

setSaslMechHandlers

setSaslMechHandlers

getExtendedOps

setExtendedOps

addExtendedOps

getReplConsumers

setReplConsumer

addReplConsumers

getMaxPDUSize

setMaxPDUSize

toString

isReplEnabled

setReplEnabled

getReplPingerSleep

setReplPingerSleep

toString