org.linphone.core

Interface AuthInfo

public interface AuthInfo

Object holding authentication information.

In most case, authentication information consists of a username and password.
If realm isn't set, it will be deduced automatically from the first
authentication challenge as for the hash algorithm. Sometimes, a userid is
required by the proxy and then domain can be useful to discriminate different
credentials. You can also use this object if you need to use a client
certificate.
Once created and filled, a AuthInfo must be added to the Core
in order to become known and used automatically when needed. Use Core.addAuthInfo(org.linphone.core.AuthInfo)
for that purpose.
The Core object can take the initiative to request authentication
information when needed to the application through the
authentication_requested() callback of it's LinphoneCoreCbs.
The application can respond to this information request later using Core.addAuthInfo(org.linphone.core.AuthInfo)
. This will unblock all pending authentication transactions and retry them with
authentication headers.

Method Summary

Modifier and Type	Method and Description
void	addAvailableAlgorithm(java.lang.String algorithm) Add an unique algorithm in the the available algorithms list : Algorithms that already exist will not be added.
void	clearAvailableAlgorithms() Remove all algorithms from the available algorithms list.
AuthInfo	clone() Instantiates a new auth info with values from source.
java.lang.String	getAlgorithm() Gets the algorithm.
java.lang.String[]	getAvailableAlgorithms() Gets all available algorithms.
java.lang.String	getDomain() Gets the domain.
java.lang.String	getHa1() Gets the ha1.
long	getNativePointer() Gets the native pointer used by this class to make native method calls.
java.lang.String	getPassword() Gets the password.
java.lang.String	getRealm() Gets the realm.
java.lang.String	getTlsCert() Gets the TLS certificate.
java.lang.String	getTlsCertPath() Gets the TLS certificate path.
java.lang.String	getTlsKey() Gets the TLS key.
java.lang.String	getTlsKeyPath() Gets the TLS key path.
java.lang.Object	getUserData() Gets the object stored in this object user's data
java.lang.String	getUserid() Gets the user id.
java.lang.String	getUsername() Gets the username.
boolean	isEqualButAlgorithms(AuthInfo authInfo2) Check if Authinfos are the same without taking account algorithms.
void	setAlgorithm(java.lang.String algorithm) Sets the algorithm to use.
void	setAvailableAlgorithms(java.lang.String[] algorithms) Sets the available algorithms list without testing unicity.
void	setDomain(java.lang.String domain) Sets the domain for which this authentication is valid.
void	setHa1(java.lang.String ha1) Sets the ha1.
void	setPassword(java.lang.String password) Sets the password.
void	setRealm(java.lang.String realm) Sets the realm.
void	setTlsCert(java.lang.String tlsCert) Sets the TLS certificate.
void	setTlsCertPath(java.lang.String tlsCertPath) Sets the TLS certificate path.
void	setTlsKey(java.lang.String tlsKey) Sets the TLS key.
void	setTlsKeyPath(java.lang.String tlsKeyPath) Sets the TLS key path.
void	setUserData(java.lang.Object data) Sets the object to store in this object user's data
void	setUserid(java.lang.String userId) Sets the user ID.
void	setUsername(java.lang.String username) Sets the username.
java.lang.String	toString()

Method Detail

getAlgorithm

@Nullable
java.lang.String getAlgorithm()

Gets the algorithm.

Returns:

The algorithm.

setAlgorithm

void setAlgorithm(@Nullable
                  java.lang.String algorithm)

Sets the algorithm to use.

Parameters:

algorithm - The algorithm.

getAvailableAlgorithms

@NonNull
java.lang.String[] getAvailableAlgorithms()

Gets all available algorithms.

Returns:

A list of available algorithms.

setAvailableAlgorithms

void setAvailableAlgorithms(@Nullable
                            java.lang.String[] algorithms)

Sets the available algorithms list without testing unicity.

Parameters:

algorithms - The available algorithms list.

getDomain

@Nullable
java.lang.String getDomain()

Gets the domain.

Returns:

The domain.

setDomain

void setDomain(@Nullable
               java.lang.String domain)

Sets the domain for which this authentication is valid.

Parameters:

domain - The domain. This should not be necessary because realm is
supposed to be unique and sufficient. However, many SIP servers don't set realm
correctly, then domain has to be used to distinguish between several SIP
account bearing the same username.

getHa1

@Nullable
java.lang.String getHa1()

Gets the ha1.

Returns:

The ha1.

setHa1

void setHa1(@Nullable
            java.lang.String ha1)

Sets the ha1.

Parameters:

ha1 - The ha1.

getPassword

@Nullable
java.lang.String getPassword()

Gets the password.

Returns:

The password.

setPassword

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

Sets the password.

Parameters:

password - The password.

getRealm

@Nullable
java.lang.String getRealm()

Gets the realm.

Returns:

The realm.

setRealm

void setRealm(@Nullable
              java.lang.String realm)

Sets the realm.

Parameters:

realm - The realm.

getTlsCert

@Nullable
java.lang.String getTlsCert()

Gets the TLS certificate.

Returns:

The TLS certificate.

setTlsCert

void setTlsCert(@Nullable
                java.lang.String tlsCert)

Sets the TLS certificate.

Parameters:

tlsCert - The TLS certificate.

getTlsCertPath

@Nullable
java.lang.String getTlsCertPath()

Gets the TLS certificate path.

Returns:

The TLS certificate path.

setTlsCertPath

void setTlsCertPath(@Nullable
                    java.lang.String tlsCertPath)

Sets the TLS certificate path.

Parameters:

tlsCertPath - The TLS certificate path.

getTlsKey

@Nullable
java.lang.String getTlsKey()

Gets the TLS key.

Returns:

The TLS key.

setTlsKey

void setTlsKey(@Nullable
               java.lang.String tlsKey)

Sets the TLS key.

Parameters:

tlsKey - The TLS key.

getTlsKeyPath

@Nullable
java.lang.String getTlsKeyPath()

Gets the TLS key path.

Returns:

The TLS key path.

setTlsKeyPath

void setTlsKeyPath(@Nullable
                   java.lang.String tlsKeyPath)

Sets the TLS key path.

Parameters:

tlsKeyPath - The TLS key path.

getUserid

@Nullable
java.lang.String getUserid()

Gets the user id.

Returns:

The user id.

setUserid

void setUserid(@Nullable
               java.lang.String userId)

Sets the user ID.

Parameters:

userId - The userid.

getUsername

@Nullable
java.lang.String getUsername()

Gets the username.

Returns:

The username.

setUsername

void setUsername(@Nullable
                 java.lang.String username)

Sets the username.

Parameters:

username - The username.

addAvailableAlgorithm

void addAvailableAlgorithm(@Nullable
                           java.lang.String algorithm)

Add an unique algorithm in the the available algorithms list : Algorithms that
already exist will not be added.

Parameters:

algorithm - The algorithm to add.

clearAvailableAlgorithms

void clearAvailableAlgorithms()

Remove all algorithms from the available algorithms list.

clone

@NonNull
AuthInfo clone()

Instantiates a new auth info with values from source.

Returns:

The newly created AuthInfo object.

isEqualButAlgorithms

boolean isEqualButAlgorithms(@Nullable
                             AuthInfo authInfo2)

Check if Authinfos are the same without taking account algorithms.

Parameters:

authInfo2 - The second AuthInfo object.

Returns:

true if all fields (Username, UserId, Realm, Domain) are the same.

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