com.devexperts.qd.qtp.auth

Interface QDAuthRealm

public interface QDAuthRealm

This is server-side authentication provider that resolves AuthSession.

Method Summary

Modifier and Type	Method and Description
com.dxfeed.promise.Promise<com.devexperts.auth.AuthSession>	authenticate(com.devexperts.auth.AuthToken authToken, com.devexperts.util.TypedMap connectionVariables) Starts or restarts authentication procedure by this QDAuthRealm.
String	getAuthenticationInfo() Returns introductory information for the client about the authentication procedure.

Method Detail

authenticate

com.dxfeed.promise.Promise<com.devexperts.auth.AuthSession> authenticate(com.devexperts.auth.AuthToken authToken,
                                                                         com.devexperts.util.TypedMap connectionVariables)

Starts or restarts authentication procedure by this QDAuthRealm. 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. Returns promise that will either return AuthSession for this client AuthToken or throw something exception. This promise is cancelled if the connection is closed for any reason. This method is invoked if client sent auth token.

Parameters:

authToken - token from client

connectionVariables - the connection variables

Returns:

promise that will either return AuthSession or throw something exception.

getAuthenticationInfo

String getAuthenticationInfo()

Returns introductory information for the client about the authentication procedure. This message is sent to the other side of the connection.

Returns:

introductory information for the client about the authentication procedure.