com.thomsonreuters.upa.valueadd.reactor

Class ReactorServiceDiscoveryOptions

java.lang.Object

com.thomsonreuters.upa.valueadd.reactor.ReactorServiceDiscoveryOptions

public class ReactorServiceDiscoveryOptions
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
void	clear()
com.thomsonreuters.upa.codec.Buffer	clientId() Specifies the unique ID defined for an application making a request to the token service.
void	clientId(com.thomsonreuters.upa.codec.Buffer clientId) Specifies the unique ID defined for an application making a request to the token service.
int	copy(ReactorServiceDiscoveryOptions dest)
int	dataFormat() This is an optional parameter to specify the desired data format protocol to get service endpoints from the service discovery.
void	dataFormat(int dataFormat) This is an optional parameter to specify the desired data format protocol to get service endpoints from the service discovery.
com.thomsonreuters.upa.codec.Buffer	password() Returns the password for authorization with the token service
void	password(com.thomsonreuters.upa.codec.Buffer password) Specifies the password for authorization with the token service.
com.thomsonreuters.upa.codec.Buffer	proxyDomain() Returns the proxy domain of the user to authenticate.
void	proxyDomain(com.thomsonreuters.upa.codec.Buffer proxyDomain) Specifies the proxy domain of the user to authenticate.
com.thomsonreuters.upa.codec.Buffer	proxyHostName() Returns the address or hostname of the HTTP proxy server.
void	proxyHostName(com.thomsonreuters.upa.codec.Buffer proxyHostName) Specifies the address or hostname of the HTTP proxy server.
com.thomsonreuters.upa.codec.Buffer	proxyKRB5ConfigFile() Returns the complete path of the Keberos5 configuration file.
void	proxyKRB5ConfigFile(com.thomsonreuters.upa.codec.Buffer proxyKRB5ConfigFile) Specifies the complete path of the Keberos5 configuration file.
com.thomsonreuters.upa.codec.Buffer	proxyLocalHostName() Returns the proxy local hostname of the user to authenticate with NTLM protocol only.
void	proxyLocalHostName(com.thomsonreuters.upa.codec.Buffer proxyLocalHostName) Specifies the local hostname of the user to authenticate.
com.thomsonreuters.upa.codec.Buffer	proxyPassword() Returns the proxy password to authenticate.
void	proxyPassword(com.thomsonreuters.upa.codec.Buffer proxyPassword) Specifies the proxy password to authenticate.
com.thomsonreuters.upa.codec.Buffer	proxyPort() Returns the Port Number of the HTTP proxy server.
void	proxyPort(com.thomsonreuters.upa.codec.Buffer proxyPort) Specifies the Port Number of the HTTP proxy server.
com.thomsonreuters.upa.codec.Buffer	proxyUserName() Returns the proxy user name to authenticate.
void	proxyUserName(com.thomsonreuters.upa.codec.Buffer proxyUserName) Specifies the proxy user name to authenticate.
ReactorServiceEndpointEventCallback	reactorServiceEndpointEventCallback() A user specified object.
int	reactorServiceEndpointEventCallback(ReactorServiceEndpointEventCallback callback) Specifies a Reactor Service Endpoint Event Callback.
int	transport() This is an optional parameter to specify the desired transport protocol to get service endpoints from the service discovery.
void	transport(int transport) This is an optional parameter to specify the desired transport protocol to get service endpoints from the service discovery.
com.thomsonreuters.upa.codec.Buffer	userName() Returns the user name for authorization with the token service
void	userName(com.thomsonreuters.upa.codec.Buffer userName) Specifies the user name for authorization with the token service
int	userSpecObj(java.lang.Object userSpecObj) Specifies a user defined object.
java.lang.Object	userSpecObject() A user specified object.

Methods inherited from class java.lang.Object

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

Method Detail

clear

public void clear()

copy

public int copy(ReactorServiceDiscoveryOptions dest)

userName

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

Specifies the user name for authorization with the token service

Parameters:

userName - the username.

userName

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

Returns the user name for authorization with the token service

Returns:

the userName

password

public void password(com.thomsonreuters.upa.codec.Buffer password)

Specifies the password for authorization with the token service.

Parameters:

password - the password.

password

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

Returns the password for authorization with the token service

Returns:

the password

clientId

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

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

Parameters:

clientId - the client Id

clientId

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

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

Returns:

clientId.

transport

public void transport(int transport)

This is an optional parameter to specify the desired transport protocol to get service endpoints from the service discovery.

Parameters:

transport - protocol

transport

public int transport()

This is an optional parameter to specify the desired transport protocol to get service endpoints from the service discovery.

Returns:

transport protocol

dataFormat

public void dataFormat(int dataFormat)

This is an optional parameter to specify the desired data format protocol to get service endpoints from the service discovery.

Parameters:

dataFormat - the data format

dataFormat

public int dataFormat()

This is an optional parameter to specify the desired data format protocol to get service endpoints from the service discovery.

Returns:

dataFormat

proxyHostName

public void proxyHostName(com.thomsonreuters.upa.codec.Buffer proxyHostName)

Specifies the address or hostname of the HTTP proxy server.

Parameters:

proxyHostName - the proxy hostname.

proxyHostName

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

Returns the address or hostname of the HTTP proxy server.

Returns:

the proxy hostname.

proxyPort

public void proxyPort(com.thomsonreuters.upa.codec.Buffer proxyPort)

Specifies the Port Number of the HTTP proxy server.

Parameters:

proxyPort - the proxy port.

proxyPort

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

Returns the Port Number of the HTTP proxy server.

Returns:

the proxy port

proxyUserName

public void proxyUserName(com.thomsonreuters.upa.codec.Buffer proxyUserName)

Specifies the proxy user name to authenticate.

Parameters:

proxyUserName - the proxy user name.

proxyUserName

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

Returns the proxy user name to authenticate.

Returns:

the proxy user name.

proxyPassword

public void proxyPassword(com.thomsonreuters.upa.codec.Buffer proxyPassword)

Specifies the proxy password to authenticate.

Parameters:

proxyPassword - the proxy password.

proxyPassword

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

Returns the proxy password to authenticate.

Returns:

the proxy password.

proxyDomain

public void proxyDomain(com.thomsonreuters.upa.codec.Buffer proxyDomain)

Specifies the proxy domain of the user to authenticate.

Parameters:

proxyDomain - the proxy domain.

proxyDomain

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

Returns the proxy domain of the user to authenticate.

Returns:

the proxy domain.

proxyLocalHostName

public void proxyLocalHostName(com.thomsonreuters.upa.codec.Buffer proxyLocalHostName)

Specifies the local hostname of the user to authenticate.

Parameters:

proxyLocalHostName - the local hostname.

proxyLocalHostName

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

Returns the proxy local hostname of the user to authenticate with NTLM protocol only.

Returns:

the local hostname.

proxyKRB5ConfigFile

public void proxyKRB5ConfigFile(com.thomsonreuters.upa.codec.Buffer proxyKRB5ConfigFile)

Specifies the complete path of the Keberos5 configuration file.

Needed for Negotiate/Kerberos and Kerberos authentications.

Parameters:

proxyKRB5ConfigFile - the Keberos5 configuration file.

proxyKRB5ConfigFile

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

Returns the complete path of the Keberos5 configuration file.

Returns:

the Keberos5 configuration file.

reactorServiceEndpointEventCallback

public int reactorServiceEndpointEventCallback(ReactorServiceEndpointEventCallback callback)

Specifies a Reactor Service Endpoint Event Callback.

Parameters:

callback - the reactor service endpoint event callback.

Returns:

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

reactorServiceEndpointEventCallback

public ReactorServiceEndpointEventCallback reactorServiceEndpointEventCallback()

A user specified object.

Returns:

the ReactorServiceEndpointEventCallback

userSpecObj

public int userSpecObj(java.lang.Object userSpecObj)

Specifies a user defined object.

Parameters:

userSpecObj - the userSpecObj

Returns:

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

userSpecObject

public java.lang.Object userSpecObject()

A user specified object.

Returns:

the userSpecObject