com.couchbase.lite.auth

Class OpenIDConnectAuthorizer

java.lang.Object

com.couchbase.lite.auth.BaseAuthorizer

com.couchbase.lite.auth.OpenIDConnectAuthorizer

All Implemented Interfaces:

Authenticator, Authorizer, CustomHeadersAuthorizer, LoginAuthorizer, SessionCookieAuthorizer

public class OpenIDConnectAuthorizer
extends BaseAuthorizer
implements CustomHeadersAuthorizer, SessionCookieAuthorizer

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
protected java.net.URL	authURL
protected boolean	haveSessionCookie
protected java.lang.String	IDToken
protected OIDCLoginCallback	loginCallback
protected java.lang.String	refreshToken
protected TokenStore	tokenStore

Constructor Summary

Constructors

Constructor and Description
OpenIDConnectAuthorizer(OIDCLoginCallback callback, TokenStore tokenStore)

Method Summary

Modifier and Type	Method and Description
boolean	authorizeURLRequest(Request.Builder builder) May add a header to the request (usually "Authorization:") to convey the authorization token.
static boolean	forgetIDTokensForServer(java.net.URL serverURL, TokenStore tokenStore)
java.lang.String	getIDToken()
java.lang.String	getRefreshToken()
TokenStore	getTokenStore()
java.lang.String	getUsername()
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.
boolean	removeStoredCredentials()
void	setIDToken(java.lang.String IDToken)
void	setRefreshToken(java.lang.String refreshToken)
void	setTokenStore(TokenStore tokenStore)
void	setUsername(java.lang.String username)
java.lang.String	toString()

Methods inherited from class com.couchbase.lite.auth.BaseAuthorizer

getLocalUUID, getRemoteURL, setLocalUUID, setRemoteURL

Methods inherited from class java.lang.Object

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

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

getLocalUUID, getRemoteURL, setLocalUUID, setRemoteURL

Field Detail

loginCallback

protected OIDCLoginCallback loginCallback

tokenStore

protected TokenStore tokenStore

authURL

protected java.net.URL authURL

IDToken

protected java.lang.String IDToken

refreshToken

protected java.lang.String refreshToken

haveSessionCookie

protected boolean haveSessionCookie

Constructor Detail

OpenIDConnectAuthorizer

public OpenIDConnectAuthorizer(OIDCLoginCallback callback,
                               TokenStore tokenStore)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

authorizeURLRequest

public boolean authorizeURLRequest(Request.Builder builder)

Description copied from interface: CustomHeadersAuthorizer

May add a header to the request (usually "Authorization:") to convey the authorization token.

Specified by:

authorizeURLRequest in interface CustomHeadersAuthorizer

Parameters:

builder - The URL request to authenticate.

Returns:

true if it added authorization.

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

removeStoredCredentials

public boolean removeStoredCredentials()

Specified by:

removeStoredCredentials in interface Authorizer

Overrides:

removeStoredCredentials in class BaseAuthorizer

getUsername

public java.lang.String getUsername()

Specified by:

getUsername in interface Authorizer

Overrides:

getUsername in class BaseAuthorizer

getTokenStore

public TokenStore getTokenStore()

setTokenStore

public void setTokenStore(TokenStore tokenStore)

setUsername

public void setUsername(java.lang.String username)

getIDToken

public java.lang.String getIDToken()

setIDToken

public void setIDToken(java.lang.String IDToken)

getRefreshToken

public java.lang.String getRefreshToken()

setRefreshToken

public void setRefreshToken(java.lang.String refreshToken)

forgetIDTokensForServer

public static boolean forgetIDTokensForServer(java.net.URL serverURL,
                                              TokenStore tokenStore)