Package org.infinispan.client.rest.configuration

Class RestClientConfigurationBuilder

java.lang.Object

org.infinispan.client.rest.configuration.RestClientConfigurationBuilder

All Implemented Interfaces:

RestClientConfigurationChildBuilder, org.infinispan.commons.configuration.Builder<RestClientConfiguration>

public class RestClientConfigurationBuilder
extends Object
implements RestClientConfigurationChildBuilder, org.infinispan.commons.configuration.Builder<RestClientConfiguration>

ConfigurationBuilder used to generate immutable RestClientConfiguration objects.

If you prefer to configure the client declaratively, see org.infinispan.client.rest.configuration

Since:

10.0

Author:

Tristan Tarrant

Constructor Summary

Constructors

Constructor	Description
RestClientConfigurationBuilder()

Method Summary

Modifier and Type	Method	Description
ServerConfigurationBuilder	addServer()	Adds a new remote server
RestClientConfigurationBuilder	addServers(String servers)	Adds a list of remote servers in the form: host1[:port][;host2[:port]]...
org.infinispan.commons.configuration.attributes.AttributeSet	attributes()
RestClientConfiguration	build()	Builds a configuration object
RestClientConfiguration	build(boolean validate)
RestClientConfigurationBuilder	clearServers()
RestClientConfigurationBuilder	connectionTimeout(long connectionTimeout)	This property defines the maximum socket connect timeout before giving up connecting to the server.
RestClientConfigurationBuilder	contextPath(String contextPath)
RestClientConfiguration	create()
RestClientConfigurationBuilder	followRedirects(boolean followRedirects)
RestClientConfigurationBuilder	header(String name, String value)
RestClientConfigurationBuilder	priorKnowledge(boolean enabled)	Configure the client to use Prior Knowledge
RestClientConfigurationBuilder	protocol(Protocol protocol)	Selects the protocol used by the client.
RestClientConfigurationBuilder	read(RestClientConfiguration template)
SecurityConfigurationBuilder	security()	Security Configuration
List<ServerConfigurationBuilder>	servers()
RestClientConfigurationBuilder	socketTimeout(long socketTimeout)	This property defines the maximum socket read timeout in milliseconds before giving up waiting for bytes from the server.
RestClientConfigurationBuilder	tcpKeepAlive(boolean keepAlive)	Affects TCP KEEPALIVE on the TCP stack.
RestClientConfigurationBuilder	tcpNoDelay(boolean tcpNoDelay)	Affects TCP NODELAY on the TCP stack.
RestClientConfigurationBuilder	uri(String uri)
RestClientConfigurationBuilder	uri(URI uri)
void	validate()
RestClientConfigurationBuilder	withProperties(Properties properties)	Configures this builder using the specified properties.

Methods inherited from class java.lang.Object

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

Constructor Details

RestClientConfigurationBuilder

public RestClientConfigurationBuilder()

Method Details

attributes

public org.infinispan.commons.configuration.attributes.AttributeSet attributes()

Specified by:

attributes in interface org.infinispan.commons.configuration.Builder<RestClientConfiguration>

addServer

public ServerConfigurationBuilder addServer()

Description copied from interface: RestClientConfigurationChildBuilder

Adds a new remote server

Specified by:

addServer in interface RestClientConfigurationChildBuilder

addServers

public RestClientConfigurationBuilder addServers(String servers)

Description copied from interface: RestClientConfigurationChildBuilder

Adds a list of remote servers in the form: host1[:port][;host2[:port]]...

Specified by:

addServers in interface RestClientConfigurationChildBuilder

clearServers

public RestClientConfigurationBuilder clearServers()

servers

public List<ServerConfigurationBuilder> servers()

protocol

public RestClientConfigurationBuilder protocol(Protocol protocol)

Description copied from interface: RestClientConfigurationChildBuilder

Selects the protocol used by the client. See @Protocol

Specified by:

protocol in interface RestClientConfigurationChildBuilder

priorKnowledge

public RestClientConfigurationBuilder priorKnowledge(boolean enabled)

Description copied from interface: RestClientConfigurationChildBuilder

Configure the client to use Prior Knowledge

Specified by:

priorKnowledge in interface RestClientConfigurationChildBuilder

followRedirects

public RestClientConfigurationBuilder followRedirects(boolean followRedirects)

Specified by:

followRedirects in interface RestClientConfigurationChildBuilder

connectionTimeout

public RestClientConfigurationBuilder connectionTimeout(long connectionTimeout)

Description copied from interface: RestClientConfigurationChildBuilder

This property defines the maximum socket connect timeout before giving up connecting to the server. Defaults to 60000 (1 minute)

Specified by:

connectionTimeout in interface RestClientConfigurationChildBuilder

security

public SecurityConfigurationBuilder security()

Description copied from interface: RestClientConfigurationChildBuilder

Security Configuration

Specified by:

security in interface RestClientConfigurationChildBuilder

socketTimeout

public RestClientConfigurationBuilder socketTimeout(long socketTimeout)

Description copied from interface: RestClientConfigurationChildBuilder

This property defines the maximum socket read timeout in milliseconds before giving up waiting for bytes from the server. Defaults to 60000 (1 minute)

Specified by:

socketTimeout in interface RestClientConfigurationChildBuilder

tcpNoDelay

public RestClientConfigurationBuilder tcpNoDelay(boolean tcpNoDelay)

Description copied from interface: RestClientConfigurationChildBuilder

Affects TCP NODELAY on the TCP stack. Defaults to enabled

Specified by:

tcpNoDelay in interface RestClientConfigurationChildBuilder

tcpKeepAlive

public RestClientConfigurationBuilder tcpKeepAlive(boolean keepAlive)

Description copied from interface: RestClientConfigurationChildBuilder

Affects TCP KEEPALIVE on the TCP stack. Defaults to disable

Specified by:

tcpKeepAlive in interface RestClientConfigurationChildBuilder

contextPath

public RestClientConfigurationBuilder contextPath(String contextPath)

uri

public RestClientConfigurationBuilder uri(URI uri)

uri

public RestClientConfigurationBuilder uri(String uri)

header

public RestClientConfigurationBuilder header(String name,
 String value)

withProperties

public RestClientConfigurationBuilder withProperties(Properties properties)

Description copied from interface: RestClientConfigurationChildBuilder

Configures this builder using the specified properties. See RestClientConfigurationBuilder for a list.

Specified by:

withProperties in interface RestClientConfigurationChildBuilder

validate

public void validate()

Specified by:

validate in interface org.infinispan.commons.configuration.Builder<RestClientConfiguration>

create

public RestClientConfiguration create()

Specified by:

create in interface org.infinispan.commons.configuration.Builder<RestClientConfiguration>

build

public RestClientConfiguration build()

Description copied from interface: RestClientConfigurationChildBuilder

Builds a configuration object

Specified by:

build in interface RestClientConfigurationChildBuilder

build

public RestClientConfiguration build(boolean validate)

read

public RestClientConfigurationBuilder read(RestClientConfiguration template)

Specified by:

read in interface org.infinispan.commons.configuration.Builder<RestClientConfiguration>