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

Interface LoginStatus

All Superinterfaces:

LoginMsg, MsgBase

public interface LoginStatus
extends LoginMsg

The RDM Login Status. Used by an OMM Provider to indicate changes to the Login stream.

See Also:

LoginMsg

Method Summary

Modifier and Type	Method and Description
void	applyClearCache() Applies clear cache flag.
void	applyHasAuthenticationErrorCode() Applies authenticationErrorCode field flag.
void	applyHasAuthenticationErrorText() Applies authenticationErrorText field flag.
void	applyHasState() Applies state presence flag.
void	applyHasUserName() userName - Applies user name presence flag.
void	applyHasUserNameType() Applies user name type presence flag.
long	authenticationErrorCode() Returns the authentication error code.
void	authenticationErrorCode(long authenticationErrorCode) Sets the authentication error code.
com.thomsonreuters.upa.codec.Buffer	authenticationErrorText() Returns the authentication error text.
void	authenticationErrorText(com.thomsonreuters.upa.codec.Buffer authenticationErrorText) Sets the authentication error text.
boolean	checkClearCache() Checks the presence of clear cache flag.
boolean	checkHasAuthenticationErrorCode() Checks the presence of the authentication error code field.
boolean	checkHasAuthenticationErrorText() Checks the presence of the authentication error text field.
boolean	checkHasState() Checks the presence of state field.
boolean	checkHasUserName() Checks the presence of user name field.
boolean	checkHasUserNameType() Checks the presence of user name type field.
int	copy(LoginStatus destStatusMsg) Performs a deep copy of LoginStatus object.
int	flags() The RDM Login Status flags.
void	flags(int flags) The RDM Login Status flags.
com.thomsonreuters.upa.codec.State	state() The current state of the login stream.
com.thomsonreuters.upa.codec.Buffer	userName() userName - The userName that was used when sending the Login Status.
void	userName(com.thomsonreuters.upa.codec.Buffer userName) Sets userName for login to the user specified buffer.
int	userNameType() nameType - The type of the userName that was used with the Login Status.
void	userNameType(int nameType) nameType - The type of the userName that was used with the Login Request.Populated by Login.UserIdTypes

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 Status flags. Populated by LoginStatusFlags.

Parameters:

flags - the flags

flags

int flags()

The RDM Login Status flags. Populated by LoginStatusFlags.

Returns:

flags

copy

int copy(LoginStatus destStatusMsg)

Performs a deep copy of LoginStatus object.

Parameters:

destStatusMsg - Message to copy login status object into. It cannot be null.

Returns:

UPA return value indicating success or failure of copy operation.

userName

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

userName - The userName that was used when sending the Login Status.

Returns:

- userName

userName

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

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

Parameters:

userName - the user name

checkHasUserName

boolean checkHasUserName()

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

Returns:

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

applyHasUserName

void applyHasUserName()

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

userNameType

int userNameType()

nameType - The type of the userName that was used with the Login Status. Populated by Login.UserIdTypes

Returns:

nameType

userNameType

void userNameType(int nameType)

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

Parameters:

nameType - the name type

checkHasUserNameType

boolean checkHasUserNameType()

Checks the presence of user name type field. 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)

state

com.thomsonreuters.upa.codec.State state()

The current state of the login stream.

Returns:

state.

checkHasState

boolean checkHasState()

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

Returns:

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

applyHasState

void applyHasState()

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

checkClearCache

boolean checkClearCache()

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

Returns:

true - if exists; false if does not exist.

applyClearCache

void applyClearCache()

Applies clear cache flag. This flag can also be bulk-set by flags(int)

authenticationErrorCode

void authenticationErrorCode(long authenticationErrorCode)

Sets the authentication error code. Used with the ElementNames.AUTHN_TOKEN login userNameType.

Parameters:

authenticationErrorCode - the authentication error code

authenticationErrorCode

long authenticationErrorCode()

Returns the authentication error code. Used with the ElementNames.AUTHN_TOKEN login userNameType.

Returns:

authenticationErrorCode

checkHasAuthenticationErrorCode

boolean checkHasAuthenticationErrorCode()

Checks the presence of the authentication error code field. Used with the ElementNames.AUTHN_TOKEN login userNameType. This flag can also be bulk-get by flags()

Returns:

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

applyHasAuthenticationErrorCode

void applyHasAuthenticationErrorCode()

Applies authenticationErrorCode field flag. Used with the ElementNames.AUTHN_TOKEN login userNameType. This flag can also be bulk-set by flags(int)

authenticationErrorText

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

Sets the authentication error text. Used with the ElementNames.AUTHN_TOKEN login userNameType.

Parameters:

authenticationErrorText - the authentication error text

authenticationErrorText

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

Returns the authentication error text. Used with the ElementNames.AUTHN_TOKEN login userNameType.

Returns:

authenticationErrorText

checkHasAuthenticationErrorText

boolean checkHasAuthenticationErrorText()

Checks the presence of the authentication error text field. Used with the ElementNames.AUTHN_TOKEN login userNameType. This flag can also be bulk-get by flags()

Returns:

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

applyHasAuthenticationErrorText

void applyHasAuthenticationErrorText()

Applies authenticationErrorText field flag. Used with the ElementNames.AUTHN_TOKEN login userNameType. This flag can also be bulk-set by flags(int)