com.couchbase.lite.auth

Interface LoginAuthorizer

All Superinterfaces:

Authenticator, Authorizer

All Known Subinterfaces:

SessionCookieAuthorizer

All Known Implementing Classes:

FacebookAuthorizer, OpenIDConnectAuthorizer, PersonaAuthorizer, TokenAuthenticator

public interface LoginAuthorizer
extends Authorizer

Created by hideki on 6/14/16.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LoginAuthorizer.ContinuationBlock

Method Summary

Modifier and Type	Method and Description
boolean	implementedLoginResponse()
java.util.List<java.lang.Object>	loginRequest() Returns the HTTP method, URL, and body of the login request to send, or nil for no login.
void	loginResponse(java.lang.Object jsonResponse, Headers headers, java.lang.Throwable error, LoginAuthorizer.ContinuationBlock block) The replicator calls this method with the response to the login request.

Methods inherited from interface com.couchbase.lite.auth.Authorizer

getLocalUUID, getRemoteURL, getUsername, removeStoredCredentials, setLocalUUID, setRemoteURL

Method Detail

loginRequest

java.util.List<java.lang.Object> loginRequest()

Returns the HTTP method, URL, and body of the login request to send, or nil for no login.

Returns:

An array of the form @[method, path, body]. The path may be absolute, or relative to the authorizer's remote URL. Return nil to skip the login.

loginResponse

void loginResponse(java.lang.Object jsonResponse,
                   Headers headers,
                   java.lang.Throwable error,
                   LoginAuthorizer.ContinuationBlock block)

The replicator calls this method with the response to the login request. It then waits for the authorizer to call the continuation callback, before proceeding.

Parameters:

jsonResponse - The parsed JSON body of the response.

headers - The HTTP response headers.

error - The error, if the request failed.

block - The authorizer must call this block at some future time. If the `loginAgain` parameter is YES, the login will be repeated, with another call to -loginRequestForSite:. If the NSError* parameter is non-nil, replication stops.

implementedLoginResponse

boolean implementedLoginResponse()