com.couchbase.lite.auth

Class TokenAuthenticator

java.lang.Object

com.couchbase.lite.auth.BaseAuthorizer

com.couchbase.lite.auth.TokenAuthenticator

All Implemented Interfaces:

Authenticator, Authorizer, LoginAuthorizer, SessionCookieAuthorizer

public class TokenAuthenticator
extends BaseAuthorizer
implements SessionCookieAuthorizer

Authenticator impl that knows how to do token based auth

Nested Class Summary

Nested classes/interfaces inherited from interface com.couchbase.lite.auth.LoginAuthorizer

LoginAuthorizer.ContinuationBlock

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
TokenAuthenticator(java.lang.String loginPath, java.util.Map<java.lang.String,java.lang.String> params)

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 class com.couchbase.lite.auth.BaseAuthorizer

getLocalUUID, getRemoteURL, getUsername, removeStoredCredentials, setLocalUUID, setRemoteURL

Methods inherited from class java.lang.Object

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

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

getLocalUUID, getRemoteURL, getUsername, removeStoredCredentials, setLocalUUID, setRemoteURL

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

TokenAuthenticator

public TokenAuthenticator(java.lang.String loginPath,
                          java.util.Map<java.lang.String,java.lang.String> params)

Method Detail

loginRequest

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

Description copied from interface: LoginAuthorizer

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

Specified by:

loginRequest in interface LoginAuthorizer

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

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

Description copied from interface: LoginAuthorizer

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.

Specified by:

loginResponse in interface LoginAuthorizer

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

public boolean implementedLoginResponse()

Specified by:

implementedLoginResponse in interface LoginAuthorizer