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

java.lang.Object
  extended by 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
 ServerSideConfigurationBuilder autoCreate()
          Support connection to an existing entity or create if the entity if absent.
 ClusteringServiceConfiguration build()
           
static ClusteringServiceConfigurationBuilder cluster(java.net.URI clusterUri)
          Creates a new builder connecting to the given cluster.
 ServerSideConfigurationBuilder expecting()
          Only support connection to an existing entity.
 ClusteringServiceConfigurationBuilder readOperationTimeout(long duration, java.util.concurrent.TimeUnit unit)
          Adds a read operation timeout.
 
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

autoCreate

public ServerSideConfigurationBuilder autoCreate()
Support connection to an existing entity or create if the entity if absent.

Returns:
a clustering service configuration builder

expecting

public ServerSideConfigurationBuilder expecting()
Only support connection to an existing entity.

Returns:
a clustering service configuration builder

readOperationTimeout

public ClusteringServiceConfigurationBuilder readOperationTimeout(long duration,
                                                                  java.util.concurrent.TimeUnit unit)
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>