com.thomsonreuters.upa.valueadd.reactor

Class ReactorConnectInfo

java.lang.Object

com.thomsonreuters.upa.valueadd.reactor.ReactorConnectInfo

public class ReactorConnectInfo
extends java.lang.Object

Reactor connection information for use in ReactorConnectOptions.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears this object for reuse.
com.thomsonreuters.upa.transport.ConnectOptions	connectOptions() Returns the ConnectOptions, which is the ConnectOptions associated with the underlying Transport.connect method.
int	copy(ReactorConnectInfo destInfo) This method will perform a deep copy into the passed in parameter's members from the ReactorConnectInfo calling this method.
boolean	enableSessionManagement() If true, the channel will get access token and refresh it on behalf of users to keep session active.
void	enableSessionManagement(boolean enableSessionManagement) If set to true, enable to get access token and refresh it on behalf of users to keep session active.
int	initTimeout() Returns the initialization timeout value.
int	initTimeout(int timeout) The amount of time (in seconds) to wait for the successful initialization of a ReactorChannel.
java.lang.String	location() Specifies the location to get a service endpoint to establish a connection with service provider.
void	location(java.lang.String location) Specifies the location to get a service endpoint to establish a connection with service provider.
ReactorAuthTokenEventCallback	reactorAuthTokenEventCallback() A callback function for processing AuthTokenEvents received.
int	reactorAuthTokenEventCallback(ReactorAuthTokenEventCallback callback) Specifies a Callback function that receives ReactorAuthTokenEvents.

Methods inherited from class java.lang.Object

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

Method Detail

connectOptions

public com.thomsonreuters.upa.transport.ConnectOptions connectOptions()

Returns the ConnectOptions, which is the ConnectOptions associated with the underlying Transport.connect method. This includes information about the host or network to connect to, the type of connection to use, and other transport specific configuration information. This is described in more detail in the UPA Developers Guide.

Returns:

the ConnectOptions

initTimeout

public int initTimeout(int timeout)

The amount of time (in seconds) to wait for the successful initialization of a ReactorChannel. If initialization does not complete in time, an event is dispatched to the application to indicate that the ReactorChannel is down. Timeout must be greater than zero. Default is 60 seconds.

Parameters:

timeout - the initialization timeout in seconds

Returns:

ReactorReturnCodes.SUCCESS if the timeout is valid, otherwise ReactorReturnCodes.PARAMETER_OUT_OF_RANGE if the timeout is out of range

initTimeout

public int initTimeout()

Returns the initialization timeout value.

Returns:

the initialization timeout value

clear

public void clear()

Clears this object for reuse.

copy

public int copy(ReactorConnectInfo destInfo)

This method will perform a deep copy into the passed in parameter's members from the ReactorConnectInfo calling this method.

Parameters:

destInfo - the value getting populated with the values of the calling ReactorConnectInfo

Returns:

ReactorReturnCodes.SUCCESS on success, ReactorReturnCodes.FAILURE if the destInfo is null.

reactorAuthTokenEventCallback

public int reactorAuthTokenEventCallback(ReactorAuthTokenEventCallback callback)

Specifies a Callback function that receives ReactorAuthTokenEvents. The token is requested by the Reactor for Consumer(disabling watchlist) and NiProvider applications to send login request and reissue with the token.

Parameters:

callback - the auth token event callback.

Returns:

ReactorReturnCodes.SUCCESS if the callback is not null, otherwise ReactorReturnCodes.PARAMETER_INVALID.

See Also:

ReactorAuthTokenEventCallback, ReactorAuthTokenEvent

reactorAuthTokenEventCallback

public ReactorAuthTokenEventCallback reactorAuthTokenEventCallback()

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

Returns:

the reactorAuthTokenEventCallback

See Also:

ReactorAuthTokenEventCallback, ReactorAuthTokenEvent

enableSessionManagement

public void enableSessionManagement(boolean enableSessionManagement)

If set to true, enable to get access token and refresh it on behalf of users to keep session active.

Parameters:

enableSessionManagement - enables session management

enableSessionManagement

public boolean enableSessionManagement()

If true, the channel will get access token and refresh it on behalf of users to keep session active.

Returns:

the enableSessionManagement

location

public void location(java.lang.String location)

Specifies the location to get a service endpoint to establish a connection with service provider. Defaults to "us-east if not specified. The Reactor always uses the endpoint which provides two available zones for the location.

Parameters:

location - specifies the location endpoint

location

public java.lang.String location()

Specifies the location to get a service endpoint to establish a connection with service provider. Defaults to "us-east if not specified. The Reactor always uses the endpoint which provides two available zones for the location.

Returns:

the location of the endpoint