com.couchbase.lite

Class BasicAuthenticator

java.lang.Object

com.couchbase.lite.Authenticator

com.couchbase.lite.BasicAuthenticator

public final class BasicAuthenticator
extends Authenticator

The BasicAuthenticator class is an authenticator that will authenticate using HTTP Basic auth with the given username and password. This should only be used over an SSL/TLS connection, as otherwise it's very easy for anyone sniffing network traffic to read the password.

Constructor Summary

Constructors

Constructor and Description
BasicAuthenticator(String username, char[] password) Create a Basic Authenticator.
BasicAuthenticator(String username, String password) Deprecated. Use BasicAuthenticator(String, char[])

Method Summary

Modifier and Type	Method and Description
String	getPassword() Deprecated. Use getPasswordChars(char[])
char[]	getPasswordChars() Get the password.
String	getUsername()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicAuthenticator

@Deprecated
public BasicAuthenticator(@NonNull
                                      String username,
                                      @NonNull
                                      String password)

Deprecated. Use BasicAuthenticator(String, char[])

Parameters:

username -

password -

BasicAuthenticator

public BasicAuthenticator(@NonNull
                          String username,
                          @NonNull
                          char[] password)

Create a Basic Authenticator. The new instance contains a copy of the password char[] parameter: the owner of the original retains the responsiblity for zeroing it before releasing it.

Method Detail

getUsername

@NonNull
public String getUsername()

getPassword

@Deprecated
 @NonNull
public String getPassword()

Deprecated. Use getPasswordChars(char[])

getPasswordChars

@NonNull
public char[] getPasswordChars()

Get the password. The returned char[] is a copy: the owner is responsible for zeroing it before releasing it.

Returns:

the password, as a char[].