com.thomsonreuters.upa.valueadd.reactor

Class ConsumerRole

java.lang.Object

com.thomsonreuters.upa.valueadd.reactor.ReactorRole

com.thomsonreuters.upa.valueadd.reactor.ConsumerRole

public class ConsumerRole
extends ReactorRole

Class representing the role of an OMM Consumer.

See Also:

ReactorRole, ReactorRoleTypes

Constructor Summary

Constructors

Constructor and Description
ConsumerRole() Instantiates a new consumer role.

Method Summary

Modifier and Type	Method and Description
com.thomsonreuters.upa.codec.Buffer	clientId() Specifies an unique ID defined for an application making a request to the EDP token service.
int	clientId(com.thomsonreuters.upa.codec.Buffer clientId) Specifies an unique ID defined for an application making a request to the EDP token service.
int	dictionaryDownloadMode() Specifies the DictionaryDownloadModes.
void	dictionaryDownloadMode(int mode) Specifies the DictionaryDownloadModes.
RDMDictionaryMsgCallback	dictionaryMsgCallback() A callback function for processing RDMDictionaryMsgEvents received.
void	dictionaryMsgCallback(RDMDictionaryMsgCallback callback) A callback function for processing RDMDictionaryMsgEvents received.
RDMDirectoryMsgCallback	directoryMsgCallback() A callback function for processing RDMDirectoryMsgEvents received.
void	directoryMsgCallback(RDMDirectoryMsgCallback callback) A callback function for processing RDMDirectoryMsgEvents received.
void	initDefaultRDMDirectoryRequest() Initializes the RDM DirectoryRequest with default information.
void	initDefaultRDMLoginRequest() Initializes the RDM LoginRequest with default information.
RDMLoginMsgCallback	loginMsgCallback() A callback function for processing RDMLoginMsgEvents received.
void	loginMsgCallback(RDMLoginMsgCallback callback) A callback function for processing RDMLoginMsgEvents received.
DirectoryRequest	rdmDirectoryRequest() A Directory Request to be sent during the setup of a Consumer-Provider session.
void	rdmDirectoryRequest(DirectoryRequest directoryRequest) A Directory Request to be sent during the setup of a Consumer-Provider session.
LoginRequest	rdmLoginRequest() The LoginRequest to be sent during the connection establishment process.
void	rdmLoginRequest(LoginRequest loginRequest) The LoginRequest to be sent during the connection establishment process.
ConsumerWatchlistOptions	watchlistOptions() Options for using the watchlist.

Methods inherited from class com.thomsonreuters.upa.valueadd.reactor.ReactorRole

channelEventCallback, channelEventCallback, defaultMsgCallback, defaultMsgCallback, toString, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConsumerRole

public ConsumerRole()

Instantiates a new consumer role.

Method Detail

rdmLoginRequest

public void rdmLoginRequest(LoginRequest loginRequest)

The LoginRequest to be sent during the connection establishment process. This can be populated with a user's specific information or invoke initDefaultRDMLoginRequest() to populate with default information. If this parameter is left empty no login will be sent to the system; useful for systems that do not require a login.

Parameters:

loginRequest - the login request

rdmLoginRequest

public LoginRequest rdmLoginRequest()

The LoginRequest to be sent during the connection establishment process. This can be populated with a user's specific information or invoke initDefaultRDMLoginRequest() to populate with default information. If this parameter is left empty no login will be sent to the system; useful for systems that do not require a login.

Returns:

the loginRequest

initDefaultRDMLoginRequest

public void initDefaultRDMLoginRequest()

Initializes the RDM LoginRequest with default information. If the rdmLoginRequest has already been defined (due to a previous call to rdmLoginRequest(LoginRequest)) the rdmLoginRequest object will be reused.

rdmDirectoryRequest

public void rdmDirectoryRequest(DirectoryRequest directoryRequest)

A Directory Request to be sent during the setup of a Consumer-Provider session. This can be populated with a user's specific information or invoke initDefaultRDMDirectoryRequest() to populate with default information. Requires LoginRequest to be set.

Parameters:

directoryRequest - the directory request

rdmDirectoryRequest

public DirectoryRequest rdmDirectoryRequest()

A Directory Request to be sent during the setup of a Consumer-Provider session. This can be populated with a user's specific information or invoke initDefaultRDMDirectoryRequest() to populate with default information. Requires LoginRequest to be set.

Returns:

the directoryRequest

initDefaultRDMDirectoryRequest

public void initDefaultRDMDirectoryRequest()

Initializes the RDM DirectoryRequest with default information. If the rdmDirectoryRequest has already been defined (due to a previous call to rdmDirectoryRequest(DirectoryRequest)) the rdmDirectoryRequest object will be reused.

clientId

public int clientId(com.thomsonreuters.upa.codec.Buffer clientId)

Specifies an unique ID defined for an application making a request to the EDP token service. The RDMLoginRequest.userName variable is used if this member is not set. Optional.

Parameters:

clientId - the clientId

Returns:

ReactorReturnCodes.SUCCESS on success, if data is null, or if position or length is outside of the data's capacity. ReactorReturnCodes.PARAMETER_INVALID.

clientId

public com.thomsonreuters.upa.codec.Buffer clientId()

Specifies an unique ID defined for an application making a request to the EDP token service. The RDMLoginRequest.userName variable is used if this member is not set. Optional.

Returns:

clientId the clientId

dictionaryDownloadMode

public void dictionaryDownloadMode(int mode)

Specifies the DictionaryDownloadModes.

Parameters:

mode - A specific DictionaryDownloadModes

See Also:

DictionaryDownloadModes

dictionaryDownloadMode

public int dictionaryDownloadMode()

Specifies the DictionaryDownloadModes.

Returns:

the dictionaryDownloadMode

See Also:

DictionaryDownloadModes

loginMsgCallback

public void loginMsgCallback(RDMLoginMsgCallback callback)

A callback function for processing RDMLoginMsgEvents received. If not present, the received message will be passed to the defaultMsgCallback.

Parameters:

callback - the callback

See Also:

RDMLoginMsgCallback, RDMLoginMsgEvent

loginMsgCallback

public RDMLoginMsgCallback loginMsgCallback()

A callback function for processing RDMLoginMsgEvents received. If not present, the received message will be passed to the defaultMsgCallback.

Returns:

the loginMsgCallback

directoryMsgCallback

public void directoryMsgCallback(RDMDirectoryMsgCallback callback)

A callback function for processing RDMDirectoryMsgEvents received. If not present, the received message will be passed to the defaultMsgCallback.

Parameters:

callback - the callback

See Also:

RDMDirectoryMsgCallback, RDMDirectoryMsgEvent

directoryMsgCallback

public RDMDirectoryMsgCallback directoryMsgCallback()

A callback function for processing RDMDirectoryMsgEvents received. If not present, the received message will be passed to the defaultMsgCallback.

Returns:

the directoryMsgCallback

dictionaryMsgCallback

public void dictionaryMsgCallback(RDMDictionaryMsgCallback callback)

A callback function for processing RDMDictionaryMsgEvents received. If not present, the received message will be passed to the defaultMsgCallback.

Parameters:

callback - the callback

See Also:

RDMDictionaryMsgCallback, RDMDictionaryMsgEvent

dictionaryMsgCallback

public RDMDictionaryMsgCallback dictionaryMsgCallback()

A callback function for processing RDMDictionaryMsgEvents received. If not present, the received message will be passed to the defaultMsgCallback.

Returns:

the dictionaryMsgCallback

watchlistOptions

public ConsumerWatchlistOptions watchlistOptions()

Options for using the watchlist. Use to enable watchlist and set watchlist options for ConsumerRole.

Returns:

ConsumerRole watchlist options