com.couchbase.lite

Class SessionAuthenticator

java.lang.Object

com.couchbase.lite.Authenticator

com.couchbase.lite.SessionAuthenticator

public final class SessionAuthenticator
extends Authenticator

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 and 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 and Description
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

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

Constructor Detail

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 Detail

getSessionID

@NonNull
public String getSessionID()

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

getCookieName

public String getCookieName()

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