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

Interface LoginRefresh

All Superinterfaces:

LoginMsg, MsgBase

public interface LoginRefresh
extends LoginMsg

The RDM Login Refresh. This message is used to respond to a Login Request message after the user's login is accepted.

See Also:

LoginMsg, LoginRefreshFlags

Method Summary

Modifier and Type	Method and Description
void	applyClearCache() Applies clear cache flag.
void	applyHasAttrib() Applies attrib presence flag.
void	applyHasAuthenticationErrorCode() Applies authenticationErrorCode field flag.
void	applyHasAuthenticationErrorText() Applies authenticationErrorText field flag.
void	applyHasAuthenticationExtendedResp() Applies authenticationExtendedResp field flag.
void	applyHasAuthenticationTTReissue() Applies authenticationTTReissue field flag.
void	applyHasConnectionConfig() Applies connectionConfig presence flag.
void	applyHasFeatures() Applies features presence flag.
void	applyHasSequenceNumber() Applies sequenceNumber presence flag.
void	applyHasUserName() Applies user name presence flag.
void	applyHasUserNameType() Applies user name type presence flag.
void	applySolicited() Applies solicited flag.
LoginAttrib	attrib() Returns login attrib information.
void	attrib(LoginAttrib attrib) Sets login attrib information.
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.
com.thomsonreuters.upa.codec.Buffer	authenticationExtendedResp() Returns the authentication extended data response.
void	authenticationExtendedResp(com.thomsonreuters.upa.codec.Buffer authenticationExtendedResp) Sets the authentication extended response field.
long	authenticationTTReissue() Returns the authentication time to reissue in seconds.
void	authenticationTTReissue(long authenticationTTReissue) Sets the authentication time to reissue in seconds.
boolean	checkClearCache() Checks the presence of clear cache flag.
boolean	checkHasAttrib() Checks the presence of attrib field.
boolean	checkHasAuthenticationErrorCode() Checks the presence of the authentication error code field.
boolean	checkHasAuthenticationErrorText() Checks the presence of the authentication error text field.
boolean	checkHasAuthenticationExtendedResp() Checks the presence of the optional authentication extended response field.
boolean	checkHasAuthenticationTTReissue() Checks the presence of the authentication time to reissue field.
boolean	checkHasConnectionConfig() Checks the presence of connectionConfig member.
boolean	checkHasFeatures() Checks the presence of features member.
boolean	checkHasSequenceNumber() Checks the presence of sequenceNumber field.
boolean	checkHasUserName() Checks the presence of user name field.
boolean	checkHasUserNameType() Checks the presence of user name type field.
boolean	checkSolicited() Checks the presence of solicited flag.
LoginConnectionConfig	connectionConfig() Returns connection config information.
void	connectionConfig(LoginConnectionConfig connectionConfig) Sets connection config information.
int	copy(LoginRefresh destRefreshMsg) Performs a deep copy of LoginRefresh object.
LoginSupportFeatures	features() Returns the set of features provider of this login refresh message supports.
void	features(LoginSupportFeatures features) Sets the set of features provider of this login refresh message supports.
int	flags() The RDM Login refresh flags.
void	flags(int flags) The RDM Login refresh flags.
long	sequenceNumber() sequenceNumber - The sequence number of this message.
void	sequenceNumber(long sequenceNumber) sequenceNumber - The sequence number of this message.
com.thomsonreuters.upa.codec.State	state() Returns the current state of the login stream.
void	state(com.thomsonreuters.upa.codec.State state) Sets state - current state of the login stream.
com.thomsonreuters.upa.codec.Buffer	userName() Returns userName that was used when sending the Login refresh.
void	userName(com.thomsonreuters.upa.codec.Buffer userName) Sets userName for login to the user specified buffer.
int	userNameType() The type of the userName that was used with the Login Refresh.
void	userNameType(int userNameType) 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 refresh flags. Populated by LoginRefreshFlags.

Parameters:

flags - the flags

flags

int flags()

The RDM Login refresh flags. Populated by LoginRefreshFlags.

Returns:

flags

copy

int copy(LoginRefresh destRefreshMsg)

Performs a deep copy of LoginRefresh object.

Parameters:

destRefreshMsg - Message to copy login refresh object into. It cannot be null.

Returns:

UPA return value indicating success or failure of copy operation.

userName

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

Returns userName that was used when sending the Login refresh.

Returns:

- User name buffer. While encoding, this buffer can be populated with the value to be encoded.

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. This flag can also be bulk-get by flags()

Returns:

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

applyHasUserName

void applyHasUserName()

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

userNameType

int userNameType()

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

Returns:

user name type.

userNameType

void userNameType(int userNameType)

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

Parameters:

userNameType - - user 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()

Returns the current state of the login stream.

Returns:

state

state

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

Sets state - current state of the login stream.

Parameters:

state - the state

sequenceNumber

long sequenceNumber()

sequenceNumber - The sequence number of this message.

Returns:

sequenceNumber

sequenceNumber

void sequenceNumber(long sequenceNumber)

sequenceNumber - The sequence number of this message.

Parameters:

sequenceNumber - the sequence number

checkHasSequenceNumber

boolean checkHasSequenceNumber()

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

Returns:

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

applyHasSequenceNumber

void applyHasSequenceNumber()

Applies sequenceNumber 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)

applySolicited

void applySolicited()

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

checkSolicited

boolean checkSolicited()

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

Returns:

true, if successful

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)

features

void features(LoginSupportFeatures features)

Sets the set of features provider of this login refresh message supports.

Parameters:

features - -set of provided features.

features

LoginSupportFeatures features()

Returns the set of features provider of this login refresh message supports.

Returns:

features -set of provided features.

checkHasFeatures

boolean checkHasFeatures()

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

Returns:

true - if features member is present, false - if not.

applyHasFeatures

void applyHasFeatures()

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

connectionConfig

void connectionConfig(LoginConnectionConfig connectionConfig)

Sets connection config information.

Parameters:

connectionConfig - the connection config

connectionConfig

LoginConnectionConfig connectionConfig()

Returns connection config information.

Returns:

connectionConfig.

checkHasConnectionConfig

boolean checkHasConnectionConfig()

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

Returns:

true - if connectionConfig member is present, false - if not.

applyHasConnectionConfig

void applyHasConnectionConfig()

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

authenticationTTReissue

void authenticationTTReissue(long authenticationTTReissue)

Sets the authentication time to reissue in seconds. Used with the ElementNames.AUTHN_TOKEN login userNameType.

Parameters:

authenticationTTReissue - the authentication TT reissue

authenticationTTReissue

long authenticationTTReissue()

Returns the authentication time to reissue in seconds. Used with the ElementNames.AUTHN_TOKEN login userNameType.

Returns:

authenticationTTReissue

checkHasAuthenticationTTReissue

boolean checkHasAuthenticationTTReissue()

Checks the presence of the authentication time to reissue field. This flag can also be bulk-get by flags()

Returns:

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

applyHasAuthenticationTTReissue

void applyHasAuthenticationTTReissue()

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

authenticationExtendedResp

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

Sets the authentication extended response field. Used with the ElementNames.AUTHN_TOKEN login userNameType.

Parameters:

authenticationExtendedResp - the authentication extended resp

authenticationExtendedResp

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

Returns the authentication extended data response. Used with the ElementNames.AUTHN_TOKEN login userNameType.

Returns:

authenticationExtendedResp

checkHasAuthenticationExtendedResp

boolean checkHasAuthenticationExtendedResp()

Checks the presence of the optional authentication extended response field. This flag can also be bulk-get by flags()

Returns:

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

applyHasAuthenticationExtendedResp

void applyHasAuthenticationExtendedResp()

Applies authenticationExtendedResp field 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. 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. 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. 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. This flag can also be bulk-set by flags(int)