com.devexperts.qd.qtp.auth

Interface QDLoginHandler

All Known Implementing Classes:

BasicLoginHandler

public interface QDLoginHandler

Framework for the authorization, which must receive and update accessToken for the client.

Method Summary

Modifier and Type	Method and Description
com.devexperts.auth.AuthToken	getAuthToken() Returns current token or null if not authenticated yet.
com.dxfeed.promise.Promise<com.devexperts.auth.AuthToken>	login(String reason) Starts or restarts login procedure by this login handler.

Method Detail

login

com.dxfeed.promise.Promise<com.devexperts.auth.AuthToken> login(String reason)

Starts or restarts login procedure by this login handler. This method shall not block and can be called asynchronously and concurrently from multiple threads, e.g. it must include all the synchronization it needs. This method is invoked if server reports that connection needs authorization. Returns promise that will either return AuthToken or throw something exception. If handler already has AuthToken, then this method returns the completed promise. This promise is cancelled if the connection is closed for any reason.

Parameters:

reason - The text prompt to login. If current auth token was rejected by server for some reason, then it will contain the reason.

Returns:

promise that will either return AuthToken or throw something exception.

getAuthToken

com.devexperts.auth.AuthToken getAuthToken()

Returns current token or null if not authenticated yet. It is Ok if login handler already has a token even before its login method was invoked.

Returns:

current token or null if not authenticated yet.