org.linphone.core

Interface LinphoneAuthInfo

public interface LinphoneAuthInfo

Object holding authentication information. In most case, authentication information consists of a username and password. Sometimes, a userid is required by proxy, and realm can be useful to discriminate different SIP domains.
This object is instantiated using either LinphoneCoreFactory.createAuthInfo(String, String, String, String) or LinphoneCoreFactory.createAuthInfo(String, String, String, String, String, String).
Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in order to become known and used automatically when needed. Use LinphoneCore.addAuthInfo(LinphoneAuthInfo) for that purpose.
The LinphoneCore object can take the initiative to request authentication information when needed to the application through the LinphoneCoreListener.authInfoRequested(LinphoneCore, String, String, String) listener.
The application can respond to this information request later using LinphoneCore.addAuthInfo(LinphoneAuthInfo). This will unblock all pending authentication transactions and retry them with authentication headers.

Method Summary

Methods

Modifier and Type	Method and Description
LinphoneAuthInfo	clone() Clones a current auth info
String	getDomain() Gets the domain
String	getHa1() get ha1
String	getPassword() get password
String	getRealm() get realm
String	getTlsCertificate() Gets the TLS certificate
String	getTlsCertificatePath() Gets the path to the TLS certificate file
String	getTlsKey() Gets the TLS key file
String	getTlsKeyPath() Gets the path to the TLS key file
String	getUserId() get auth userid has used in authentication header.
String	getUsername() get user name
void	setDomain(String domain) Sets the domain
void	setHa1(String ha1) set ha1
void	setPassword(String password) sets password
void	setRealm(String realm) set realm
void	setTlsCertificate(String cert) Sets the TLS certificate
void	setTlsCertificatePath(String path) Sets the TLS certificate file path
void	setTlsKey(String key) Sets the TLS key
void	setTlsKeyPath(String path) Sets the TLS key file path
void	setUserId(String userid) set auth userid has used in authentication header.
void	setUsername(String username) Sets the username.

Method Detail

getUsername

String getUsername()

get user name

Returns:

username

setUsername

void setUsername(String username)

Sets the username.

Parameters:

username -

getPassword

String getPassword()

get password

Returns:

password

setPassword

void setPassword(String password)

sets password

Parameters:

password -

getRealm

String getRealm()

get realm

Returns:

setRealm

void setRealm(String realm)

set realm

Parameters:

realm -

getUserId

String getUserId()

get auth userid has used in authentication header. If null, username is taken for authentication

Returns:

auth userid

setUserId

void setUserId(String userid)

set auth userid has used in authentication header. If null, username is taken for authentication

getHa1

String getHa1()

get ha1

Returns:

ha1

setHa1

void setHa1(String ha1)

set ha1

setDomain

void setDomain(String domain)

Sets the domain

Parameters:

domain -

getDomain

String getDomain()

Gets the domain

Returns:

the domain

clone

LinphoneAuthInfo clone()

Clones a current auth info

Returns:

the clone auth info

getTlsCertificate

String getTlsCertificate()

Gets the TLS certificate

Returns:

the TLS certificate

getTlsKey

String getTlsKey()

Gets the TLS key file

Returns:

the TLS key

getTlsCertificatePath

String getTlsCertificatePath()

Gets the path to the TLS certificate file

Returns:

the path to the TLS certificate

getTlsKeyPath

String getTlsKeyPath()

Gets the path to the TLS key file

Returns:

the path to the TLS key

setTlsCertificate

void setTlsCertificate(String cert)

Sets the TLS certificate

Parameters:

cert - the certificate

setTlsKey

void setTlsKey(String key)

Sets the TLS key

Parameters:

key - the key

setTlsCertificatePath

void setTlsCertificatePath(String path)

Sets the TLS certificate file path

Parameters:

path - the path of the certificate

setTlsKeyPath

void setTlsKeyPath(String path)

Sets the TLS key file path

Parameters:

path - the path of the key