EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Public Types | Friends
thomsonreuters::ema::access::ServiceEndpointDiscoveryOption Class Reference

ServiceEndpointDiscoveryOption is used to specify query options for ServiceEndpointDiscovery::registerClient(). More...

Public Types

enum  DataformatProtocol {
  UnknownDataFormatEnum = 0,
  RwfEnum = 1,
  Json2Enum = 2
}
 
enum  TransportProtocol {
  UnknownTransportEnum = 0,
  TcpEnum = 1,
  WebsocketEnum = 2
}
 

Public Member Functions

Constructor
 ServiceEndpointDiscoveryOption ()
 
Destructor
virtual ~ServiceEndpointDiscoveryOption ()
 
Operations
ServiceEndpointDiscoveryOptionclear ()
 
ServiceEndpointDiscoveryOptionusername (const EmaString &username)
 
ServiceEndpointDiscoveryOptionpassword (const EmaString &password)
 
ServiceEndpointDiscoveryOptionclientId (const EmaString &clientId)
 
ServiceEndpointDiscoveryOptionclientSecret (const EmaString &clientSecret)
 
ServiceEndpointDiscoveryOptiontokenScope (const EmaString &tokenScope="trapi.streaming.pricing.read")
 
ServiceEndpointDiscoveryOptiontakeExclusiveSignOnControl (bool takeExclusiveSignOnControl=true)
 
ServiceEndpointDiscoveryOptiontransprot (TransportProtocol transport)
 
ServiceEndpointDiscoveryOptiontransport (TransportProtocol transport)
 
ServiceEndpointDiscoveryOptiondataFormat (DataformatProtocol dataFormat)
 
ServiceEndpointDiscoveryOptionproxyHostName (const EmaString &proxyHostName)
 
ServiceEndpointDiscoveryOptionproxyPort (const EmaString &proxyPort)
 
ServiceEndpointDiscoveryOptionproxyUserName (const EmaString &proxyUserName)
 
ServiceEndpointDiscoveryOptionproxyPassword (const EmaString &proxyPassword)
 
ServiceEndpointDiscoveryOptionproxyDomain (const EmaString &proxyDomain)
 

Friends

class ServiceEndpointDiscoveryImpl
 

Detailed Description

Remarks
All methods in this class are Lock-free Method.
See Also
ServiceEndpointDiscovery

Definition at line 31 of file ServiceEndpointDiscoveryOption.h.

Member Enumeration Documentation

Enumerator
UnknownDataFormatEnum 

Indicates undefined data format protocol

RwfEnum 

Indicates RWF data format protocol

Json2Enum 

Indicates tr_json2 data format protocol

Definition at line 42 of file ServiceEndpointDiscoveryOption.h.

Enumerator
UnknownTransportEnum 

Indicates undefined transport protocol

TcpEnum 

Indicates TCP transport protocol

WebsocketEnum 

Indicates Websocket transport protocol

Definition at line 35 of file ServiceEndpointDiscoveryOption.h.

Constructor & Destructor Documentation

thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::ServiceEndpointDiscoveryOption ( )

Create an ServiceEndpointDiscoveryOption that enables configuration of optional parameters.

virtual thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::~ServiceEndpointDiscoveryOption ( )
virtual

Destructor.

Member Function Documentation

ServiceEndpointDiscoveryOption& thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::clear ( )

Clears the ServiceEndpointDiscoveryOption and sets all the defaults.

Returns
reference to this object
ServiceEndpointDiscoveryOption& thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::clientId ( const EmaString clientId)

Specifies the a unique identifier for an application making the request.

Parameters
[in]clientIdspecifies the client ID
Returns
reference to this object
ServiceEndpointDiscoveryOption& thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::clientSecret ( const EmaString clientSecret)

Specifies optionally a secret used by OAuth client to authenticate to the Authorization Server.

Parameters
[in]clientSecretspecifies a client secret.
Returns
reference to this object
ServiceEndpointDiscoveryOption& thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::dataFormat ( DataformatProtocol  dataFormat)

Specifies a data format protocol to get endpoints according to the protocol.

Parameters
[in]dataFormatspecifies a data format protocol
Returns
reference to this object
Remarks
this is an optional option to limit number of endpoints
ServiceEndpointDiscoveryOption& thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::password ( const EmaString password)

Specifies the password associated with the username for sending authorization request with the token service.

Parameters
[in]passwordspecifies password on login request
Returns
reference to this object
ServiceEndpointDiscoveryOption& thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::proxyDomain ( const EmaString proxyDomain)
Specifies a proxy domain of the user to perform authenticate.
Parameters
[in]proxyDomainspecifies a proxy domain
Returns
reference to this object \ Needed for NTLM or for Negotiate/Kerberos or for Kerberos authentication protocols.
ServiceEndpointDiscoveryOption& thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::proxyHostName ( const EmaString proxyHostName)
Specifies a proxy server hostname.
Parameters
[in]proxyHostNamespecifies a proxy server
Returns
reference to this object
Remarks
this is used to send the request via a proxy server
ServiceEndpointDiscoveryOption& thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::proxyPassword ( const EmaString proxyPassword)
Specifies a password to perform authorization with a proxy server.
Parameters
[in]proxyPasswordspecifies a proxy password
Returns
reference to this object
Remarks
this is used to send the request via a proxy server
ServiceEndpointDiscoveryOption& thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::proxyPort ( const EmaString proxyPort)
Specifies a proxy server port.
Parameters
[in]proxyPortspecifies a proxy port
Returns
reference to this object
Remarks
this is used to send the request via a proxy server
ServiceEndpointDiscoveryOption& thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::proxyUserName ( const EmaString proxyUserName)
Specifies a username to perform authorization with a proxy server.
Parameters
[in]proxyUserNamespecifies a proxy user name
Returns
reference to this object
Remarks
this is used to send the request via a proxy server
ServiceEndpointDiscoveryOption& thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::takeExclusiveSignOnControl ( bool  takeExclusiveSignOnControl = true)

Specifies optionally the exclusive sign on control to force sign-out of other applications using the same credentials.

Parameters
[in]takeExclusiveSignOnControlthe exclusive sign on control.
Returns
reference to this object
ServiceEndpointDiscoveryOption& thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::tokenScope ( const EmaString tokenScope = "trapi.streaming.pricing.read")

Specifies optionally token scope to limit the scope of generated token from the token service.

Parameters
[in]tokenScopespecifies a token scope
Returns
reference to this object
ServiceEndpointDiscoveryOption& thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::transport ( TransportProtocol  transport)

Specifies a transport protocol to get endpoints according to the protocol.

Parameters
[in]transportspecifies a transport protocol
Returns
reference to this object
Remarks
this is an optional option to limit number of endpoints
ServiceEndpointDiscoveryOption& thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::transprot ( TransportProtocol  transport)
Deprecated:
the transport() function should be used instead. Specifies a transport protocol to get endpoints according to the protocol.
Parameters
[in]transportspecifies a transport protocol
Returns
reference to this object
Remarks
this is an optional option to limit number of endpoints
ServiceEndpointDiscoveryOption& thomsonreuters::ema::access::ServiceEndpointDiscoveryOption::username ( const EmaString username)

Specifies the username for sending authorization request with the token service.

Parameters
[in]usernamespecifies name used on login request
Returns
reference to this object

Friends And Related Function Documentation

friend class ServiceEndpointDiscoveryImpl
friend

Definition at line 166 of file ServiceEndpointDiscoveryOption.h.