com.aldebaran.qi

Class UserTokenAuthenticator

java.lang.Object

com.aldebaran.qi.UserTokenAuthenticator

All Implemented Interfaces:

ClientAuthenticator

public class UserTokenAuthenticator
extends Object
implements ClientAuthenticator

Specific ClientAuthenticator that authenticates a user using a token.

Constructor Summary

Constructors

Constructor and Description
UserTokenAuthenticator(String user) Deprecated. since 3.1.1, use the constructor that takes both user and token arguments
UserTokenAuthenticator(String user, String token) Constructs an authenticator with the specified user and token.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	_processAuth(Map<String,Object> authData)
String	getToken()
boolean	hasNewToken() Deprecated. since 3.1.1, became useless since a new token cannot be retrieved with _processAuth.
Map<String,Object>	initialAuthData()

Methods inherited from class java.lang.Object

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

Constructor Detail

UserTokenAuthenticator

public UserTokenAuthenticator(String user,
                              String token)

Constructs an authenticator with the specified user and token.

UserTokenAuthenticator

@Deprecated
public UserTokenAuthenticator(String user)

Deprecated. since 3.1.1, use the constructor that takes both user and token arguments

Constructs an authenticator with the specified user and an empty token.

Method Detail

initialAuthData

public Map<String,Object> initialAuthData()

Specified by:

initialAuthData in interface ClientAuthenticator

_processAuth

public Map<String,Object> _processAuth(Map<String,Object> authData)

Specified by:

_processAuth in interface ClientAuthenticator

hasNewToken

@Deprecated
public boolean hasNewToken()

Deprecated. since 3.1.1, became useless since a new token cannot be retrieved with _processAuth.

Indicates whether a new token has been retrieved during the last authentication.

Returns:

false all the time.

getToken

public String getToken()