Package com.kristensoft.kdc

Class KristenHttpClientParameters.Builder

java.lang.Object

com.kristensoft.kdc.Parameters.Builder<T>

com.kristensoft.kdc.ClientParameters.Builder<KristenHttpClientParameters.Builder>

com.kristensoft.kdc.KristenHttpClientParameters.Builder

Enclosing class:

KristenHttpClientParameters

public static final class KristenHttpClientParameters.Builder
extends ClientParameters.Builder<KristenHttpClientParameters.Builder>

Builds KristenHttpClientParameters instances.

Constructor Summary

Constructors

Constructor	Description
Builder()	Creates a builder for configuring client parameters.

Method Summary

Modifier and Type	Method	Description
KristenHttpClientParameters.Builder	addEventHandler(KristenHttpClientEventHandler handler)	Adds an HTTP client event handler.
KristenHttpClientParameters.Builder	addEventHandlers(List<KristenHttpClientEventHandler> handlers)	Adds the specified HTTP client event handlers.
KristenHttpClientParameters	build()	Builds the HTTP client parameters.
KristenHttpClientParameters.Builder	withEventHandlers(List<KristenHttpClientEventHandler> handlers)	Replaces the configured HTTP client event handlers with the specified handlers.
KristenHttpClientParameters.Builder	withKeepAlive(Boolean keepAlive)	Sets whether HTTP keep-alive is enabled.
KristenHttpClientParameters.Builder	withMaxConnections(Integer maxConnections)	Sets the maximum number of HTTP connections.
KristenHttpClientParameters.Builder	withUrlString(String urlString)	Sets the URL used by the HTTP client.

Methods inherited from class com.kristensoft.kdc.ClientParameters.Builder

withRemoteAddress, withRemoteAddress, withRemoteAddress, withRemoteAddress, withSendSyncTimeout

Methods inherited from class com.kristensoft.kdc.Parameters.Builder

addWhiteListEntry, registerApi, registerApi, registerApis, withAutoStart, withBindAddress, withBindAddress, withBindAddress, withCompressed, withConnectionQueuePoolSize, withCrc, withEncryptionKey, withLatencyMode, withLatencyReportingInterval, withMaxReceivedBufferSize, withMaxSendBufferSize, withSerializationFormat, withWhiteList

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Creates a builder for configuring client parameters.

Method Detail

withUrlString

public KristenHttpClientParameters.Builder withUrlString(String urlString)

Sets the URL used by the HTTP client.

Parameters:

urlString - the HTTP client URL

Returns:

this builder

Throws:

IllegalArgumentException - if urlString is null, blank, or is not a valid URL

See Also:

Parameters.Defaults.DEFAULT_URI_STRING

addEventHandler

public KristenHttpClientParameters.Builder addEventHandler(KristenHttpClientEventHandler handler)

Adds an HTTP client event handler.

Parameters:

handler - the HTTP client event handler to add

Returns:

this builder

Throws:

IllegalArgumentException - if handler is null

addEventHandlers

public KristenHttpClientParameters.Builder addEventHandlers(List<KristenHttpClientEventHandler> handlers)

Adds the specified HTTP client event handlers.

Parameters:

handlers - the HTTP client event handlers to add

Returns:

this builder

Throws:

IllegalArgumentException - if handlers is null, empty, or contains a null handler

withEventHandlers

public KristenHttpClientParameters.Builder withEventHandlers(List<KristenHttpClientEventHandler> handlers)

Replaces the configured HTTP client event handlers with the specified handlers.

Parameters:

handlers - the HTTP client event handlers to use

Returns:

this builder

Throws:

IllegalArgumentException - if handlers is null, empty, or contains a null handler

withMaxConnections

public KristenHttpClientParameters.Builder withMaxConnections(Integer maxConnections)

Sets the maximum number of HTTP connections.

Parameters:

maxConnections - the maximum number of HTTP connections

Returns:

this builder

Throws:

IllegalArgumentException - if maxConnections is null or less than or equal to zero

withKeepAlive

public KristenHttpClientParameters.Builder withKeepAlive(Boolean keepAlive)

Sets whether HTTP keep-alive is enabled.

Parameters:

keepAlive - true to enable HTTP keep-alive; false to disable it

Returns:

this builder

Throws:

IllegalArgumentException - if keepAlive is null

build

public KristenHttpClientParameters build()

Builds the HTTP client parameters.

Specified by:

build in class ClientParameters.Builder<KristenHttpClientParameters.Builder>

Returns:

the configured HTTP client parameters