Method Name | Description |
---|---|
OmmConsumerConfig.username() | Required. Specifies the user name for login request message. |
OmmConsumerConfig.password() | Optional Specifies the password for login request message. |
OmmConsumerConfig.position() | Optional Specifies the position for login request message. |
OmmConsumerConfig.applicationId() | Optional Specifies the authorization application identifier for login request message. |
OmmConsumerConfig.addAdminMsg() | Optional Specifies a login request message to override the default login request. |
COMPONENT | DESCRIPTION / VALUE |
---|---|
DomainType | Required. MMT_LOGIN = 1 |
Interactions | Conditional. • Setting InitialImage to true indicates that an initial image is required. • Setting InterestAfterRefresh to true indicates that a streaming request is required. A streaming request is required before any other requests. Non-streaming requests are unsupported. • Setting Pause set to true indicates that a pause is required. A pause request is a request to pause all item streams associated with the login. To resume all item streams associated with the login, issue another streaming request. |
QoS | Not used. |
worstQos | Not used. |
ExtendedHeader | Not used. |
ServiceId | Not used. |
NameType | Optional. Possible values are: • USER_NAME • USER_EMAIL_ADDRESS • USER_TOKEN • USER_COOKIE • USER_AUTHN_TOKEN If NameType is not set, it is assumed to be USER_NAME. A type of USER_NAME typically corresponds to a Data Access Control System user name. This can be used to authenticate and permission a user. USER_TOKEN is specified when using the AAA API The user token is retrieved from a AAA API gateway and then passed through the system via the Name. To validate users, a provider can pass this user token to an authentication manager application. If you specify USER_AUTHN_TOKEN, you must also set Name to a single, null character (i.e., a 0x00 binary), and include an AuthenticationToken element in the Attrib. For details on the AuthenticationToken, refer to Section 3.2.2. Both USER_TOKEN and USER_AUTHN_TOKEN can periodically change: when it changes, an application can send a login reissue to pass information upstream. • For further details on using USER_TOKEN, refer to the AAA API documentation. • For further details on using USER_AUTHN_TOKEN, refer to the UserAuthn Authentication User Manual.1 |
Name | Required. Name should be populated with appropriate content corresponding to the NameType specification. |
Filter | Not used. |
Identifier | Not used. |
Attrib | Optional. Typically an ElementList. Attributes are specified in Section 3.2.2. |
Payload | Not used. |