EMA C++ RDM Usage Guide : 3 Login Domain : 3.2 Usage : 3.2.4 Login Refresh Message
 
3.2.4 Login Refresh Message
A Login refresh message is encoded using RefreshMsg and sent by Open Message Model interactive provider applications. This message is used to respond to a Login Request message after the user’s Login is accepted. An Open Message Model provider can use the Login request information to authenticate users with the Data Access Control System. After authentication, a refresh message is sent to convey that the login was accepted. If the login is rejected, a Login status message should be sent as described in Section 3.2.7.
 
Table 7: Login Refresh Message  
COMPONENT
DESCRIPTION / VALUE
DomainType
Required. MMT_LOGIN = 1
State
Optional.
For the Refresh message, when accepting Login:
StreamState = OmmState.Open
DataState = OmmState.Ok
StatusCode = OmmState.None
Solicited
Required. Specifies whether the refresh was solicited.
true: Indicates that the refresh was solicited.
false: Indicates that the refresh was unsolicited.
Indications
Required: Complete set to true, which indicates the refresh is complete. The content of a Login Refresh message is expected to be atomic and contained in a single part, therefore RefreshMsg.Complete must be set to true.
Optional: ClearCache set to true, which indicates to clear the cache.
QoS
Not used.
SeqNum
Not used.
ItemGroup
Not used.
PermissionData
Not used.
extendedHeader
Not used.
ServiceId
Not used.
NameType
Optional.
Possible values:
USER_NAME
USER_EMAIL_ADDRESS
USER_TOKEN
USER_AUTHN_TOKEN
If NameType is not set then it is assumed to be a NameType of USER_NAME.
If present, the value should match the type specified in the Login request.
Name
Optional.
Name should match the Name specified in the Login request and contain appropriate content corresponding to the NameType specification.
Filter
Not used.
Identifier
Not used.
Attrib
Optional.
Typically an ElementList.Elements are specified in Section 3.2.5.
Payload
Optional.
Typically present when login requests connection configuration or permission profile information. The payload is sent as an ElementList. For payload details, refer to Section 3.3.1.