com.thomsonreuters.upa.valueadd.reactor

Class NIProviderRole

java.lang.Object

com.thomsonreuters.upa.valueadd.reactor.ReactorRole

com.thomsonreuters.upa.valueadd.reactor.NIProviderRole

public class NIProviderRole
extends ReactorRole

Class representing the role of an OMM Non-Interactive Provider.

See Also:

ReactorRole, ReactorRoleTypes

Constructor Summary

Constructors

Constructor and Description
NIProviderRole() Instantiates a new NI provider role.

Method Summary

Modifier and Type	Method and Description
void	initDefaultRDMDirectoryRefresh(java.lang.String serviceName, int serviceId) Initializes the RDM DirectoryRefresh 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.
DirectoryRefresh	rdmDirectoryRefresh() A Directory Refresh to be sent during the setup of a Non-Interactive Provider session.
void	rdmDirectoryRefresh(DirectoryRefresh directoryRefresh) A Directory Refresh to be sent during the setup of a Non-Interactive 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.

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

NIProviderRole

public NIProviderRole()

Instantiates a new NI provider 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 rdmLoginRequest

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.

rdmDirectoryRefresh

public void rdmDirectoryRefresh(DirectoryRefresh directoryRefresh)

A Directory Refresh to be sent during the setup of a Non-Interactive Provider session. This can be populated with a user's specific information or invoke initDefaultRDMDirectoryRefresh(String, int) to populate with default information. Requires LoginRequest to be set.

Parameters:

directoryRefresh - the directory refresh

rdmDirectoryRefresh

public DirectoryRefresh rdmDirectoryRefresh()

A Directory Refresh to be sent during the setup of a Non-Interactive Provider session. This can be populated with a user's specific information or invoke initDefaultRDMDirectoryRefresh(String, int) to populate with default information. Requires LoginRequest to be set.

Returns:

the rdmDirectoryRefresh

initDefaultRDMDirectoryRefresh

public void initDefaultRDMDirectoryRefresh(java.lang.String serviceName,
                                           int serviceId)

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

Parameters:

serviceName - the serviceName for this source directory refresh

serviceId - the serviceId for this source directory refresh

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