com.ciscospark.androidsdk.auth

Interface Authenticator

All Known Implementing Classes:

JWTAuthenticator, OAuthAuthenticator, OAuthWebViewAuthenticator, SSOAuthenticator

public interface Authenticator

An interface for generic authentication strategies in Cisco Spark. Each authentication strategy is responsible for providing an accessToken used throughout this SDK.

Since:

0.1

Method Summary

Modifier and Type	Method and Description
void	deauthorize() Deauthorizes the current user and clears any persistent state with regards to the current user.
void	getToken(CompletionHandler<java.lang.String> handler) Returns an access token of this authenticator.
boolean	isAuthorized() Returns True if the user is logically authorized.
void	refreshToken(CompletionHandler<java.lang.String> handler) Refresh an access token of this authenticator.

Method Detail

isAuthorized

boolean isAuthorized()

Returns True if the user is logically authorized.

This may not mean the user has a valid access token yet, but the authentication strategy should be able to obtain one without further user interaction.

Returns:

True if the user is logically authorized

Since:

0.1

deauthorize

void deauthorize()

Deauthorizes the current user and clears any persistent state with regards to the current user. If the Phone is registered, it should be deregistered before calling this method.

Since:

0.1

getToken

void getToken(CompletionHandler<java.lang.String> handler)

Returns an access token of this authenticator.

This may involve long-running operations such as service calls, but may also return immediately. The application should not make assumptions about how quickly this completes.

Parameters:

handler - a callback to be executed when completed, with the access token if successfuly retrieved, otherwise nil.

Since:

0.1

refreshToken

void refreshToken(CompletionHandler<java.lang.String> handler)

Refresh an access token of this authenticator.

This may involve long-running operations such as service calls, but may also return immediately. The application should not make assumptions about how quickly this completes.

Parameters:

handler - a callback to be executed when completed, with the access token if successfuly retrieved, otherwise nil.

Since:

1.4