LoginAttrib (ETA ValueAdd)

```
public interface LoginAttrib
```
The RDM login attrib. LoginAttrib be used to send additional authentication information and user preferences between the components.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`allowSuspectData()` Returns allowSuspectData for the login message.
`void`	`allowSuspectData(long allowSuspectData)` Sets allowSuspectData for the login message.
`com.thomsonreuters.upa.codec.Buffer`	`applicationId()` Returns DACS application id for the login message.
`void`	`applicationId(com.thomsonreuters.upa.codec.Buffer applicationId)` Sets DACS application id for the login message.
`com.thomsonreuters.upa.codec.Buffer`	`applicationName()` Returns applicationName for the login message.
`void`	`applicationName(com.thomsonreuters.upa.codec.Buffer applicationName)` Sets applicationName for the login message.
`void`	`applyHasAllowSuspectData()` Applies allow suspect data presence flag.
`void`	`applyHasApplicationId()` Applies application id presence flag.
`void`	`applyHasApplicationName()` Applies application name presence flag.
`void`	`applyHasPosition()` Applies position presence flag.
`void`	`applyHasProvidePermissionExpressions()` Applies provide permission expressions presence flag.
`void`	`applyHasProvidePermissionProfile()` Applies provide permission profile presence flag.
`void`	`applyHasProviderSupportDictionaryDownload()` Applies provider support dictionary download flag.
`void`	`applyHasSingleOpen()` Applies single open presence flag.
`boolean`	`checkHasAllowSuspectData()` Checks the presence of allow suspect data field.
`boolean`	`checkHasApplicationId()` Checks the presence of application id field.
`boolean`	`checkHasApplicationName()` Checks the presence of application name field.
`boolean`	`checkHasPosition()` Checks the presence of position field.
`boolean`	`checkHasProvidePermissionExpressions()` Checks the presence of provide permission expressions field.
`boolean`	`checkHasProvidePermissionProfile()` Checks the presence of provide permission profile field.
`boolean`	`checkHasProviderSupportDictionaryDownload()` Checks the presence of provider support dictionary download field.
`boolean`	`checkHasSingleOpen()` Checks the presence of single open field.
`void`	`clear()` Clears the current contents of the login attrib object and prepares it for re-use.
`int`	`copy(LoginAttrib destAttrib)` Performs a deep copy of `LoginAttrib` object.
`int`	`flags()` Returns login request attrib flags.
`void`	`flags(int flags)` Sets login attrib flags.
`com.thomsonreuters.upa.codec.Buffer`	`position()` Returns the DACS position for login message.
`void`	`position(com.thomsonreuters.upa.codec.Buffer position)` Sets the DACS position for login message.
`long`	`providePermissionExpressions()` Sets providePermissionExpressions for the login message.
`void`	`providePermissionExpressions(long providePermissionExpressions)` Returns providePermissionExpressions for the login message.
`long`	`providePermissionProfile()` Returns providePermissionProfile for the login message.
`void`	`providePermissionProfile(long providePermissionProfile)` Sets providePermissionProfile for the login message.
`long`	`singleOpen()` Returns singleOpen field of the login message.
`void`	`singleOpen(long singleOpen)` Sets singleOpen field of the login message.
`long`	`supportProviderDictionaryDownload()` Returns supportProviderDictionaryDownload for the login message.
`void`	`supportProviderDictionaryDownload(long supportProviderDictionaryDownload)` Sets supportProviderDictionaryDownload for the login message.

- Method Detail
  - flags
```
void flags(int flags)
```
    Sets login attrib flags. Populated by LoginAttribFlags.
    
    Parameters:
    
    flags - the flags
  - flags
```
int flags()
```
    Returns login request attrib flags. Populated by LoginAttribFlags
    
    Returns:
    
    flags
  - copy
```
int copy(LoginAttrib destAttrib)
```
    Performs a deep copy of LoginAttrib object.
    
    Parameters:
    
    destAttrib - Login attrib object to copy this object into. It cannot be null.
    
    Returns:
    
    UPA return value indicating success or failure of copy operation.
  - clear
```
void clear()
```
    Clears the current contents of the login attrib object and prepares it for re-use.
  - applicationId
```
com.thomsonreuters.upa.codec.Buffer applicationId()
```
    Returns DACS application id for the login message.
    
    Returns:
    
    The DACS Application ID.
  - applicationId
```
void applicationId(com.thomsonreuters.upa.codec.Buffer applicationId)
```
    Sets DACS application id for the login message. Note that this creates garbage if buffer is backed by String object.
    
    Parameters:
    
    applicationId - -DACS Application ID.
  - checkHasApplicationId
```
boolean checkHasApplicationId()
```
    Checks the presence of application id field. This flag can also be bulk-get by flags()
    
    Returns:
    
    true - if application id is present, false - if not.
  - applyHasApplicationId
```
void applyHasApplicationId()
```
    Applies application id presence flag. This flag can also be bulk-set by flags(int)
  - applicationName
```
com.thomsonreuters.upa.codec.Buffer applicationName()
```
    Returns applicationName for the login message. This field identifies the application sending the Login request or response message. When present, the application name in the Login request identifies the OMM Consumer and the application name in the Login response identifies the OMM provider.
    
    Returns:
    
    The ApplicationName
  - applicationName
```
void applicationName(com.thomsonreuters.upa.codec.Buffer applicationName)
```
    Sets applicationName for the login message. Note that this method creates garbage if buffer is backed by String object.
    
    Parameters:
    
    applicationName - the application name
  - checkHasApplicationName
```
boolean checkHasApplicationName()
```
    Checks the presence of application name field. This flag can also be bulk-get by flags()
    
    Returns:
    
    true - if application name is present, false - if not.
  - applyHasApplicationName
```
void applyHasApplicationName()
```
    Applies application name presence flag. This flag can also be bulk-set by flags(int)
  - position
```
com.thomsonreuters.upa.codec.Buffer position()
```
    Returns the DACS position for login message. If the server authenticates with DACS, the consumer application might be required to pass in a valid position. If present, this should match whatever was sent in the request or be set to the IP address of the connected client.
    
    Returns:
    
    position
  - position
```
void position(com.thomsonreuters.upa.codec.Buffer position)
```
    Sets the DACS position for login message. If the server authenticates with DACS, the consumer application might be required to pass in a valid position. If present, this should match whatever was sent in the request or be set to the IP address of the connected client. Note that this method creates garbage if buffer is backed by String object.
    
    Parameters:
    
    position - the position
  - checkHasPosition
```
boolean checkHasPosition()
```
    Checks the presence of position field. This flag can also be bulk-get by flags()
    
    Returns:
    
    true - if position is present, false - if not.
  - applyHasPosition
```
void applyHasPosition()
```
    Applies position presence flag. This flag can also be bulk-set by flags(int)
  - providePermissionProfile
```
long providePermissionProfile()
```
    Returns providePermissionProfile for the login message. If specified on the Login Refresh, indicates that the permission profile is provided. This is typically present because the login request message requested this information. An application can use the permission profile to perform proxy permissioning.
    
    Returns:
    
    providePermissionProfile
  - providePermissionProfile
```
void providePermissionProfile(long providePermissionProfile)
```
    Sets providePermissionProfile for the login message. If specified on the Login Refresh, indicates that the permission profile is provided. This is typically present because the login request message requested this information. An application can use the permission profile to perform proxy permissioning.
    
    Parameters:
    
    providePermissionProfile - the provide permission profile
  - checkHasProvidePermissionProfile
```
boolean checkHasProvidePermissionProfile()
```
    Checks the presence of provide permission profile field. This flag can also be bulk-get by flags()
    
    Returns:
    
    true - if provide permission profile field is present, false - if not.
  - applyHasProvidePermissionProfile
```
void applyHasProvidePermissionProfile()
```
    Applies provide permission profile presence flag. This flag can also be bulk-set by flags(int)
  - providePermissionExpressions
```
long providePermissionExpressions()
```
    Sets providePermissionExpressions for the login message. If specified on a Login Refresh, indicates that a provider will send permission expression information with its responses. ProvidePermissionExpressions is typically present because the login request message requested this information. Permission expressions allow for items to be proxy permissioned by a consumer via content-based entitlements.
    
    Returns:
    
    providePermissionExpressions
  - providePermissionExpressions
```
void providePermissionExpressions(long providePermissionExpressions)
```
    Returns providePermissionExpressions for the login message. If specified on a Login Refresh, indicates that a provider will send permission expression information with its responses. ProvidePermissionExpressions is typically present because the login request message requested this information. Permission expressions allow for items to be proxy permissioned by a consumer via content-based entitlements.
    
    Parameters:
    
    providePermissionExpressions - the provide permission expressions
  - checkHasProvidePermissionExpressions
```
boolean checkHasProvidePermissionExpressions()
```
    Checks the presence of provide permission expressions field. This flag can also be bulk-get by flags()
    
    Returns:
    
    true - if provide permission expressions field is present, false - if not.
  - applyHasProvidePermissionExpressions
```
void applyHasProvidePermissionExpressions()
```
    Applies provide permission expressions presence flag. This flag can also be bulk-set by flags(int)
  - singleOpen
```
long singleOpen()
```
    Returns singleOpen field of the login message. Value of 1 indicated provider drives stream recovery. 0 indicates provider does not drive stream recovery; it is the responsibility of the downstream application.
    
    Returns:
    
    singleOpen
  - singleOpen
```
void singleOpen(long singleOpen)
```
    Sets singleOpen field of the login message. Value of 1 indicated provider drives stream recovery. 0 indicates provider does not drive stream recovery; it is the responsibility of the downstream application.
    
    Parameters:
    
    singleOpen - the single open
  - checkHasSingleOpen
```
boolean checkHasSingleOpen()
```
    Checks the presence of single open field. This flag can also be bulk-get by flags()
    
    Returns:
    
    true - if single open field is present, false - if not.
  - applyHasSingleOpen
```
void applyHasSingleOpen()
```
    Applies single open presence flag. This flag can also be bulk-set by flags(int)
  - allowSuspectData
```
long allowSuspectData()
```
    Returns allowSuspectData for the login message. Value of 1 indicated provider application passes along suspect streamState information. 0 indicates provider application does not pass along suspect data.
    
    Returns:
    
    allowSuspectData
  - allowSuspectData
```
void allowSuspectData(long allowSuspectData)
```
    Sets allowSuspectData for the login message. Value of 1 indicated provider application passes along suspect streamState information. 0 indicates provider application does not pass along suspect data.
    
    Parameters:
    
    allowSuspectData - the allow suspect data
  - checkHasAllowSuspectData
```
boolean checkHasAllowSuspectData()
```
    Checks the presence of allow suspect data field. This flag can also be bulk-get by flags()
    
    Returns:
    
    true - if allow suspect data field is present, false - if not.
  - applyHasAllowSuspectData
```
void applyHasAllowSuspectData()
```
    Applies allow suspect data presence flag. This flag can also be bulk-set by flags(int)
  - supportProviderDictionaryDownload
```
long supportProviderDictionaryDownload()
```
    Returns supportProviderDictionaryDownload for the login message. Value of 1 indicates that provider can request dictionary. 0 indicates that provider cannot request dictionary.
    
    Returns:
    
    allowSuspectData
  - supportProviderDictionaryDownload
```
void supportProviderDictionaryDownload(long supportProviderDictionaryDownload)
```
    Sets supportProviderDictionaryDownload for the login message. Value of 1 indicates that provider can request dictionary. 0 indicates that provider cannot request dictionary.
    
    Parameters:
    
    supportProviderDictionaryDownload - the support provider dictionary download
  - checkHasProviderSupportDictionaryDownload
```
boolean checkHasProviderSupportDictionaryDownload()
```
    Checks the presence of provider support dictionary download field. This flag can also be bulk-get by flags()
    
    Returns:
    
    true - if provider support dictionary download field is present, false - if not.
  - applyHasProviderSupportDictionaryDownload
```
void applyHasProviderSupportDictionaryDownload()
```
    Applies provider support dictionary download flag. This flag can also be bulk-set by flags(int)

Interface LoginAttrib

Method Summary

Method Detail

flags

flags

copy

clear

applicationId

applicationId

checkHasApplicationId

applyHasApplicationId

applicationName

applicationName

checkHasApplicationName

applyHasApplicationName

position

position

checkHasPosition

applyHasPosition

providePermissionProfile

providePermissionProfile

checkHasProvidePermissionProfile

applyHasProvidePermissionProfile

providePermissionExpressions

providePermissionExpressions

checkHasProvidePermissionExpressions

applyHasProvidePermissionExpressions

singleOpen

singleOpen

checkHasSingleOpen

applyHasSingleOpen

allowSuspectData

allowSuspectData

checkHasAllowSuspectData

applyHasAllowSuspectData

supportProviderDictionaryDownload

supportProviderDictionaryDownload

checkHasProviderSupportDictionaryDownload

applyHasProviderSupportDictionaryDownload