com.ciscospark.androidsdk.auth

Class JWTAuthenticator

java.lang.Object

com.ciscospark.androidsdk.auth.JWTAuthenticator

All Implemented Interfaces:

Authenticator

public class JWTAuthenticator
extends java.lang.Object
implements Authenticator

A JSON Web Token (JWT) based authentication strategy is to be used to authenticate a user on Cisco Spark.

Since:

0.1

Constructor Summary

Constructors

Constructor and Description
JWTAuthenticator() Creates a new JWT authentication strategy

Method Summary

Modifier and Type	Method and Description
void	authorize(java.lang.String jwt) Sets the JWT access token on the authorization strategy, overriting any existing access token.
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

JWTAuthenticator

public JWTAuthenticator()

Creates a new JWT authentication strategy

Since:

0.1

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

authorize

public void authorize(@NonNull
                      java.lang.String jwt)

Sets the JWT access token on the authorization strategy, overriting any existing access token.

Parameters:

jwt - the new JSON Web Token to use

Since:

0.1

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

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.