Package com.couchbase.lite

Class SessionAuthenticator

java.lang.Object

com.couchbase.lite.internal.BaseAuthenticator

com.couchbase.lite.SessionAuthenticator

All Implemented Interfaces:

Authenticator

public final class SessionAuthenticator
extends com.couchbase.lite.internal.BaseAuthenticator

SessionAuthenticator class is an authenticator that will authenticate by using the session ID of the session created by a Sync Gateway

Constructor Summary

Constructors

Constructor	Description
SessionAuthenticator(String sessionID)	Initializes with the Sync Gateway session ID and uses the default cookie name.
SessionAuthenticator(String sessionID, String cookieName)	Initializes with the session ID and the cookie name.

Method Summary

Modifier and Type	Method	Description
protected void	authenticate(Map<String,Object> options)
String	getCookieName()	Return session cookie name that the session ID value will be set to when communicating the Sync Gateway.
String	getSessionID()	Return session ID of the session created by a Sync Gateway.

Methods inherited from class java.lang.Object

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

Constructor Details

SessionAuthenticator

public SessionAuthenticator(@NonNull
 String sessionID)

Initializes with the Sync Gateway session ID and uses the default cookie name.

Parameters:

sessionID - Sync Gateway session ID

SessionAuthenticator

public SessionAuthenticator(@NonNull
 String sessionID,
 @Nullable
 String cookieName)

Initializes with the session ID and the cookie name. If the given cookieName is null, the default cookie name will be used.

Parameters:

sessionID - Sync Gateway session ID

cookieName - The cookie name

Method Details

getSessionID

@NonNull
public String getSessionID()

Return session ID of the session created by a Sync Gateway.

getCookieName

@NonNull
public String getCookieName()

Return session cookie name that the session ID value will be set to when communicating the Sync Gateway.

authenticate

protected void authenticate(@NonNull
 Map<String,Object> options)

Specified by:

authenticate in class com.couchbase.lite.internal.BaseAuthenticator