org.ehcache.clustered.client.config.builders

Class ClusteringServiceConfigurationBuilder

java.lang.Object

org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder

All Implemented Interfaces:

org.ehcache.config.Builder<ClusteringServiceConfiguration>

public final class ClusteringServiceConfigurationBuilder
extends java.lang.Object
implements org.ehcache.config.Builder<ClusteringServiceConfiguration>

A builder of ClusteringService configurations.

Method Summary

Modifier and Type	Method and Description
ServerSideConfigurationBuilder	autoCreate() Deprecated. in favor of autoCreate(UnaryOperator)
ClusteringServiceConfigurationBuilder	autoCreate(java.util.function.UnaryOperator<ServerSideConfigurationBuilder> serverSideConfig) Support connection to an existing entity or create if the entity if absent.
ClusteringServiceConfigurationBuilder	autoCreateOnReconnect(java.util.function.UnaryOperator<ServerSideConfigurationBuilder> serverSideConfig) Support connection to an existing entity or create if the entity if absent on initial connection or any subsequent reconnect attempt.
ClusteringServiceConfiguration	build()
static ClusteringServiceConfigurationBuilder	cluster(java.lang.Iterable<java.net.InetSocketAddress> servers, java.lang.String clusterTierManager) Creates a new builder connecting to the given cluster.
static ClusteringServiceConfigurationBuilder	cluster(java.net.URI clusterUri) Creates a new builder connecting to the given cluster.
ServerSideConfigurationBuilder	expecting() Deprecated. in favor of expecting(UnaryOperator)
ClusteringServiceConfigurationBuilder	expecting(java.util.function.UnaryOperator<ServerSideConfigurationBuilder> serverSideConfig) Only support connection to an existing entity.
ClusteringServiceConfigurationBuilder	readOperationTimeout(long duration, java.util.concurrent.TimeUnit unit) Deprecated. Use timeouts(Timeouts). Note that calling this method will override any timeouts previously set by setting the read operation timeout to the specified value and everything else to its default.
static ClusteringServiceConfigurationBuilder	seededFrom(ClusteringServiceConfiguration configuration) Creates a new builder seeded from an existing configuration.
ClusteringServiceConfigurationBuilder	timeouts(org.ehcache.config.Builder<? extends Timeouts> timeoutsBuilder) Adds timeouts.
ClusteringServiceConfigurationBuilder	timeouts(Timeouts timeouts) Adds timeouts.
ClusteringServiceConfigurationBuilder	usingServers(java.lang.Iterable<java.net.InetSocketAddress> servers) Reconfigure to connect to a different cluster.
ClusteringServiceConfigurationBuilder	usingServers(java.lang.Iterable<java.net.InetSocketAddress> servers, java.lang.String clusterTierManager) Reconfigure to connect to a different cluster and manager name.
ClusteringServiceConfigurationBuilder	usingUri(java.net.URI clusterUri) Reconfigure to connect to a different URI.

Methods inherited from class java.lang.Object

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

Method Detail

cluster

public static ClusteringServiceConfigurationBuilder cluster(java.net.URI clusterUri)

Creates a new builder connecting to the given cluster.

Parameters:

clusterUri - cluster URI

Returns:

a clustering service configuration builder

cluster

public static ClusteringServiceConfigurationBuilder cluster(java.lang.Iterable<java.net.InetSocketAddress> servers,
                                                            java.lang.String clusterTierManager)

Creates a new builder connecting to the given cluster.

Parameters:

servers - the non-null iterable of servers in the cluster

clusterTierManager - the non-null cluster tier manager identifier

Returns:

a clustering service configuration builder

seededFrom

public static ClusteringServiceConfigurationBuilder seededFrom(ClusteringServiceConfiguration configuration)

Creates a new builder seeded from an existing configuration.

Parameters:

configuration - existing clustering configuration

Returns:

a clustering service configuration builder

usingUri

public ClusteringServiceConfigurationBuilder usingUri(java.net.URI clusterUri)

Reconfigure to connect to a different URI.

Returns:

a clustering service configuration builder

usingServers

public ClusteringServiceConfigurationBuilder usingServers(java.lang.Iterable<java.net.InetSocketAddress> servers)

Reconfigure to connect to a different cluster.

Returns:

a clustering service configuration builder

usingServers

public ClusteringServiceConfigurationBuilder usingServers(java.lang.Iterable<java.net.InetSocketAddress> servers,
                                                          java.lang.String clusterTierManager)

Reconfigure to connect to a different cluster and manager name.

Returns:

a clustering service configuration builder

autoCreate

@Deprecated
public ServerSideConfigurationBuilder autoCreate()

Deprecated. in favor of autoCreate(UnaryOperator)

Support connection to an existing entity or create if the entity if absent.

Returns:

a clustering service configuration builder

expecting

@Deprecated
public ServerSideConfigurationBuilder expecting()

Deprecated. in favor of expecting(UnaryOperator)

Only support connection to an existing entity.

Returns:

a clustering service configuration builder

autoCreate

public ClusteringServiceConfigurationBuilder autoCreate(java.util.function.UnaryOperator<ServerSideConfigurationBuilder> serverSideConfig)

Support connection to an existing entity or create if the entity if absent.

An empty server-side configuration can be created by performing no operations on the supplied builder: builder.autoCreate(b -> b)

Returns:

a clustering service configuration builder

autoCreateOnReconnect

public ClusteringServiceConfigurationBuilder autoCreateOnReconnect(java.util.function.UnaryOperator<ServerSideConfigurationBuilder> serverSideConfig)

Support connection to an existing entity or create if the entity if absent on initial connection or any subsequent reconnect attempt.

An empty server-side configuration can be created by performing no operations on the supplied builder: builder.autoCreateOnReconnect(b -> b)

Returns:

a clustering service configuration builder

expecting

public ClusteringServiceConfigurationBuilder expecting(java.util.function.UnaryOperator<ServerSideConfigurationBuilder> serverSideConfig)

Only support connection to an existing entity.

An empty server-side configuration can be requested by performing no operations on the supplied builder: builder.expecting(b -> b)

Returns:

a clustering service configuration builder

timeouts

public ClusteringServiceConfigurationBuilder timeouts(Timeouts timeouts)

Adds timeouts. Read operations which time out return a result comparable to a cache miss. Write operations which time out won't do anything. Lifecycle operations which time out will fail with exception

Parameters:

timeouts - the amount of time permitted for all operations

Returns:

a clustering service configuration builder

Throws:

java.lang.NullPointerException - if timeouts is null

timeouts

public ClusteringServiceConfigurationBuilder timeouts(org.ehcache.config.Builder<? extends Timeouts> timeoutsBuilder)

Adds timeouts. Read operations which time out return a result comparable to a cache miss. Write operations which time out won't do anything. Lifecycle operations which time out will fail with exception

Parameters:

timeoutsBuilder - the builder for amount of time permitted for all operations

Returns:

a clustering service configuration builder

Throws:

java.lang.NullPointerException - if timeouts is null

readOperationTimeout

@Deprecated
public ClusteringServiceConfigurationBuilder readOperationTimeout(long duration,
                                                                              java.util.concurrent.TimeUnit unit)

Deprecated. Use timeouts(Timeouts). Note that calling this method will override any timeouts previously set by setting the read operation timeout to the specified value and everything else to its default.

Adds a read operation timeout. Read operations which time out return a result comparable to a cache miss.

Parameters:

duration - the amount of time permitted for read operations

unit - the time units for duration

Returns:

a clustering service configuration builder

Throws:

java.lang.NullPointerException - if unit is null

java.lang.IllegalArgumentException - if amount is negative

build

public ClusteringServiceConfiguration build()

Specified by:

build in interface org.ehcache.config.Builder<ClusteringServiceConfiguration>