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
ConstructorsConstructorDescriptionSessionAuthenticator
(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 TypeMethodDescriptionprotected void
authenticate
(Map<String, Object> options) Return session cookie name that the session ID value will be set to when communicating the Sync Gateway.Return session ID of the session created by a Sync Gateway.
-
Constructor Details
-
SessionAuthenticator
Initializes with the Sync Gateway session ID and uses the default cookie name.- Parameters:
sessionID
- Sync Gateway session ID
-
SessionAuthenticator
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 IDcookieName
- The cookie name
-
-
Method Details
-
getSessionID
Return session ID of the session created by a Sync Gateway. -
getCookieName
Return session cookie name that the session ID value will be set to when communicating the Sync Gateway. -
authenticate
- Specified by:
authenticate
in classcom.couchbase.lite.internal.BaseAuthenticator
-