com.ciscospark.androidsdk.auth

Class SSOAuthenticator

java.lang.Object

com.ciscospark.androidsdk.auth.SSOAuthenticator

All Implemented Interfaces:

Authenticator

public class SSOAuthenticator
extends java.lang.Object
implements Authenticator

An Single sign-on SSO based authentication strategy used to authenticate a user on Cisco Spark.

Since:

1.3.0

See Also:

Cisco Spark Integration

Constructor Summary

Constructors

Constructor and Description
SSOAuthenticator(java.lang.String clientId, java.lang.String clientSecret, java.lang.String scope, java.lang.String redirectUri, java.lang.String email, java.lang.String identityProviderUri, java.util.Map<java.lang.String,java.lang.String> queryItems) Creates a new OAuth authentication strategy

Method Summary

Modifier and Type	Method and Description
void	authorize(android.webkit.WebView view, CompletionHandler<java.lang.Void> handler) Brings up a web-based authorization view and directs the user through the OAuth process.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SSOAuthenticator

public SSOAuthenticator(@NonNull
                        java.lang.String clientId,
                        @NonNull
                        java.lang.String clientSecret,
                        @NonNull
                        java.lang.String scope,
                        @NonNull
                        java.lang.String redirectUri,
                        @NonNull
                        java.lang.String email,
                        @NonNull
                        java.lang.String identityProviderUri,
                        @Nullable
                        java.util.Map<java.lang.String,java.lang.String> queryItems)

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.

email - The spark email address of the SSO user.

identityProviderUri - parameter identityProviderUri: the URI that will handle authentication claims with spark service on behalf of the hosting application.

queryItems - a collection of additional query items to be appended to the identityProviderUri.

Since:

1.3.0

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
                      android.webkit.WebView view,
                      @NonNull
                      CompletionHandler<java.lang.Void> handler)

Brings up a web-based authorization view and directs the user through the OAuth process.

Parameters:

view - the web view for the authorization by the end user.

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

Since:

1.3.0

getToken

public void getToken(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.