com.guardtime.ksi.service.tcp

Class TCPClientSettings

java.lang.Object

com.guardtime.ksi.service.tcp.TCPClientSettings

public class TCPClientSettings
extends Object

Holds all the properties needed to configure the TCPClient. IMPORTANT!

When constructing the instance with a InetSocketAddress the IP of the endpoint is cached in this object. This can result to connection problems.

For use cases where this can be a problem we suggest using the constructor that takes the endpoint URI as a string.

Constructor Summary

Constructors

Constructor and Description
TCPClientSettings(InetSocketAddress endpoint, int tcpTransactionTimeoutSec, ServiceCredentials serviceCredentials) Settings for TCP client.
TCPClientSettings(InetSocketAddress endpoint, int tcpTransactionTimeoutSec, ServiceCredentials serviceCredentials, PduVersion pduVersion)
TCPClientSettings(String uri, int tcpTransactionTimeoutSec, ServiceCredentials serviceCredentials, PduVersion pduVersion) Settings for TCP client.

Method Summary

Modifier and Type	Method and Description
InetSocketAddress	getEndpoint() Returns either the InetSocketAddress provided to the constructor or a new instance for every invocation based on the String provided to the constructor.
PduVersion	getPduVersion()
ServiceCredentials	getServiceCredentials()
int	getTcpTransactionTimeoutSec()

Methods inherited from class java.lang.Object

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

Constructor Detail

TCPClientSettings

public TCPClientSettings(InetSocketAddress endpoint,
                         int tcpTransactionTimeoutSec,
                         ServiceCredentials serviceCredentials)

Settings for TCP client.

Parameters:

endpoint - TCP gateway endpoint address.

serviceCredentials - credentials for authenticating the client to the TCP gateway.

tcpTransactionTimeoutSec - maximum time in seconds when a TCP transaction should time out from initiating the connection to receiving the whole response.

TCPClientSettings

public TCPClientSettings(InetSocketAddress endpoint,
                         int tcpTransactionTimeoutSec,
                         ServiceCredentials serviceCredentials,
                         PduVersion pduVersion)

TCPClientSettings

public TCPClientSettings(String uri,
                         int tcpTransactionTimeoutSec,
                         ServiceCredentials serviceCredentials,
                         PduVersion pduVersion)
                  throws IllegalArgumentException

Settings for TCP client. The created TCPClientSettings instance constructs a new InetSocketAddress for every getEndpoint() call.

Parameters:

uri - string containing the URI of endpoint. Must be in format: <protocol>://<host>:<port>

tcpTransactionTimeoutSec - maximum time in seconds when a TCP transaction should time out from initiating the connection to receiving the whole response.

serviceCredentials - credentials for authenticating the client to the TCP gateway.

pduVersion - PDU version used for communication.

Throws:

IllegalArgumentException

Method Detail

getEndpoint

public InetSocketAddress getEndpoint()

Returns either the InetSocketAddress provided to the constructor or a new instance for every invocation based on the String provided to the constructor.

Returns:

An instance of InetSocketAddress.

getTcpTransactionTimeoutSec

public int getTcpTransactionTimeoutSec()

getServiceCredentials

public ServiceCredentials getServiceCredentials()

getPduVersion

public PduVersion getPduVersion()