Package org.linphone.core

Interface LdapParams

public interface LdapParams

Object that is used to set the different parameters of a Ldap.

Method Summary

Modifier and Type	Method	Description
int	check()	Check parameters and return what are wrong.
LdapParams	clone()	Instantiate a new LdapParams with values from source.
LdapAuthMethod	getAuthMethod()	Get the authentification method.
java.lang.String	getBaseObject()	Get the BaseObject.
java.lang.String	getBindDn()	Get the Bind DN to use for bindings.
java.lang.String	getCustomValue(java.lang.String key)	Get the value from field.
LdapDebugLevel	getDebugLevel()	Return the debug verbosity level.
int	getDelay()	Get the delay between each search in milliseconds.
boolean	getEnabled()	Return if the configuration is enabled.
java.lang.String	getFilter()	Get the search is based on this filter to search contacts.
int	getMaxResults()	Get the max results when requesting searches.
int	getMinChars()	Get the minimum characters needed for doing a search on LDAP servers.
java.lang.String	getNameAttribute()	Get the attributes to build Name Friend, separated by a comma and the first is the highest priority.
long	getNativePointer()	Gets the native pointer used by this class to make native method calls.
java.lang.String	getPassword()	Get the password to pass to server when binding.
java.lang.String	getServer()	Get the LDAP Server.
LdapCertVerificationMode	getServerCertificatesVerificationMode()	Return whether the tls server certificate must be verified when connecting to a LDAP server.
java.lang.String	getSipAttribute()	Get the attributes to build the SIP username in address of Friend.
java.lang.String	getSipDomain()	Get the domain to the sip address(sip:username).
int	getTimeout()	Get the timeout in seconds.
java.lang.Object	getUserData()	Gets the object stored in this object user's data
boolean	isSalEnabled()	Return if the dns resolution is done by Linphone using Sal.
boolean	isTlsEnabled()	Return if transactions are encrypted by LDAP over TLS(StartTLS).
void	setAuthMethod(LdapAuthMethod authMethod)	Authentification method.
void	setBaseObject(java.lang.String baseObject)	BaseObject is a specification for LDAP Search Scopes that specifies that the Search Request should only be performed against the entry specified as the search base DN.
void	setBindDn(java.lang.String bindDn)	Bind DN to use for bindings.
void	setCustomValue(java.lang.String key, java.lang.String value)	Set custom field.
void	setDebugLevel(LdapDebugLevel level)	The debug verbosity level from internal LDAP API.
void	setDelay(int delay)	Delay between each search in milliseconds Default value : 500.
void	setEnabled(boolean enable)	If this config is enabled.
void	setFilter(java.lang.String filter)	The search is based on this filter to search contacts.
void	setMaxResults(int maxResults)	The max results when requesting searches.
void	setMinChars(int minChars)	The minimum characters needed for doing a search on LDAP servers.
void	setNameAttribute(java.lang.String nameAttribute)	Check these attributes to build Name Friend, separated by a comma and the first is the highest priority.
void	setPassword(java.lang.String password)	The password to pass to server when binding.
void	setSalEnabled(boolean enable)	The dns resolution is done by Linphone using Sal.
void	setServer(java.lang.String server)	LDAP Server.
void	setServerCertificatesVerificationMode(LdapCertVerificationMode verifyServerCertificates)	Specify whether the tls server certificate must be verified when connecting to a LDAP server.
void	setSipAttribute(java.lang.String sipAttribute)	Check these attributes to build the SIP username in address of Friend.
void	setSipDomain(java.lang.String sipDomain)	Add the domain to the sip address(sip:username).
void	setTimeout(int timeout)	Timeout in seconds Default value : 5.
void	setTlsEnabled(boolean enable)	Encrypt transactions by LDAP over TLS(StartTLS).
void	setUserData(java.lang.Object data)	Sets the object to store in this object user's data
java.lang.String	toString()

Method Detail

getAuthMethod

LdapAuthMethod getAuthMethod()

Get the authentification method.

Check LdapAuthMethod for authentification values.

Returns:

The LdapAuthMethod.

setAuthMethod

void setAuthMethod(LdapAuthMethod authMethod)

Authentification method.

Check LdapAuthMethod for authentification values. Default value :
LinphoneLdapAuthMethodSimple

Parameters:

authMethod - The LdapAuthMethod.

getBaseObject

@NonNull
java.lang.String getBaseObject()

Get the BaseObject.

It is a specification for LDAP Search Scopes that specifies that the Search
Request should only be performed against the entry specified as the search base
DN. No entries above it will be considered. This field is required.

Returns:

The specification.

setBaseObject

void setBaseObject(@NonNull
                   java.lang.String baseObject)

BaseObject is a specification for LDAP Search Scopes that specifies that the
Search Request should only be performed against the entry specified as the
search base DN.

No entries above it will be considered. This field is required. Default value :
"dc=example,dc=com"

Parameters:

baseObject - The specification.

getBindDn

@Nullable
java.lang.String getBindDn()

Get the Bind DN to use for bindings.

The bindDN DN is the credential that is used to authenticate against an LDAP.
If empty, the connection will be Anonymous. eg:
cn=ausername,ou=people,dc=bc,dc=com

Returns:

The Bind DN to use for bindings.

setBindDn

void setBindDn(@Nullable
               java.lang.String bindDn)

Bind DN to use for bindings.

The bindDN DN is the credential that is used to authenticate against an LDAP.
If empty, the connection will be Anonymous. eg:
cn=ausername,ou=people,dc=bc,dc=com Default value : "".

Parameters:

bindDn - The Bind DN to use for bindings.

getDebugLevel

LdapDebugLevel getDebugLevel()

Return the debug verbosity level.

Returns:

The LdapDebugLevel debug level.

setDebugLevel

void setDebugLevel(LdapDebugLevel level)

The debug verbosity level from internal LDAP API.

Values are LdapDebugLevel Default value: LinphoneLdapDebugLevelOff

Parameters:

level - The LdapDebugLevel debug level.

getDelay

int getDelay()

Get the delay between each search in milliseconds.

Returns:

The delay in milliseconds.

setDelay

void setDelay(int delay)

Delay between each search in milliseconds Default value : 500.

Parameters:

delay - The timeout in milliseconds.

getEnabled

boolean getEnabled()

Return if the configuration is enabled.

Returns:

Enable or not the LDAP configuration.

setEnabled

void setEnabled(boolean enable)

If this config is enabled.

Default value : false.

Parameters:

enable - Enable or not the LDAP configuration.

getFilter

@Nullable
java.lang.String getFilter()

Get the search is based on this filter to search contacts.

Returns:

The filter to use.

setFilter

void setFilter(@Nullable
               java.lang.String filter)

The search is based on this filter to search contacts.

Default value : "(sn=*%s*)".

Parameters:

filter - The filter to use.

getMaxResults

int getMaxResults()

Get the max results when requesting searches.

Returns:

The max results when requesting searches.

setMaxResults

void setMaxResults(int maxResults)

The max results when requesting searches.

Default value : 5. This value fit for standard cases where only first results
are needed. Also, it avoids latency on each searchs.

Parameters:

maxResults - The max results when requesting searches.

getMinChars

int getMinChars()

Get the minimum characters needed for doing a search on LDAP servers.

Returns:

The minimum characters needed by a search.

setMinChars

void setMinChars(int minChars)

The minimum characters needed for doing a search on LDAP servers.

Default value : 0.

Parameters:

minChars - The minimum characters needed by a search.

getNameAttribute

@Nullable
java.lang.String getNameAttribute()

Get the attributes to build Name Friend, separated by a comma and the first is
the highest priority.

Returns:

The comma separated attributes for the search.

setNameAttribute

void setNameAttribute(@Nullable
                      java.lang.String nameAttribute)

Check these attributes to build Name Friend, separated by a comma and the first
is the highest priority.

Default value : "sn".

Parameters:

nameAttribute - The comma separated attributes for the search.

getPassword

@Nullable
java.lang.String getPassword()

Get the password to pass to server when binding.

Returns:

The password to pass to server when binding.

setPassword

void setPassword(@Nullable
                 java.lang.String password)

The password to pass to server when binding.

Default value : "".

Parameters:

password - The password to pass to server when binding.

isSalEnabled

boolean isSalEnabled()

Return if the dns resolution is done by Linphone using Sal.

It will pass an IP to LDAP. By doing that, the TLS negociation could not check
the hostname. You may deactivate the verifications if wanted to force the
connection.

Returns:

Enable or not the use of sal.

setSalEnabled

void setSalEnabled(boolean enable)

The dns resolution is done by Linphone using Sal.

It will pass an IP to LDAP. By doing that, the TLS negociation could not check
the hostname. You may deactivate the verifications if wanted to force the
connection. Default value : false.

Parameters:

enable - Enable or not the use of sal.

getServer

@NonNull
java.lang.String getServer()

Get the LDAP Server.

Returns:

LDAP Server address.

setServer

void setServer(@NonNull
               java.lang.String server)

LDAP Server.

eg: ldap:/// for a localhost server or ldap://ldap.example.org/ Default value:
"ldap:///". This field is required.
You must use 'ldap' scheme. 'ldaps' for LDAP over SSL is non-standardized and
deprecated.

Parameters:

server - LDAP Server address.

getServerCertificatesVerificationMode

LdapCertVerificationMode getServerCertificatesVerificationMode()

Return whether the tls server certificate must be verified when connecting to a
LDAP server.

Returns:

The TLS verification mode from LdapCertVerificationMode

setServerCertificatesVerificationMode

void setServerCertificatesVerificationMode(LdapCertVerificationMode verifyServerCertificates)

Specify whether the tls server certificate must be verified when connecting to
a LDAP server.

Values are LdapCertVerificationMode Default value :
LinphoneLdapCertVerificationDefault (auto)

Parameters:

verifyServerCertificates - The TLS verification mode from LdapCertVerificationMode

getSipAttribute

@Nullable
java.lang.String getSipAttribute()

Get the attributes to build the SIP username in address of Friend.

Attributes are separated by a comma.

Returns:

The comma separated attributes for building Friend.

setSipAttribute

void setSipAttribute(@Nullable
                     java.lang.String sipAttribute)

Check these attributes to build the SIP username in address of Friend.

Attributes are separated by a comma. Default value :
"mobile,telephoneNumber,homePhone,sn".

Parameters:

sipAttribute - The comma separated attributes for building Friend.

getSipDomain

@Nullable
java.lang.String getSipDomain()

Get the domain to the sip address(sip:username).

Returns:

The SIP domain for the friend.

setSipDomain

void setSipDomain(@Nullable
                  java.lang.String sipDomain)

Add the domain to the sip address(sip:username).

By default or if it is empty, the domain will be specify while searching on the
current proxy account. Default value : "".

Parameters:

sipDomain - The SIP domain for the friend.

getTimeout

int getTimeout()

Get the timeout in seconds.

Returns:

The timeout in seconds.

setTimeout

void setTimeout(int timeout)

Timeout in seconds Default value : 5.

Parameters:

timeout - The timeout in seconds.

isTlsEnabled

boolean isTlsEnabled()

Return if transactions are encrypted by LDAP over TLS(StartTLS).

You must use \'ldap\' scheme. \'ldaps\' for LDAP over SSL is non-standardized
and deprecated. StartTLS in an extension to the LDAP protocol which uses the
TLS protocol to encrypt communication. It works by establishing a normal - i.e.
unsecured - connection with the LDAP server before a handshake negotiation
between the server and the web services is carried out. Here, the server sends
its certificate to prove its identity before the secure connection is
established.

Returns:

Enable or not the use of TLS.

setTlsEnabled

void setTlsEnabled(boolean enable)

Encrypt transactions by LDAP over TLS(StartTLS).

You must use 'ldap' scheme. 'ldaps' for LDAP over SSL is non-standardized and
deprecated. StartTLS in an extension to the LDAP protocol which uses the TLS
protocol to encrypt communication. It works by establishing a normal - i.e.
unsecured - connection with the LDAP server before a handshake negotiation
between the server and the web services is carried out. Here, the server sends
its certificate to prove its identity before the secure connection is
established. Default value : true.

Parameters:

enable - Enable or not the use of TLS.

check

int check()

Check parameters and return what are wrong.

Returns:

The LdapCheck values. LinphoneLdapCheckOk if everything is ok.

clone

@NonNull
LdapParams clone()

Instantiate a new LdapParams with values from source.

Returns:

The newly created LdapParams object.

getCustomValue

@Nullable
java.lang.String getCustomValue(@NonNull
                                java.lang.String key)

Get the value from field.

Parameters:

key - The key string.

Returns:

The Value associated to the key.

setCustomValue

void setCustomValue(@NonNull
                    java.lang.String key,
                    @Nullable
                    java.lang.String value)

Set custom field.

Parameters:

key - The key string.

value - The value string.

setUserData

void setUserData(java.lang.Object data)

Sets the object to store in this object user's data

Parameters:

data - the object to store

getUserData

java.lang.Object getUserData()

Gets the object stored in this object user's data

Returns:

the object store if any, null otherwise

getNativePointer

long getNativePointer()

Gets the native pointer used by this class to make native method calls.

Returns:

the nativer pointer, as long

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object