com.ciscospark.androidsdk.auth

Class OAuthAuthenticator

java.lang.Object

com.ciscospark.androidsdk.auth.OAuthAuthenticator

All Implemented Interfaces:

Authenticator

public class OAuthAuthenticator
extends java.lang.Object
implements Authenticator

An OAuth based authentication strategy for authenticating a user on Cisco Spark.

Since:

0.1

See Also:

Cisco Spark Integration

Constructor Summary

Constructors

Constructor and Description
OAuthAuthenticator(java.lang.String clientId, java.lang.String clientSecret, java.lang.String scope, java.lang.String redirectUri) Creates a new OAuth authentication strategy

Method Summary

Modifier and Type	Method and Description
void	authorize(java.lang.String code, CompletionHandler<java.lang.Void> handler) Authorize with the OAuth authorization code
void	deauthorize() Deauthorizes the current user and clears any persistent state with regards to the current user.
protected java.lang.String	getClientId()
protected java.lang.String	getClientSecret()
protected java.lang.String	getRedirectUri()
protected java.lang.String	getScope()
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthAuthenticator

public OAuthAuthenticator(@NonNull
                          java.lang.String clientId,
                          @NonNull
                          java.lang.String clientSecret,
                          @NonNull
                          java.lang.String scope,
                          @NonNull
                          java.lang.String redirectUri)

Creates a new OAuth authentication strategy

Parameters:

clientId - the OAuth client id

clientSecret - the OAuth client secret

scope - space-separated string representing which permissions the application needs

redirectUri - the redirect URI that will be called when completing the authentication. This must match the redirect URI registered to your clientId.

Since:

0.1

See Also:

Cisco Spark Integration

Method Detail

isAuthorized

public boolean isAuthorized()

Description copied from interface: Authenticator

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.

Specified by:

isAuthorized in interface Authenticator

Returns:

True if the user is logically authorized

See Also:

Authenticator

deauthorize

public void deauthorize()

Description copied from interface: Authenticator

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.

Specified by:

deauthorize in interface Authenticator

See Also:

Authenticator

authorize

public void authorize(@NonNull
                      java.lang.String code,
                      @NonNull
                      CompletionHandler<java.lang.Void> handler)

Authorize with the OAuth authorization code

Parameters:

code - OAuth authorization code

handler - the completion handler will be called when authentication is complete, the error to indicate if the authentication process was successful.

Since:

0.1

getToken

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

Description copied from interface: Authenticator

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.

Specified by:

getToken in interface Authenticator

Parameters:

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

See Also:

Authenticator

refreshToken

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

Description copied from interface: Authenticator

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.

Specified by:

refreshToken in interface Authenticator

Parameters:

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

getClientId

protected java.lang.String getClientId()

getClientSecret

protected java.lang.String getClientSecret()

getScope

protected java.lang.String getScope()

getRedirectUri

protected java.lang.String getRedirectUri()