net.java.sip.communicator.service.ldap
Interface LdapDirectorySettings

All Superinterfaces:

Cloneable, LdapConstants

All Known Implementing Classes:

LdapDirectorySettingsImpl

public interface LdapDirectorySettings
extends LdapConstants, Cloneable

A wrapper around the settings needed to create an LdapDirectory This object is mandatory to create an LdapServer. It's also the retrieved object when calling getSettings() from LdapServer. It also be used to retrieve, remove or store settings in the persistent configuration.

Author:

Sebastien Mazy

Nested Class Summary

Nested classes/interfaces inherited from interface net.java.sip.communicator.service.ldap.LdapConstants

LdapConstants.Auth, LdapConstants.Encryption, LdapConstants.Scope

Field Summary

Fields inherited from interface net.java.sip.communicator.service.ldap.LdapConstants

LDAP_CONNECT_TIMEOUT, LDAP_READ_TIMEOUT

Method Summary

LdapDirectorySettings	clone() Clone this object.
boolean	equals(LdapDirectorySettings other) Checks if both LdapDirectorySettings instance have the same content
LdapConstants.Auth	getAuth() simple getter for auth
String	getBaseDN() simple getter for baseDN
String	getBindDN() simple getter for bindDN
LdapConstants.Encryption	getEncryption() simple getter for encryption
String	getGlobalPhonePrefix() Returns the global prefix to be used when calling phones from this ldap source.
List<String>	getHomePhoneSearchFields() Returns home phone fields that we will lookup.
String	getHostname() simple getter for hostname
List<String>	getMailSearchFields() Returns mail fields that we will lookup.
String	getMailSuffix() Returns mail suffix.
List<String>	getMobilePhoneSearchFields() Returns mobile phone fields that we will lookup.
String	getName() simple getter for name
String	getPassword() simple getter for password
int	getPort() simple getter for port
LdapConstants.Scope	getScope() Returns the search scope: one level under the base distinguished name or all the subtree.
List<String>	getWorkPhoneSearchFields() Returns work phone fields that we will lookup.
int	hashCode() Returns the hash code for this instance.
boolean	isEnabled() simple getter for enabled
void	persistentLoad(String name) Loads the settings with the given name from the config files into the LdapDirectorySetting.
void	persistentRemove() Removes settings with this name from the config files
void	persistentSave() Saves these settings through the configuration service
void	setAuth(LdapConstants.Auth auth) simple setter for auth
void	setBaseDN(String baseDN) simple setter for baseDN
void	setBindDN(String bindDN) simple setter for bindDN
void	setEnabled(boolean enabled) simple setter for enabled
void	setEncryption(LdapConstants.Encryption encryption) simple setter for encryption
void	setGlobalPhonePrefix(String prefix) Sets the global prefix to be used when calling phones from this ldap source.
void	setHomePhoneSearchFields(List<String> list) Set home phone fields that we will lookup.
void	setHostname(String hostname) simple setter for hostname
void	setMailSearchFields(List<String> list) Set mail fields that we will lookup.
void	setMailSuffix(String suffix) Set mail suffix.
void	setMobilePhoneSearchFields(List<String> list) Set mobile phone fields that we will lookup.
void	setName(String name) simple setter for name
void	setPassword(String password) simple setter for password
void	setPort(int port) simple setter for port
void	setScope(LdapConstants.Scope scope) Sets the search scope: one level under the base distinguished name or all the subtree.
void	setWorkPhoneSearchFields(List<String> list) Set work phone fields that we will lookup.

Method Detail

getName

String getName()

simple getter for name

Returns:

the name property

setName

void setName(String name)

simple setter for name

Parameters:

name - the name property

isEnabled

boolean isEnabled()

simple getter for enabled

Returns:

whether the server is marked as enabled

setEnabled

void setEnabled(boolean enabled)

simple setter for enabled

Parameters:

enabled - whether the server is marked as enabled

getHostname

String getHostname()

simple getter for hostname

Returns:

the hostname property

setHostname

void setHostname(String hostname)

simple setter for hostname

Parameters:

hostname - the hostname property

getEncryption

LdapConstants.Encryption getEncryption()

simple getter for encryption

Returns:

the encryption property

See Also:

LdapConstants.Encryption

setEncryption

void setEncryption(LdapConstants.Encryption encryption)

simple setter for encryption

Parameters:

encryption - the encryption property

See Also:

LdapConstants.Encryption

getPort

int getPort()

simple getter for port

Returns:

the port property

setPort

void setPort(int port)

simple setter for port

Parameters:

port - the port property

getAuth

LdapConstants.Auth getAuth()

simple getter for auth

Returns:

the auth property

See Also:

LdapConstants.Auth

setAuth

void setAuth(LdapConstants.Auth auth)

simple setter for auth

Parameters:

auth - the auth property

See Also:

LdapConstants.Auth

getBindDN

String getBindDN()

simple getter for bindDN

Returns:

the bindDN property

setBindDN

void setBindDN(String bindDN)

simple setter for bindDN

Parameters:

bindDN - the bindDN property

getPassword

String getPassword()

simple getter for password

Returns:

the password property

setPassword

void setPassword(String password)

simple setter for password

Parameters:

password - the password property

getBaseDN

String getBaseDN()

simple getter for baseDN

Returns:

the baseDN property

setBaseDN

void setBaseDN(String baseDN)

simple setter for baseDN

Parameters:

baseDN - the baseDN property

getScope

LdapConstants.Scope getScope()

Returns the search scope: one level under the base distinguished name or all the subtree.

Returns:

the search scope

See Also:

LdapConstants.Scope

setScope

void setScope(LdapConstants.Scope scope)

Sets the search scope: one level under the base distinguished name or all the subtree.

Parameters:

scope - the new search scope

See Also:

LdapConstants.Scope

getMailSearchFields

List<String> getMailSearchFields()

Returns mail fields that we will lookup.

Returns:

mail fields that we will lookup

setMailSearchFields

void setMailSearchFields(List<String> list)

Set mail fields that we will lookup.

Parameters:

list - of mail fields that we will lookup

getMailSuffix

String getMailSuffix()

Returns mail suffix.

Returns:

mail suffix

setMailSuffix

void setMailSuffix(String suffix)

Set mail suffix.

Parameters:

suffix - mail suffix

getWorkPhoneSearchFields

List<String> getWorkPhoneSearchFields()

Returns work phone fields that we will lookup.

Returns:

work phone fields that we will lookup

setWorkPhoneSearchFields

void setWorkPhoneSearchFields(List<String> list)

Set work phone fields that we will lookup.

Parameters:

list - of work phone fields that we will lookup

getMobilePhoneSearchFields

List<String> getMobilePhoneSearchFields()

Returns mobile phone fields that we will lookup.

Returns:

mobile phone fields that we will lookup

setMobilePhoneSearchFields

void setMobilePhoneSearchFields(List<String> list)

Set mobile phone fields that we will lookup.

Parameters:

list - of mobile phone fields that we will lookup

getHomePhoneSearchFields

List<String> getHomePhoneSearchFields()

Returns home phone fields that we will lookup.

Returns:

home phone fields that we will lookup

setHomePhoneSearchFields

void setHomePhoneSearchFields(List<String> list)

Set home phone fields that we will lookup.

Parameters:

list - of home phone fields that we will lookup

getGlobalPhonePrefix

String getGlobalPhonePrefix()

Returns the global prefix to be used when calling phones from this ldap source.

Returns:

the global prefix to be used when calling phones from this ldap source

setGlobalPhonePrefix

void setGlobalPhonePrefix(String prefix)

Sets the global prefix to be used when calling phones from this ldap source.

Parameters:

prefix - the global prefix to be used when calling phones from this ldap source

persistentSave

void persistentSave()

Saves these settings through the configuration service

See Also:

persistentSave()

persistentLoad

void persistentLoad(String name)

Loads the settings with the given name from the config files into the LdapDirectorySetting.

Parameters:

name - name of the settings

See Also:

persistentLoad(java.lang.String)

persistentRemove

void persistentRemove()

Removes settings with this name from the config files

equals

boolean equals(LdapDirectorySettings other)

Checks if both LdapDirectorySettings instance have the same content

Parameters:

other - object to compare

Returns:

whether both LdapDirectorySettings instance have the same content

See Also:

Object.equals(java.lang.Object)

hashCode

int hashCode()

Returns the hash code for this instance. It has to be consistent with equals.

Overrides:

hashCode in class Object

Returns:

the hash code dor this instance

See Also:

Object.hashCode()

clone

LdapDirectorySettings clone()

Clone this object.

Returns:

clone of this object