org.apache.directory.server.ldap.replication
Class SyncreplConfiguration

java.lang.Object
  org.apache.directory.server.ldap.replication.SyncreplConfiguration

All Implemented Interfaces:

ReplicationConsumerConfig

public class SyncreplConfiguration
extends Object
implements ReplicationConsumerConfig

A class for holding the syncrepl consumer's configuration. the following parameters are part of the Syncrepl Consuer configuration :

• remoteHost : the remote server's name, defaults to 'localhost'
• remotePort : the remote server's LDAP port, defaults to 389
• replUserDn : The replication User's DN
• replUserPassword : The replication User's password
• refreshNPersist : the replication mode, defaults to 'true'
• refreshInterval : the interval between replications when in refreshOnly mode, defaults to 60s
• baseDn : the base from which to fetch entries on the remote server
• filter : the filter to select entries,defaults to (ObjectClass=*)
• attributes : the list of attributes to replicate, defaults to all
• searchSizeLimit : the maximum number of entries to fetch, defaults to no limit
• searchTimeout : the maximum delay to wait for entries, defaults to no limit
• searchScope : the scope, defaults to SUBTREE
• aliasDerefMode : set the aliss derefence policy, defaults to NEVER
• replicaId : the replica identifier
• configEntryDn : the configuration entry's DN
• chaseReferrals : tells if we chase referrals, defaults to false
• cookie : the replication cookie
• useTls : the connection uses TLS, defaults to true
• strictCertVerification : strictly verify the certificate, defaults to true
• trustManager : the trustManager to use, defaults to @link{NoVerificationTrustManager}

Author:

Apache Directory Project

Constructor Summary

SyncreplConfiguration()
Creates a new instance of SyncreplConfiguration

Method Summary

org.apache.directory.shared.ldap.model.message.AliasDerefMode	getAliasDerefMode()
String[]	getAttributes()
String	getBaseDn()
org.apache.directory.shared.ldap.model.name.Dn	getConfigEntryDn()
byte[]	getCookie()
String	getFilter()
long	getRefreshInterval()
String	getRemoteHost()
int	getRemotePort()
int	getReplicaId()
String	getReplUserDn()
byte[]	getReplUserPassword()
org.apache.directory.shared.ldap.model.message.SearchScope	getSearchScope()
int	getSearchSizeLimit()
int	getSearchTimeout()
X509TrustManager	getTrustManager()
boolean	isChaseReferrals() Tells if we chase referrals
boolean	isRefreshNPersist()
boolean	isStoreCookieInFile() a flag to indicate to store the cookie in a file, default is false NOTE: a value of true indicates that the cookie will be stored on file system, which is useful while testing the consumer without loading config partition
boolean	isStrictCertVerification()
boolean	isUseTls()
void	setAliasDerefMode(org.apache.directory.shared.ldap.model.message.AliasDerefMode aliasDerefMode)
void	setAttributes(String[] attr)
void	setBaseDn(String baseDn)
void	setChaseReferrals(boolean chaseReferrals)
void	setConfigEntryDn(org.apache.directory.shared.ldap.model.name.Dn configEntryDn)
void	setCookie(byte[] cookie)
void	setFilter(String filter)
void	setRefreshInterval(long refreshInterval)
void	setRefreshNPersist(boolean refreshNPersist)
void	setRemoteHost(String remoteHost)
void	setRemotePort(int remotePort)
void	setReplicaId(int replicaId)
void	setReplUserDn(String replUserdDn)
void	setReplUserPassword(byte[] replUserPassword)
void	setSearchScope(org.apache.directory.shared.ldap.model.message.SearchScope searchScope)
void	setSearchSizeLimit(int searchSizeLimit)
void	setSearchTimeout(int searchTimeout)
void	setStrictCertVerification(boolean strictCertVerification) set the strict certificate verification
void	setUseTls(boolean useTls) set the option to turn on/off use of TLS

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SyncreplConfiguration

public SyncreplConfiguration()

Creates a new instance of SyncreplConfiguration

Method Detail

getRemoteHost

public String getRemoteHost()

Returns:

the remote Host

setRemoteHost

public void setRemoteHost(String remoteHost)

Parameters:

remoteHost - the remote Host to set

getRemotePort

public int getRemotePort()

Returns:

the port

setRemotePort

public void setRemotePort(int remotePort)

Parameters:

remotePort - the remote port to set

getReplUserDn

public String getReplUserDn()

Returns:

the replication user's Dn

setReplUserDn

public void setReplUserDn(String replUserdDn)

Parameters:

replUserdDn - the Dn of the replication user

getReplUserPassword

public byte[] getReplUserPassword()

Returns:

the replication user's password

setReplUserPassword

public void setReplUserPassword(byte[] replUserPassword)

Parameters:

replUserPassword - the replication user's password

isRefreshNPersist

public boolean isRefreshNPersist()

Returns:

the refreshPersist

setRefreshNPersist

public void setRefreshNPersist(boolean refreshNPersist)

Parameters:

refreshNPersist - the falg indicating to run the consumer in refreshAndPersist mode

getRefreshInterval

public long getRefreshInterval()

Returns:

the refresh interval

setRefreshInterval

public void setRefreshInterval(long refreshInterval)

Parameters:

refreshInterval - the consumerInterval to set

getBaseDn

public String getBaseDn()

Returns:

the baseDn

setBaseDn

public void setBaseDn(String baseDn)

Parameters:

baseDn - the baseDn to set

getFilter

public String getFilter()

Returns:

the filter

setFilter

public void setFilter(String filter)

Parameters:

filter - the filter to set

getAttributes

public String[] getAttributes()

Returns:

the attributes

setAttributes

public void setAttributes(String[] attr)

Parameters:

attr - the attributes to set

getSearchSizeLimit

public int getSearchSizeLimit()

Returns:

the searchSizeLimit

setSearchSizeLimit

public void setSearchSizeLimit(int searchSizeLimit)

Parameters:

searchSizeLimit - the searchSizeLimit to set

getSearchTimeout

public int getSearchTimeout()

Returns:

the searchTimeout

setSearchTimeout

public void setSearchTimeout(int searchTimeout)

Parameters:

searchTimeout - the searchTimeout to set

getSearchScope

public org.apache.directory.shared.ldap.model.message.SearchScope getSearchScope()

Returns:

the searchScope

setSearchScope

public void setSearchScope(org.apache.directory.shared.ldap.model.message.SearchScope searchScope)

Parameters:

searchScope - the searchScope to set

getReplicaId

public int getReplicaId()

Returns:

the replicaId

setReplicaId

public void setReplicaId(int replicaId)

Parameters:

replicaId - the replicaId to set

getAliasDerefMode

public org.apache.directory.shared.ldap.model.message.AliasDerefMode getAliasDerefMode()

Returns:

The ALiasDerefMode parameter

setAliasDerefMode

public void setAliasDerefMode(org.apache.directory.shared.ldap.model.message.AliasDerefMode aliasDerefMode)

Parameters:

aliasDerefMode - Should be either NEVER_DEREF_ALIASES or DEREF_FINDING_BASE_OBJ

getCookie

public byte[] getCookie()

Returns:

The replication cookie

setCookie

public void setCookie(byte[] cookie)

Parameters:

cookie - The cookie to set

isStoreCookieInFile

public boolean isStoreCookieInFile()

a flag to indicate to store the cookie in a file, default is false NOTE: a value of true indicates that the cookie will be stored on file system, which is useful while testing the consumer without loading config partition

isChaseReferrals

public boolean isChaseReferrals()

Tells if we chase referrals

Returns:

true if we chase referals

setChaseReferrals

public void setChaseReferrals(boolean chaseReferrals)

Parameters:

chaseReferrals - Lust be false, always.

getConfigEntryDn

public org.apache.directory.shared.ldap.model.name.Dn getConfigEntryDn()

Returns:

The DN of the configuration entry

isUseTls

public boolean isUseTls()

Returns:

true if we use TLS

setUseTls

public void setUseTls(boolean useTls)

set the option to turn on/off use of TLS

Parameters:

useTls -

isStrictCertVerification

public boolean isStrictCertVerification()

Returns:

true if the certificate verification is enforced

setStrictCertVerification

public void setStrictCertVerification(boolean strictCertVerification)

set the strict certificate verification

Parameters:

strictCertVerification -

getTrustManager

public X509TrustManager getTrustManager()

Returns:

The Trustmanager instance

setConfigEntryDn

public void setConfigEntryDn(org.apache.directory.shared.ldap.model.name.Dn configEntryDn)

Parameters:

configEntryDn - the configEntryDn to set