com.thomsonreuters.upa.valueadd.domainrep.rdm.login

Interface LoginRequest

All Superinterfaces:

LoginMsg, MsgBase

public interface LoginRequest
extends LoginMsg

The RDM login request. Used by an OMM Consumer or OMM Non-Interactive Provider to request a login.

See Also:

MsgBase, LoginMsg

Method Summary

Modifier and Type	Method and Description
void	applyHasAttrib() Applies attrib presence flag.
void	applyHasAuthenticationExtended() Applies authentication extendedData field flag.
void	applyHasDownloadConnectionConfig() Applies download connection config presence flag.
void	applyHasInstanceId() Applies instance id presence flag.
void	applyHasPassword() Applies password presence flag.
void	applyHasRole() Applies application role field flag.
void	applyHasUserNameType() Applies user name type presence flag.
void	applyNoRefresh() Applies no refresh required flag.
void	applyPause() Applies pause flag to login request.
LoginAttrib	attrib() Returns login attrib information.
void	attrib(LoginAttrib attrib) Sets login attrib information.
com.thomsonreuters.upa.codec.Buffer	authenticationExtended() Gets the authentication extended data.
void	authenticationExtended(com.thomsonreuters.upa.codec.Buffer authenticationExtended) Sets the authentication extended data.
boolean	checkHasAttrib() Checks the presence of attrib field.
boolean	checkHasAuthenticationExtended() Checks the presence of the authenticationExtended data field.
boolean	checkHasDownloadConnectionConfig() Checks the presence of download connection config field.
boolean	checkHasInstanceId() Checks the presence of instance id field.
boolean	checkHasPassword() Checks the presence of password field.
boolean	checkHasRole() Checks the presence of application role field.
boolean	checkHasUserNameType() Checks the presence of user name type.
boolean	checkNoRefresh() Checks if no refresh required flag is set.
boolean	checkPause() Checks if login request is pause.
int	copy(LoginRequest destRequestMsg) Performs a deep copy of LoginRequest object.
long	downloadConnectionConfig() downloadConnectionConfig - Indicates whether the Consumer desires connection information.
void	downloadConnectionConfig(long downloadConnectionConfig) downloadConnectionConfig - Indicates whether the Consumer desires connection information.
int	flags() The RDM Login request flags.
void	flags(int flags) The RDM Login request flags.
void	initDefaultRequest(int streamId) Initializes a LoginRequest, clearing it and filling in a typical userName, applicationName and position.
com.thomsonreuters.upa.codec.Buffer	instanceId() Returns instance id.
void	instanceId(com.thomsonreuters.upa.codec.Buffer instanceId) Sets instance id.
com.thomsonreuters.upa.codec.Buffer	password() The password.
long	role() Indicates the role of the application.
void	role(long role) Indicates the role of the application.
com.thomsonreuters.upa.codec.Buffer	userName() The userName that was used when sending the Login Request.
void	userName(com.thomsonreuters.upa.codec.Buffer userName) Sets userName for login to the user specified buffer.
int	userNameType() userNameType - The type of the userName that was used with the Login Refresh.Populated by Login.UserIdTypes
void	userNameType(int userNameType) userNameType - The type of the userName that was used with the Login Request.

Methods inherited from interface com.thomsonreuters.upa.valueadd.domainrep.rdm.login.LoginMsg

rdmMsgType, rdmMsgType

Methods inherited from interface com.thomsonreuters.upa.valueadd.domainrep.rdm.MsgBase

clear, decode, domainType, encode, streamId, streamId

Method Detail

flags

void flags(int flags)

The RDM Login request flags. Populated by LoginRequestFlags.

Parameters:

flags - the flags

flags

int flags()

The RDM Login request flags. Populated by LoginRequestFlags.

Returns:

flags

copy

int copy(LoginRequest destRequestMsg)

Performs a deep copy of LoginRequest object.

Parameters:

destRequestMsg - Message to copy login request object into. It cannot be null.

Returns:

UPA return value indicating success or failure of copy operation.

initDefaultRequest

void initDefaultRequest(int streamId)

Initializes a LoginRequest, clearing it and filling in a typical userName, applicationName and position.

Parameters:

streamId - the stream id

userName

com.thomsonreuters.upa.codec.Buffer userName()

The userName that was used when sending the Login Request.

Returns:

- User name buffer.

userName

void userName(com.thomsonreuters.upa.codec.Buffer userName)

Sets userName for login to the user specified buffer. Data and position of serviceName buffer will be set to passed in buffer's data and position. For TREP Authentication, this should contain the Authentication Token. Note that this creates garbage if buffer is backed by String object.

Parameters:

userName - the user name

userNameType

int userNameType()

userNameType - The type of the userName that was used with the Login Refresh.Populated by Login.UserIdTypes

Returns:

userNameType

userNameType

void userNameType(int userNameType)

userNameType - The type of the userName that was used with the Login Request. Populated by Login.UserIdTypes

Parameters:

userNameType - the user name type

checkHasUserNameType

boolean checkHasUserNameType()

Checks the presence of user name type. This flag can also be bulk-get by flags()

Returns:

true - if user name type is present, false - if not.

applyHasUserNameType

void applyHasUserNameType()

Applies user name type presence flag. This flag can also be bulk-set by flags(int)

checkPause

boolean checkPause()

Checks if login request is pause. Used by a Consumer to request that all open items on a channel be paused.

Returns:

true - if request has pause flag set, false - if pause flag is not set.

applyPause

void applyPause()

Applies pause flag to login request. Used by a Consumer to request that all open items on a channel be paused.

checkNoRefresh

boolean checkNoRefresh()

Checks if no refresh required flag is set. No Refresh flag indicates the Consumer or Non-Interactive provider does not require a refresh.

Returns:

true - NoRefresh request is true.

applyNoRefresh

void applyNoRefresh()

Applies no refresh required flag. No Refresh flag indicates the Consumer or Non-Interactive provider does not require a refresh.

attrib

void attrib(LoginAttrib attrib)

Sets login attrib information.

Parameters:

attrib - -login attrib.

attrib

LoginAttrib attrib()

Returns login attrib information.

Returns:

login attrib.

checkHasAttrib

boolean checkHasAttrib()

Checks the presence of attrib field. This flag can also be bulk-get by flags()

Returns:

true - if attrib field is present, false - if not.

applyHasAttrib

void applyHasAttrib()

Applies attrib presence flag. This flag can also be bulk-set by flags(int)

downloadConnectionConfig

long downloadConnectionConfig()

downloadConnectionConfig - Indicates whether the Consumer desires connection information. If available, a list of servers will be present in the serverList field of the LoginRefresh.

Returns:

downloadConnectionConfig

downloadConnectionConfig

void downloadConnectionConfig(long downloadConnectionConfig)

downloadConnectionConfig - Indicates whether the Consumer desires connection information. If available, a list of servers will be present in the serverList field of the LoginRefresh.

Parameters:

downloadConnectionConfig - the download connection config

checkHasDownloadConnectionConfig

boolean checkHasDownloadConnectionConfig()

Checks the presence of download connection config field. This flag can also be bulk-get by flags()

Returns:

true - if download connection config field is present, false - if not.

applyHasDownloadConnectionConfig

void applyHasDownloadConnectionConfig()

Applies download connection config presence flag. This flag can also be bulk-set by flags(int)

instanceId

com.thomsonreuters.upa.codec.Buffer instanceId()

Returns instance id. InstanceId can be used to differentiate applications running on the same machine.

Returns:

instanceId

instanceId

void instanceId(com.thomsonreuters.upa.codec.Buffer instanceId)

Sets instance id. InstanceId can be used to differentiate applications running on the same machine. Note that this creates garbage if buffer is backed by String object.

Parameters:

instanceId - the instance id

checkHasInstanceId

boolean checkHasInstanceId()

Checks the presence of instance id field. This flag can also be bulk-get by flags()

Returns:

true - if instance id field is present, false - if not.

applyHasInstanceId

void applyHasInstanceId()

Applies instance id presence flag. This flag can also be bulk-set by flags(int)

password

com.thomsonreuters.upa.codec.Buffer password()

The password.

Returns:

password

checkHasPassword

boolean checkHasPassword()

Checks the presence of password field. This flag can also be bulk-get by flags()

Returns:

true - if password is present, false - if not.

applyHasPassword

void applyHasPassword()

Applies password presence flag. This flag can also be bulk-set by flags(int)

role

long role()

Indicates the role of the application. Populated by Login.RoleTypes

Returns:

role of the application.

role

void role(long role)

Indicates the role of the application. Populated by Login.RoleTypes

Parameters:

role - of the application.

checkHasRole

boolean checkHasRole()

Checks the presence of application role field. This flag can also be bulk-get by flags()

Returns:

true - if application role field is present, false - if not.

applyHasRole

void applyHasRole()

Applies application role field flag. This flag can also be bulk-set by flags(int)

authenticationExtended

com.thomsonreuters.upa.codec.Buffer authenticationExtended()

Gets the authentication extended data. optionally used with the ElementNames.AUTHN_TOKEN login userNameType.

Returns:

authenticationExtended

authenticationExtended

void authenticationExtended(com.thomsonreuters.upa.codec.Buffer authenticationExtended)

Sets the authentication extended data. Optionally used with the ElementNames.AUTHN_TOKEN login userNameType.

Parameters:

authenticationExtended - the authentication extended

checkHasAuthenticationExtended

boolean checkHasAuthenticationExtended()

Checks the presence of the authenticationExtended data field. This flag can also be bulk-get by flags()

Returns:

true - if authenticationExtended data field is present, false - if not.

applyHasAuthenticationExtended

void applyHasAuthenticationExtended()

Applies authentication extendedData field flag. This flag can also be bulk-set by flags(int)