org.apache.directory.server.annotations

Annotation Type CreateConsumer

@Documented
@Inherited
@Retention(value=RUNTIME)
@Target(value={METHOD,TYPE})
public @interface CreateConsumer

A annotation used to define a replication consumer configuration. Many elements can be configured :

• 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
• cookie : the replication cookie
• replicaId : the replica identifier
• configEntryDn : the configuration entry's DN
• chaseReferrals : tells if we chase referrals, defaults to false
• 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

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	baseDn the base Dn whose content will be searched for replicating
int	replicaId the replica's id
String	replUserDn replication user's Dn
String	replUserPassword password for binding with replication user dn

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
org.apache.directory.api.ldap.model.message.AliasDerefMode	aliasDerefMode alias dereferencing mode, default is set to 'never deref aliases'
String[]	attributes names of attributes to be replicated, default value is all user attributes
boolean	chaseReferrals flag to indicate whether to chase referrals or not, default is false hence passes ManageDsaITControl with syncsearch request
String	configEntryDn The configuration entry DN
String	filter the ldap filter for fetching the entries, default value is (objectClass=*)
long	refreshInterval time interval for successive sync requests, default is 60 seconds
boolean	refreshNPersist flag to represent refresh and persist or refresh only mode, defaults to true
String	remoteHost host name of the syncrepl remote server, default value is localhost
int	remotePort port number of the syncrepl provider server, default is 389
org.apache.directory.api.ldap.model.message.SearchScope	searchScope the search scope, default is sub tree level
int	searchSizeLimit the maximum number of search results to be fetched default value is 0 (i.e no limit)
int	searchTimeout the timeout value to be used while doing a search default value is 0 (i.e no limit)
boolean	strictCertVerification flag to indicate the use of strict certificate verification, default is true
Class<?>	trustManager the X509 certificate trust manager used, default value set to NoVerificationTrustManager
boolean	useTls flag to indicate the use of TLS, default is true

Element Detail

replUserDn

public abstract String replUserDn

replication user's Dn

replUserPassword

public abstract String replUserPassword

password for binding with replication user dn

baseDn

public abstract String baseDn

the base Dn whose content will be searched for replicating

replicaId

public abstract int replicaId

the replica's id

remoteHost

public abstract String remoteHost

host name of the syncrepl remote server, default value is localhost

Default:

"localhost"

remotePort

public abstract int remotePort

port number of the syncrepl provider server, default is 389

Default:

389

refreshNPersist

public abstract boolean refreshNPersist

flag to represent refresh and persist or refresh only mode, defaults to true

Default:

true

refreshInterval

public abstract long refreshInterval

time interval for successive sync requests, default is 60 seconds

Default:

60000L

filter

public abstract String filter

the ldap filter for fetching the entries, default value is (objectClass=*)

Default:

"(objectClass=*)"

attributes

public abstract String[] attributes

names of attributes to be replicated, default value is all user attributes

Default:

""

searchSizeLimit

public abstract int searchSizeLimit

the maximum number of search results to be fetched default value is 0 (i.e no limit)

Default:

0

searchTimeout

public abstract int searchTimeout

the timeout value to be used while doing a search default value is 0 (i.e no limit)

Default:

0

searchScope

public abstract org.apache.directory.api.ldap.model.message.SearchScope searchScope

the search scope, default is sub tree level

Default:

org.apache.directory.api.ldap.model.message.SearchScope.SUBTREE

aliasDerefMode

public abstract org.apache.directory.api.ldap.model.message.AliasDerefMode aliasDerefMode

alias dereferencing mode, default is set to 'never deref aliases'

Default:

org.apache.directory.api.ldap.model.message.AliasDerefMode.NEVER_DEREF_ALIASES

configEntryDn

public abstract String configEntryDn

The configuration entry DN

Default:

""

chaseReferrals

public abstract boolean chaseReferrals

flag to indicate whether to chase referrals or not, default is false hence passes ManageDsaITControl with syncsearch request

Default:

false

useTls

public abstract boolean useTls

flag to indicate the use of TLS, default is true

Default:

true

strictCertVerification

public abstract boolean strictCertVerification

flag to indicate the use of strict certificate verification, default is true

Default:

true

trustManager

public abstract Class<?> trustManager

the X509 certificate trust manager used, default value set to NoVerificationTrustManager

Default:

org.apache.directory.ldap.client.api.NoVerificationTrustManager.class