EMA C++ Edition
List of all members
refinitiv::ema::access::OmmLoginCredentialConsumerClient Class Reference

OmmLoginCredentialConsumerClient class provides callback interfaces for OAuth interactions. More...

Callbacks

virtual void onLoginCredentialRenewal (const OmmConsumerEvent &consumerEvent)
  More...
 
 OmmLoginCredentialConsumerClient ()
 
virtual ~OmmLoginCredentialConsumerClient ()
 

Detailed Description

Application may implement an application client class inheriting from OmmLoginCredentialConsumerClient. In its own class, application needs to override callback methods it desires to use for item processing. Default empty callback methods are implemented by OmmLoginCredentialConsumerClient class.

Remarks
Thread safety of all the methods in this class depends on the user's implementation.

The following code snippet shows basic usage of OmmLoginCredentialConsumerClient class to print recevied messages to screen.

class AppClient : public OmmLoginCredentialConsumerClient
{
void onLoginCredentialRenewal( const OmmConsumerEvent& );
};
void AppClient::onLoginCredentialRenewal( const OmmConsumerEvent& event )
{
//Retrieve the credentials, then call OmmConsumer::SubmitOAuthCredentialRenewal to submit the renewed credentials.
LoginMsgCredentialRenewal credentials;
// Need the OmmConsumer object to call SubmitOAuthCredentialRenewal
OmmConsumer& consumer = event.getClosure().getConsumer();
credentials.userName("<USER NAME>");
consumer.renewLoginCredentials(credentials);
}
virtual void onLoginCredentialRenewal(const OmmConsumerEvent &consumerEvent)

Definition at line 62 of file OmmLoginCredentialConsumerClient.h.

Member Function Documentation

◆ onLoginCredentialRenewal()

virtual void refinitiv::ema::access::OmmLoginCredentialConsumerClient::onLoginCredentialRenewal ( const OmmConsumerEvent consumerEvent)
virtual

Invoked upon receiving a credentials request for Login credential renewal interactions.

Parameters
[out]ommConsumerThe ommConsumer associated with this callback. The user must call OmmConsumer::renewLoginCredentials in this function, even if the credentials have not changed.
[out]consumerEventidentifies open item for which this message is received
Returns
void