Class 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 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

        @Nullable
        public String getCookieName()
        Return session cookie name that the session ID value will be set to when communicating the Sync Gateway.