org.apache.directory.server.config.beans

Class LdapServerBean

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.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	certificatePassword The certificate password
private boolean	confidentialityRequired
private java.util.List<ExtendedOpHandlerBean>	extendedOpHandlers The list of supported extended operation handlers
private java.lang.String	keystoreFile The keystore file
private int	maxPDUSize The maximum size of an incoming PDU
private int	maxSizeLimit The maximum number of entries returned by the server
private int	maxTimeLimit The maximum time to execute a request on the server
private java.util.List<ReplConsumerBean>	replConsumers The replication consumer Bean
private boolean	replEnabled A flag telling if the replication is enabled
private int	replPingerSleep the time interval between subsequent pings to each replication provider
private java.lang.String	replReqHandler the replication request handler, server will be in replication provider/master mode if a valid FQCN is given
private java.lang.String	saslHost The SASL host
private java.util.List<SaslMechHandlerBean>	saslMechHandlers The list of supported mechanisms
private java.lang.String	saslPrincipal The SASL principal
private java.util.List<java.lang.String>	saslRealms The SASL realms

Constructor Summary

Constructors

Constructor and Description
LdapServerBean() Create a new LdapServerBean instance

Method Summary

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

Field Detail

confidentialityRequired

@ConfigurationElement(attributeType="ads-confidentialityRequired")
private boolean confidentialityRequired

maxSizeLimit

@ConfigurationElement(attributeType="ads-maxSizeLimit")
private int maxSizeLimit

The maximum number of entries returned by the server

maxTimeLimit

@ConfigurationElement(attributeType="ads-maxTimeLimit")
private int maxTimeLimit

The maximum time to execute a request on the server

maxPDUSize

@ConfigurationElement(attributeType="ads-maxPDUSize")
private int maxPDUSize

The maximum size of an incoming PDU

saslHost

@ConfigurationElement(attributeType="ads-saslHost")
private java.lang.String saslHost

The SASL host

saslPrincipal

@ConfigurationElement(attributeType="ads-saslPrincipal")
private java.lang.String saslPrincipal

The SASL principal

saslRealms

@ConfigurationElement(attributeType="ads-saslRealms")
private java.util.List<java.lang.String> saslRealms

The SASL realms

keystoreFile

@ConfigurationElement(attributeType="ads-keystoreFile",
                      isOptional=true)
private java.lang.String keystoreFile

The keystore file

certificatePassword

@ConfigurationElement(attributeType="ads-certificatePassword",
                      isOptional=true)
private java.lang.String certificatePassword

The certificate password

replEnabled

@ConfigurationElement(attributeType="ads-replEnabled")
private boolean replEnabled

A flag telling if the replication is enabled

replReqHandler

@ConfigurationElement(attributeType="ads-replReqHandler",
                      isOptional=true)
private java.lang.String replReqHandler

the replication request handler, server will be in replication provider/master mode if a valid FQCN is given

replConsumers

@ConfigurationElement(objectClass="ads-replConsumer",
                      container="replConsumers",
                      isOptional=true)
private java.util.List<ReplConsumerBean> replConsumers

The replication consumer Bean

saslMechHandlers

@ConfigurationElement(objectClass="ads-saslMechHandler",
                      container="saslMechHandlers",
                      isOptional=true)
private java.util.List<SaslMechHandlerBean> saslMechHandlers

The list of supported mechanisms

extendedOpHandlers

@ConfigurationElement(objectClass="ads-extendedOpHandler",
                      container="extendedOpHandlers",
                      isOptional=true)
private java.util.List<ExtendedOpHandlerBean> extendedOpHandlers

The list of supported extended operation handlers

replPingerSleep

@ConfigurationElement(attributeType="ads-replPingerSleep")
private int replPingerSleep

the time interval between subsequent pings to each replication provider

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 java.lang.String getLdapServerSaslHost()

Returns:

the ldapServerSaslHost

setLdapServerSaslHost

public void setLdapServerSaslHost(java.lang.String ldapServerSaslHost)

Parameters:

ldapServerSaslHost - the ldapServerSaslHost to set

getLdapServerSaslPrincipal

public java.lang.String getLdapServerSaslPrincipal()

Returns:

the ldapServerSaslPrincipal

setLdapServerSaslPrincipal

public void setLdapServerSaslPrincipal(java.lang.String ldapServerSaslPrincipal)

Parameters:

ldapServerSaslPrincipal - the ldapServerSaslPrincipal to set

getLdapServerSaslRealms

public java.util.List<java.lang.String> getLdapServerSaslRealms()

Returns:

the ldapServerSaslRealms

setLdapServerSaslRealms

public void setLdapServerSaslRealms(java.util.List<java.lang.String> ldapServerSaslRealms)

Parameters:

ldapServerSaslRealms - the ldapServerSaslRealms to set

addSaslRealms

public void addSaslRealms(java.lang.String... ldapServerSaslRealms)

Parameters:

ldapServerSaslRealms - the ldapServerSaslRealms to add

getLdapServerKeystoreFile

public java.lang.String getLdapServerKeystoreFile()

Returns:

the ldapServerKeystoreFile

setLdapServerKeystoreFile

public void setLdapServerKeystoreFile(java.lang.String ldapServerKeystoreFile)

Parameters:

ldapServerKeystoreFile - the ldapServerKeystoreFile to set

getLdapServerCertificatePassword

public java.lang.String getLdapServerCertificatePassword()

Returns:

the ldapServerCertificatePassword

setLdapServerCertificatePassword

public void setLdapServerCertificatePassword(java.lang.String ldapServerCertificatePassword)

Parameters:

ldapServerCertificatePassword - the ldapServerCertificatePassword to set

getReplReqHandler

public java.lang.String getReplReqHandler()

Returns:

the replReqHandler

setReplReqHandler

public void setReplReqHandler(java.lang.String replReqHandler)

Parameters:

replReqHandler - the replReqHandler to set

getSaslMechHandlers

public java.util.List<SaslMechHandlerBean> getSaslMechHandlers()

Returns:

the saslMechHandlers

setSaslMechHandlers

public void setSaslMechHandlers(java.util.List<SaslMechHandlerBean> saslMechHandlers)

Parameters:

saslMechHandlers - the saslMechHandlers to set

setSaslMechHandlers

public void setSaslMechHandlers(SaslMechHandlerBean... saslMechHandlers)

Parameters:

saslMechHandlers - the saslMechHandlers to add

getExtendedOps

public java.util.List<ExtendedOpHandlerBean> getExtendedOps()

Returns:

the extendedOps

setExtendedOps

public void setExtendedOps(java.util.List<ExtendedOpHandlerBean> extendedOps)

Parameters:

extendedOps - the extendedOps to set

addExtendedOps

public void addExtendedOps(ExtendedOpHandlerBean... extendedOps)

Parameters:

extendedOps - the extendedOps to add

getReplConsumers

public java.util.List<ReplConsumerBean> getReplConsumers()

Returns:

the Replication Consumer Bean

setReplConsumer

public void setReplConsumer(java.util.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 java.lang.String toString(java.lang.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 java.lang.String toString()

Overrides:

toString in class DSBasedServerBean