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

CosAuthentication encapsulates authentication member of the ClassOfService class. More...

Public Types

enum  CosAuthenticationType {
  NotRequiredEnum = 0,
  OmmLoginEnum = 1
}
 

Public Member Functions

Constructor
 CosAuthentication ()
 
 CosAuthentication (const CosAuthentication &other)
 
Destructor
virtual ~CosAuthentication ()
 
Operations
CosAuthenticationoperator= (const CosAuthentication &other)
 
CosAuthenticationclear ()
 
CosAuthenticationtype (CosAuthenticationType type=NotRequiredEnum)
 
Accessors
CosAuthenticationType getType () const
 

Detailed Description

CosAuthentication contains options to authenticate a consumer to the corresponding provider.

See Also
ClassOfService

Definition at line 98 of file TunnelStreamRequest.h.

Member Enumeration Documentation

An enumeration representing authentication type.

Enumerator
NotRequiredEnum 

Indicates authentication is not required

OmmLoginEnum 

Indicates OmmLogin message is required for authentication

Definition at line 105 of file TunnelStreamRequest.h.

Constructor & Destructor Documentation

thomsonreuters::ema::access::CosAuthentication::CosAuthentication ( )

Default constructor

thomsonreuters::ema::access::CosAuthentication::CosAuthentication ( const CosAuthentication other)

Copy constructor

Parameters
[in]otherspecifies CosAuthentication object to copy from
virtual thomsonreuters::ema::access::CosAuthentication::~CosAuthentication ( )
virtual

Destructor

Member Function Documentation

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

Clears object by setting defaults

Returns
reference to this object
CosAuthenticationType thomsonreuters::ema::access::CosAuthentication::getType ( ) const

Returns Authentication type

Returns
authentication type
CosAuthentication& thomsonreuters::ema::access::CosAuthentication::operator= ( const CosAuthentication other)

Assignment operator

Parameters
[in]otherspecifies CosAuthentication object to copy from
Returns
reference to this object
CosAuthentication& thomsonreuters::ema::access::CosAuthentication::type ( CosAuthenticationType  type = NotRequiredEnum)

Specifies authentication type

Parameters
[in]typeauthentication type
Returns
reference to this object
Exceptions
OmmOutOfRangeExceptionif passed in authentication type is not valid