EMA C++ Edition
OAuth2Credential.h
Go to the documentation of this file.
1/*|-----------------------------------------------------------------------------
2 *| This source code is provided under the Apache 2.0 license
3 *| and is provided AS IS with no warranty or guarantee of fit for purpose.
4 *| See the project's LICENSE.md for details.
5 *| Copyright (C) 2022 LSEG. All rights reserved. --
6 *|-----------------------------------------------------------------------------
7 */
8
9#ifndef __refinitiv_ema_access_OAuth2Credential_h
10#define __refinitiv_ema_access_OAuth2Credential_h
11
20
21
22namespace refinitiv {
23
24namespace ema {
25
26namespace access {
27
28class EmaString;
29class OAuth2Credential;
30
31
33{
34public :
35
37
38
42
44
45
49
51
52
58
65
72
79
85 OAuth2Credential& clientSecret(const EmaString& clientSecret );
86
93
100
107
113 OAuth2Credential& takeExclusiveSignOnControl( bool takeExclusiveSignOnControl );
114
123
125
126
131
137
143
149
155
161
167
174
180
182
183private :
184 friend class OmmOAuth2CredentialImpl;
185
187 OAuth2Credential& operator=( const OAuth2Credential& );
188
189 EmaString _userName;
191 EmaString _password;
193 EmaString _clientId;
194 EmaString _clientSecret;
195 EmaString _tokenScope;
197 EmaString _clientJWK;
198 EmaString _audience;
199
200 EmaString _channelList; /* Comma separated list of configured channel names that this set of credentials is associated with*/
201
202 bool _takeExclusiveSignOnControl;
204};
205
206}
207
208}
209
210}
211
212#endif // __refinitiv_ema_access_OAuth2Credential_h
Common.h file provides definitions of common variable types used in EMA.
#define EMA_ACCESS_API
Definition: Common.h:95
*|--------------------------------------------------------------------------—
Definition: AckMsg.h:62
The access namespace contains all interfaces and definitions specified for use with the EMA Access pa...
The ema namespace contains all interfaces and definitions specified for use with EMA.
EmaString class is a container of a null terminated Ascii character string.
Definition: EmaString.h:57
OAuth2Credential class is used with OmmConsumer::SubmitOAuthCredentialRenewal to supply EMA with chan...
OAuth2Credential & tokenScope(const EmaString &tokenScope)
OAuth2Credential & clientSecret(const EmaString &clientSecret)
OAuth2Credential & userName(const EmaString &userName)
OAuth2Credential & takeExclusiveSignOnControl(bool takeExclusiveSignOnControl)
OAuth2Credential & clientId(const EmaString &clientId)
OAuth2Credential & clientJWK(const EmaString &clientJWK)
OAuth2Credential & audience(const EmaString &audience)
OAuth2Credential & password(const EmaString &password)
OAuth2Credential & channelList(const EmaString &channelList)