SyncReplConfiguration

java.lang.Object
- org.apache.directory.server.ldap.replication.SyncReplConfiguration

All Implemented Interfaces:

ReplicationConsumerConfig
```
public class SyncReplConfiguration
extends java.lang.Object
implements ReplicationConsumerConfig
```
A class for holding the syncrepl consumer's configuration. the following parameters are part of the Syncrepl Consumer configuration :
- remoteHost : the remote server's name, defaults to 'localhost'
- remotePort : the remote server's LDAP port, defaults to 10389
- 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}

Field Summary

Fields
Modifier and Type	Field and Description
`private org.apache.directory.api.ldap.model.message.AliasDerefMode`	`aliasDerefMode` alias dereferencing mode, default is set to 'never deref aliases'
`private java.util.Set<java.lang.String>`	`attributes` names of attributes to be replicated, default value is all user attributes
`private java.lang.String`	`baseDn` the base Dn whose content will be searched for replicating
`private boolean`	`chaseReferrals` flag to indicate whether to chase referrals or not, default is false hence passes ManageDsaITControl with syncsearch request
`private org.apache.directory.api.ldap.model.name.Dn`	`configEntryDn` The configuration entry DN
`private byte[]`	`cookie` the cookie received from server
`private java.lang.String`	`filter` the ldap filter for fetching the entries, default value is (objectClass=*)
`private boolean`	`mmrMode` flag to indicate if this node is part of a MMR setup, default value is true
`private java.lang.String`	`producer` The producer, as :
`private long`	`refreshInterval` time interval for successive sync requests, default is 60 seconds
`private boolean`	`refreshNPersist` flag to represent refresh and persist or refresh only mode, defaults to true
`private java.lang.String`	`remoteHost` host name of the syncrepl remote server, default value is localhost
`private int`	`remotePort` port number of the syncrepl provider server, default is 10389
`private int`	`replicaId` the replica's id
`private java.lang.String`	`replUserDn` replication user's Dn
`private byte[]`	`replUserPassword` password for binding with replication user dn
`private org.apache.directory.api.ldap.model.message.SearchScope`	`searchScope` the search scope, default is sub tree level
`private int`	`searchSizeLimit` the maximum number of search results to be fetched default value is 0 (i.e no limit)
`private int`	`searchTimeout` the timeout value to be used while doing a search default value is 0 (i.e no limit)
`private boolean`	`strictCertVerification` flag to indicate the use of strict certificate verification, default is true
`private javax.net.ssl.X509TrustManager`	`trustManager` the X509 certificate trust manager used, default value set to `NoVerificationTrustManager`
`private boolean`	`useTls` flag to indicate the use of TLS, default is true

Constructor Summary

Constructors
Constructor and Description

SyncReplConfiguration()
Creates a new instance of SyncreplConfiguration

Constructors
Constructor and Description
`SyncReplConfiguration()` Creates a new instance of SyncreplConfiguration

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.apache.directory.api.ldap.model.message.AliasDerefMode`	`getAliasDerefMode()`
`java.lang.String[]`	`getAttributes()`
`java.lang.String`	`getBaseDn()`
`org.apache.directory.api.ldap.model.name.Dn`	`getConfigEntryDn()`
`byte[]`	`getCookie()`
`java.lang.String`	`getFilter()`
`java.lang.String`	`getProducer()` A convenient method that concatenates the host and port of the producer
`long`	`getRefreshInterval()`
`java.lang.String`	`getRemoteHost()`
`int`	`getRemotePort()`
`int`	`getReplicaId()`
`java.lang.String`	`getReplUserDn()`
`byte[]`	`getReplUserPassword()`
`org.apache.directory.api.ldap.model.message.SearchScope`	`getSearchScope()`
`int`	`getSearchSizeLimit()`
`int`	`getSearchTimeout()`
`javax.net.ssl.X509TrustManager`	`getTrustManager()`
`boolean`	`isChaseReferrals()` Tells if we chase referrals
`boolean`	`isMmrMode()`
`boolean`	`isRefreshNPersist()`
`boolean`	`isStrictCertVerification()`
`boolean`	`isUseTls()`
`void`	`setAliasDerefMode(org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode)`
`void`	`setAttributes(java.lang.String[] attrs)`
`void`	`setBaseDn(java.lang.String baseDn)`
`void`	`setChaseReferrals(boolean chaseReferrals)`
`void`	`setConfigEntryDn(org.apache.directory.api.ldap.model.name.Dn configEntryDn)`
`void`	`setCookie(byte[] cookie)`
`void`	`setFilter(java.lang.String filter)`
`void`	`setMmrMode(boolean mmrMode)` enable/disable MMR option
`void`	`setRefreshInterval(long refreshInterval)`
`void`	`setRefreshNPersist(boolean refreshNPersist)`
`void`	`setRemoteHost(java.lang.String remoteHost)`
`void`	`setRemotePort(int remotePort)`
`void`	`setReplicaId(int replicaId)`
`void`	`setReplUserDn(java.lang.String replUserdDn)`
`void`	`setReplUserPassword(byte[] replUserPassword)`
`void`	`setSearchScope(org.apache.directory.api.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
`java.lang.String`	`toString()`

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

- Field Detail
  - remoteHost
```
private java.lang.String remoteHost
```
    host name of the syncrepl remote server, default value is localhost
  - remotePort
```
private int remotePort
```
    port number of the syncrepl provider server, default is 10389
  - producer
```
private java.lang.String producer
```
    The producer, as :
  - replUserDn
```
private java.lang.String replUserDn
```
    replication user's Dn
  - replUserPassword
```
private byte[] replUserPassword
```
    password for binding with replication user dn
  - refreshNPersist
```
private boolean refreshNPersist
```
    flag to represent refresh and persist or refresh only mode, defaults to true
  - refreshInterval
```
private long refreshInterval
```
    time interval for successive sync requests, default is 60 seconds
  - baseDn
```
private java.lang.String baseDn
```
    the base Dn whose content will be searched for replicating
  - filter
```
private java.lang.String filter
```
    the ldap filter for fetching the entries, default value is (objectClass=*)
  - attributes
```
private java.util.Set<java.lang.String> attributes
```
    names of attributes to be replicated, default value is all user attributes
  - searchSizeLimit
```
private int searchSizeLimit
```
    the maximum number of search results to be fetched default value is 0 (i.e no limit)
  - searchTimeout
```
private int searchTimeout
```
    the timeout value to be used while doing a search default value is 0 (i.e no limit)
  - searchScope
```
private org.apache.directory.api.ldap.model.message.SearchScope searchScope
```
    the search scope, default is sub tree level
  - aliasDerefMode
```
private org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode
```
    alias dereferencing mode, default is set to 'never deref aliases'
  - cookie
```
private byte[] cookie
```
    the cookie received from server
  - replicaId
```
private int replicaId
```
    the replica's id
  - configEntryDn
```
private org.apache.directory.api.ldap.model.name.Dn configEntryDn
```
    The configuration entry DN
  - chaseReferrals
```
private boolean chaseReferrals
```
    flag to indicate whether to chase referrals or not, default is false hence passes ManageDsaITControl with syncsearch request
  - useTls
```
private boolean useTls
```
    flag to indicate the use of TLS, default is true
  - strictCertVerification
```
private boolean strictCertVerification
```
    flag to indicate the use of strict certificate verification, default is true
  - trustManager
```
private javax.net.ssl.X509TrustManager trustManager
```
    the X509 certificate trust manager used, default value set to NoVerificationTrustManager
  - mmrMode
```
private boolean mmrMode
```
    flag to indicate if this node is part of a MMR setup, default value is true
- Constructor Detail
  - SyncReplConfiguration
```
public SyncReplConfiguration()
```
    Creates a new instance of SyncreplConfiguration
- Method Detail
  - getRemoteHost
```
public java.lang.String getRemoteHost()
```
    Returns:
    
    the remote Host
  - setRemoteHost
```
public void setRemoteHost(java.lang.String remoteHost)
```
    Parameters:
    
    remoteHost - the remote Host to set
  - getProducer
```
public java.lang.String getProducer()
```
    A convenient method that concatenates the host and port of the producer
    
    Returns:
    
    The : the consumer is connected to
  - getRemotePort
```
public int getRemotePort()
```
    Returns:
    
    the port
  - setRemotePort
```
public void setRemotePort(int remotePort)
```
    Parameters:
    
    remotePort - the remote port to set
  - getReplUserDn
```
public java.lang.String getReplUserDn()
```
    Returns:
    
    the replication user's Dn
  - setReplUserDn
```
public void setReplUserDn(java.lang.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 java.lang.String getBaseDn()
```
    Returns:
    
    the baseDn
  - setBaseDn
```
public void setBaseDn(java.lang.String baseDn)
```
    Parameters:
    
    baseDn - the baseDn to set
  - getFilter
```
public java.lang.String getFilter()
```
    Returns:
    
    the filter
  - setFilter
```
public void setFilter(java.lang.String filter)
```
    Parameters:
    
    filter - the filter to set
  - getAttributes
```
public java.lang.String[] getAttributes()
```
    Returns:
    
    the attributes
  - setAttributes
```
public void setAttributes(java.lang.String[] attrs)
```
    Parameters:
    
    attrs - 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.api.ldap.model.message.SearchScope getSearchScope()
```
    Returns:
    
    the searchScope
  - setSearchScope
```
public void setSearchScope(org.apache.directory.api.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.api.ldap.model.message.AliasDerefMode getAliasDerefMode()
```
    Returns:
    
    The ALiasDerefMode parameter
  - setAliasDerefMode
```
public void setAliasDerefMode(org.apache.directory.api.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
  - 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.api.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 javax.net.ssl.X509TrustManager getTrustManager()
```
    Returns:
    
    The Trustmanager instance
  - setConfigEntryDn
```
public void setConfigEntryDn(org.apache.directory.api.ldap.model.name.Dn configEntryDn)
```
    Parameters:
    
    configEntryDn - the configEntryDn to set
  - isMmrMode
```
public boolean isMmrMode()
```
    Returns:
    
    true if this node is part of MMR setup
  - setMmrMode
```
public void setMmrMode(boolean mmrMode)
```
    enable/disable MMR option
    
    Parameters:
    
    mmrMode -
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class SyncReplConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

remoteHost

remotePort

producer

replUserDn

replUserPassword

refreshNPersist

refreshInterval

baseDn

filter

attributes

searchSizeLimit

searchTimeout

searchScope

aliasDerefMode

cookie

replicaId

configEntryDn

chaseReferrals

useTls

strictCertVerification

trustManager

mmrMode

Constructor Detail

SyncReplConfiguration

Method Detail

getRemoteHost

setRemoteHost

getProducer

getRemotePort

setRemotePort

getReplUserDn

setReplUserDn

getReplUserPassword

setReplUserPassword

isRefreshNPersist

setRefreshNPersist

getRefreshInterval

setRefreshInterval

getBaseDn

setBaseDn

getFilter

setFilter

getAttributes

setAttributes

getSearchSizeLimit

setSearchSizeLimit

getSearchTimeout

setSearchTimeout

getSearchScope

setSearchScope

getReplicaId

setReplicaId

getAliasDerefMode

setAliasDerefMode

getCookie

setCookie

isChaseReferrals

setChaseReferrals

getConfigEntryDn

isUseTls

setUseTls

isStrictCertVerification

setStrictCertVerification

getTrustManager

setConfigEntryDn

isMmrMode

setMmrMode

toString