com.guardtime.ksi.service.client.http

Class HttpClientSettings

java.lang.Object

com.guardtime.ksi.service.client.http.AbstractHttpClientSettings

com.guardtime.ksi.service.client.http.HttpClientSettings

public class HttpClientSettings
extends AbstractHttpClientSettings

KSI client settings for HTTP endpoint.

HTTP Service settings consist of three URLs and connections parameters:

• signingUrl - URL of KSI gateway for signing requests,
• extendingUrl - URL of KSI extender for extending requests,
• publicationsFileUrl - URL of online publications file.

Connection parameters hold HTTP connection settings like timeouts and proxy configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpClientSettings.HTTPConnectionParameters Contains low level connection parameters for HTTP service.

Constructor Summary

Constructors

Constructor and Description
HttpClientSettings(String signingUrl, String extendingUrl, String publicationsFileUrl, ServiceCredentials credentials) Creates HTTP service settings with provided parameters.
HttpClientSettings(String signingUrl, String extendingUrl, String publicationsFileUrl, ServiceCredentials credentials, PduVersion pduVersion) Creates HTTP service settings with provided parameters.

Method Summary

Modifier and Type	Method and Description
int	getConnectionTimeout() Determines the timeout in milliseconds until a connection is established.
ServiceCredentials	getCredentials()
URL	getExtendingUrl()
HttpClientSettings.HTTPConnectionParameters	getParameters()
PduVersion	getPduVersion()
String	getProxyPassword()
URL	getProxyUrl()
String	getProxyUser()
URL	getPublicationsFileUrl()
int	getReadTimeout() Defines the socket read timeout in milliseconds, which is the timeout for waiting for data or a maximum period inactivity between two consecutive data packets.
URL	getSigningUrl()
void	setParameters(HttpClientSettings.HTTPConnectionParameters parameters) Set connection parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientSettings

public HttpClientSettings(String signingUrl,
                          String extendingUrl,
                          String publicationsFileUrl,
                          ServiceCredentials credentials)

Creates HTTP service settings with provided parameters.

Parameters:

signingUrl - URL of KSI gateway for signing requests.

extendingUrl - URL of KSI extender for extending requests.

publicationsFileUrl - URL of online publications file.

credentials - service credentials.

HttpClientSettings

public HttpClientSettings(String signingUrl,
                          String extendingUrl,
                          String publicationsFileUrl,
                          ServiceCredentials credentials,
                          PduVersion pduVersion)

Creates HTTP service settings with provided parameters.

Parameters:

signingUrl - URL of KSI gateway for signing requests.

extendingUrl - URL of KSI extender for extending requests.

publicationsFileUrl - URL of online publications file.

credentials - service credentials.

pduVersion - version of PDU to use.

Method Detail

getSigningUrl

public URL getSigningUrl()

Specified by:

getSigningUrl in class AbstractHttpClientSettings

Returns:

The signing service URL.

See Also:

AbstractHttpClientSettings.getSigningUrl()

getExtendingUrl

public URL getExtendingUrl()

Specified by:

getExtendingUrl in class AbstractHttpClientSettings

Returns:

The extender service URL.

See Also:

AbstractHttpClientSettings.getExtendingUrl()

getPublicationsFileUrl

public URL getPublicationsFileUrl()

Specified by:

getPublicationsFileUrl in class AbstractHttpClientSettings

Returns:

The publications file URL.

See Also:

AbstractHttpClientSettings.getPublicationsFileUrl()

getCredentials

public ServiceCredentials getCredentials()

Specified by:

getCredentials in class AbstractHttpClientSettings

Returns:

The service credentials.

See Also:

AbstractHttpClientSettings.getPublicationsFileUrl()

getProxyUrl

public URL getProxyUrl()

Overrides:

getProxyUrl in class AbstractHttpClientSettings

Returns:

The proxy URL. By default proxy isn't used and null is returned.

See Also:

AbstractHttpClientSettings.getProxyUrl()

getProxyUser

public String getProxyUser()

Overrides:

getProxyUser in class AbstractHttpClientSettings

Returns:

The proxy username. By default proxy isn't used and null is returned.

See Also:

AbstractHttpClientSettings.getProxyUser()

getProxyPassword

public String getProxyPassword()

Overrides:

getProxyPassword in class AbstractHttpClientSettings

Returns:

The proxy user password. By default proxy isn't used and null is returned.

See Also:

AbstractHttpClientSettings.getProxyPassword()

getConnectionTimeout

public int getConnectionTimeout()

Description copied from class: AbstractHttpClientSettings

Determines the timeout in milliseconds until a connection is established.

A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default).

Default value is -1.

Overrides:

getConnectionTimeout in class AbstractHttpClientSettings

Returns:

Connection timeout in milliseconds as int.

See Also:

AbstractHttpClientSettings.getConnectionTimeout()

getReadTimeout

public int getReadTimeout()

Description copied from class: AbstractHttpClientSettings

Defines the socket read timeout in milliseconds, which is the timeout for waiting for data or a maximum period inactivity between two consecutive data packets.

A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default).

Default value is -1.

Overrides:

getReadTimeout in class AbstractHttpClientSettings

Returns:

Read timeout in milliseconds as int.

See Also:

AbstractHttpClientSettings.getReadTimeout()

getPduVersion

public PduVersion getPduVersion()

Specified by:

getPduVersion in class AbstractHttpClientSettings

Returns:

The PDU version.

getParameters

public HttpClientSettings.HTTPConnectionParameters getParameters()

Returns:

Connection parameters.

setParameters

public void setParameters(HttpClientSettings.HTTPConnectionParameters parameters)

Set connection parameters.

Parameters:

parameters - HTTP connection parameters.