public class ClusteringServiceConfiguration extends java.lang.Object implements org.ehcache.spi.service.ServiceCreationConfiguration<org.ehcache.clustered.client.service.ClusteringService,ClusteringServiceConfigurationBuilder>, org.ehcache.config.builders.CacheManagerConfiguration<org.ehcache.PersistentCacheManager>, org.ehcache.core.HumanReadable
ClusteringService.| Modifier and Type | Class and Description | 
|---|---|
| static class  | ClusteringServiceConfiguration.ClientModeAn enumeration of configurable client to server connection behaviors. | 
| Modifier and Type | Field and Description | 
|---|---|
| static boolean | DEFAULT_AUTOCREATEDeprecated.  | 
| static ClusteringServiceConfiguration.ClientMode | DEFAULT_CLIENT_MODE | 
| Modifier | Constructor and Description | 
|---|---|
| protected  | ClusteringServiceConfiguration(ClusteringServiceConfiguration baseConfig) | 
|   | ClusteringServiceConfiguration(org.ehcache.clustered.client.internal.ConnectionSource connectionSource,
                              Timeouts timeouts,
                              boolean autoCreate,
                              ServerSideConfiguration serverSideConfiguration,
                              java.util.Properties properties)Deprecated. 
 | 
|   | ClusteringServiceConfiguration(org.ehcache.clustered.client.internal.ConnectionSource connectionSource,
                              Timeouts timeouts,
                              ClusteringServiceConfiguration.ClientMode clientMode,
                              ServerSideConfiguration serverSideConfiguration,
                              java.util.Properties properties)Creates a  ClusteringServiceConfigurationfrom the properties provided. | 
|   | ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
                              java.lang.String clusterTierManager)Deprecated. 
 | 
|   | ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
                              java.lang.String clusterTierManager,
                              boolean autoCreate,
                              ServerSideConfiguration serverConfig)Deprecated. 
 | 
|   | ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
                              java.lang.String clusterTierManager,
                              Timeouts timeouts)Deprecated. 
 | 
|   | ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
                              java.lang.String clusterTierManager,
                              Timeouts timeouts,
                              boolean autoCreate,
                              ServerSideConfiguration serverConfig)Deprecated. 
 | 
|   | ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
                              java.lang.String clusterTierManager,
                              Timeouts timeouts,
                              boolean autoCreate,
                              ServerSideConfiguration serverConfig,
                              java.util.Properties properties)Deprecated. 
 | 
|   | ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
                              java.lang.String clusterTierManager,
                              Timeouts timeouts,
                              ServerSideConfiguration serverConfig)Deprecated. 
 | 
|   | ClusteringServiceConfiguration(java.net.URI clusterUri)Deprecated. 
 | 
|   | ClusteringServiceConfiguration(java.net.URI clusterUri,
                              boolean autoCreate,
                              ServerSideConfiguration serverConfig)Deprecated. 
 | 
|   | ClusteringServiceConfiguration(java.net.URI clusterUri,
                              ServerSideConfiguration serverConfig)Deprecated. 
 | 
|   | ClusteringServiceConfiguration(java.net.URI clusterUri,
                              Timeouts timeouts)Deprecated. 
 | 
|   | ClusteringServiceConfiguration(java.net.URI clusterUri,
                              Timeouts timeouts,
                              boolean autoCreate,
                              ServerSideConfiguration serverConfig)Deprecated. 
 | 
|   | ClusteringServiceConfiguration(java.net.URI clusterUri,
                              Timeouts timeouts,
                              boolean autoCreate,
                              ServerSideConfiguration serverConfig,
                              java.util.Properties properties)Deprecated. 
 | 
|   | ClusteringServiceConfiguration(java.net.URI clusterUri,
                              Timeouts timeouts,
                              ServerSideConfiguration serverConfig)Deprecated. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
| ClusteringServiceConfiguration | build(ClusteringServiceConfigurationBuilder representation) | 
| org.ehcache.config.builders.CacheManagerBuilder<org.ehcache.PersistentCacheManager> | builder(org.ehcache.config.builders.CacheManagerBuilder<? extends org.ehcache.CacheManager> other) | 
| ClusteringServiceConfigurationBuilder | derive() | 
| ClusteringServiceConfiguration.ClientMode | getClientMode()Returns the client connection mode. | 
| java.net.URI | getClusterUri()The  URIof the cluster that will be connected to. | 
| org.ehcache.clustered.client.internal.ConnectionSource | getConnectionSource()The  ConnectionSourceof the cluster, containing either aURI, or anIterable<InetSocketAddress>of the servers in the cluster. | 
| java.util.Properties | getProperties()The  Propertiesfor the connection. | 
| java.time.Duration | getReadOperationTimeout()Deprecated. 
 Use  getTimeouts() | 
| ServerSideConfiguration | getServerConfiguration()The default server resource to use for caches and pools, or  nullif one is not defined. | 
| java.lang.Class<org.ehcache.clustered.client.service.ClusteringService> | getServiceType() | 
| Timeouts | getTimeouts()The timeouts for all cache operations | 
| boolean | isAutoCreate()Deprecated. 
 Deprecated in favor of  getClientMode() | 
| java.lang.String | readableString() | 
public static final ClusteringServiceConfiguration.ClientMode DEFAULT_CLIENT_MODE
@Deprecated public static final boolean DEFAULT_AUTOCREATE
@Deprecated public ClusteringServiceConfiguration(java.net.URI clusterUri)
ClusteringServiceConfigurationBuilder.cluster(URI)ClusteringServiceConfiguration from the properties provided.clusterUri - the non-null URI identifying the cluster serverjava.lang.NullPointerException - if clusterUri is nulljava.lang.IllegalArgumentException - if clusterUri is not URI valid for cluster operations@Deprecated
public ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
                                                  java.lang.String clusterTierManager)
ClusteringServiceConfigurationBuilder.cluster(Iterable, String)ClusteringServiceConfiguration from the properties provided.servers - the non-null iterable of servers in the clusterclusterTierManager - the non-null cluster tier manager identifierjava.lang.NullPointerException - if servers is null@Deprecated
public ClusteringServiceConfiguration(java.net.URI clusterUri,
                                                  Timeouts timeouts)
ClusteringServiceConfigurationBuilder.cluster(URI)ClusteringServiceConfiguration from the properties provided.clusterUri - the non-null URI identifying the cluster servertimeouts - the Timeouts specifying the time limit for clustered cache operationsjava.lang.NullPointerException - if clusterUri is nulljava.lang.IllegalArgumentException - if clusterUri is not URI valid for cluster operations@Deprecated
public ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
                                                  java.lang.String clusterTierManager,
                                                  Timeouts timeouts)
ClusteringServiceConfigurationBuilder.cluster(Iterable, String)ClusteringServiceConfiguration from the properties provided.servers - the non-null iterable of servers in the clusterclusterTierManager - the non-null cluster tier manager identifiertimeouts - the Timeouts specifying the time limit for clustered cache operationsjava.lang.NullPointerException - if servers is null@Deprecated
public ClusteringServiceConfiguration(java.net.URI clusterUri,
                                                  ServerSideConfiguration serverConfig)
ClusteringServiceConfigurationBuilder.cluster(URI)ClusteringServiceConfiguration from the properties provided.clusterUri - the non-null URI identifying the cluster serverserverConfig - the server side entity configuration requiredjava.lang.NullPointerException - if clusterUri is nulljava.lang.IllegalArgumentException - if clusterUri is not URI valid for cluster operations@Deprecated
public ClusteringServiceConfiguration(java.net.URI clusterUri,
                                                  Timeouts timeouts,
                                                  ServerSideConfiguration serverConfig)
ClusteringServiceConfigurationBuilder.cluster(URI)ClusteringServiceConfiguration from the properties provided.clusterUri - the non-null URI identifying the cluster servertimeouts - the Timeouts specifying the time limit for clustered cache operationsserverConfig - the server side entity configuration requiredjava.lang.NullPointerException - if clusterUri is nulljava.lang.IllegalArgumentException - if clusterUri is not URI valid for cluster operations@Deprecated
public ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
                                                  java.lang.String clusterTierManager,
                                                  Timeouts timeouts,
                                                  ServerSideConfiguration serverConfig)
ClusteringServiceConfigurationBuilder.cluster(Iterable, String)ClusteringServiceConfiguration from the properties provided.servers - the non-null iterable of servers in the clusterclusterTierManager - the non-null cluster tier manager identifiertimeouts - the Timeouts specifying the time limit for clustered cache operationsserverConfig - the server side entity configuration requiredjava.lang.NullPointerException - if servers is null@Deprecated
public ClusteringServiceConfiguration(java.net.URI clusterUri,
                                                  boolean autoCreate,
                                                  ServerSideConfiguration serverConfig)
ClusteringServiceConfigurationBuilder.cluster(URI)ClusteringServiceConfiguration from the properties provided.clusterUri - the non-null URI identifying the cluster serverautoCreate - true if server components should be auto createdserverConfig - the server side entity configuration requiredjava.lang.NullPointerException - if clusterUri is nulljava.lang.IllegalArgumentException - if clusterUri is not URI valid for cluster operations@Deprecated
public ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
                                                  java.lang.String clusterTierManager,
                                                  boolean autoCreate,
                                                  ServerSideConfiguration serverConfig)
ClusteringServiceConfigurationBuilder.cluster(Iterable, String)ClusteringServiceConfiguration from the properties provided.servers - the non-null iterable of servers in the clusterclusterTierManager - the non-null cluster tier manager identifierautoCreate - true if server components should be auto createdserverConfig - the server side entity configuration requiredjava.lang.NullPointerException - if servers is null@Deprecated
public ClusteringServiceConfiguration(java.net.URI clusterUri,
                                                  Timeouts timeouts,
                                                  boolean autoCreate,
                                                  ServerSideConfiguration serverConfig)
ClusteringServiceConfigurationBuilder.cluster(URI)ClusteringServiceConfiguration from the properties provided.clusterUri - the non-null URI identifying the cluster servertimeouts - the Timeouts specifying the time limit for clustered cache operationsautoCreate - true if server components should be auto createdserverConfig - the server side entity configuration requiredjava.lang.NullPointerException - if clusterUri is nulljava.lang.IllegalArgumentException - if clusterUri is not URI valid for cluster operations@Deprecated
public ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
                                                  java.lang.String clusterTierManager,
                                                  Timeouts timeouts,
                                                  boolean autoCreate,
                                                  ServerSideConfiguration serverConfig)
ClusteringServiceConfigurationBuilder.cluster(Iterable, String)ClusteringServiceConfiguration from the properties provided.servers - the non-null iterable of servers in the clusterclusterTierManager - the non-null cluster tier manager identifiertimeouts - the Timeouts specifying the time limit for clustered cache operationsautoCreate - true if server components should be auto createdserverConfig - the server side entity configuration requiredjava.lang.NullPointerException - if servers is null@Deprecated
public ClusteringServiceConfiguration(java.net.URI clusterUri,
                                                  Timeouts timeouts,
                                                  boolean autoCreate,
                                                  ServerSideConfiguration serverConfig,
                                                  java.util.Properties properties)
ClusteringServiceConfigurationBuilder.cluster(URI)ClusteringServiceConfiguration from the properties provided.clusterUri - the non-null URI identifying the cluster servertimeouts - the Timeouts specifying the time limit for clustered cache operationsautoCreate - true if server components should be auto createdserverConfig - the server side entity configuration requiredproperties - the non-null connection Propertiesjava.lang.NullPointerException - if clusterUri is nulljava.lang.IllegalArgumentException - if clusterUri is not URI valid for cluster operations@Deprecated
public ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
                                                  java.lang.String clusterTierManager,
                                                  Timeouts timeouts,
                                                  boolean autoCreate,
                                                  ServerSideConfiguration serverConfig,
                                                  java.util.Properties properties)
ClusteringServiceConfigurationBuilder.cluster(Iterable, String)ClusteringServiceConfiguration from the properties provided.servers - the non-null iterable of servers in the clusterclusterTierManager - the non-null cluster tier manager identifiertimeouts - the Timeouts specifying the time limit for clustered cache operationsautoCreate - true if server components should be auto createdserverConfig - the server side entity configuration requiredproperties - the non-null connection Propertiesjava.lang.NullPointerException - if servers is null@Deprecated
public ClusteringServiceConfiguration(org.ehcache.clustered.client.internal.ConnectionSource connectionSource,
                                                  Timeouts timeouts,
                                                  boolean autoCreate,
                                                  ServerSideConfiguration serverSideConfiguration,
                                                  java.util.Properties properties)
ClusteringServiceConfiguration(ConnectionSource, Timeouts, ClientMode, ServerSideConfiguration, Properties) )}ClusteringServiceConfiguration from the properties provided.connectionSource - the non-null ConnectionSource identifying the source of connection to servers in the clustertimeouts - the Timeouts specifying the time limit for clustered cache operationsautoCreate - true if server components should be auto createdserverSideConfiguration - the server side entity configuration requiredproperties - the non-null connection Propertiesjava.lang.NullPointerException - if servers is nullpublic ClusteringServiceConfiguration(org.ehcache.clustered.client.internal.ConnectionSource connectionSource,
                                      Timeouts timeouts,
                                      ClusteringServiceConfiguration.ClientMode clientMode,
                                      ServerSideConfiguration serverSideConfiguration,
                                      java.util.Properties properties)
ClusteringServiceConfiguration from the properties provided.connectionSource - the non-null ConnectionSource identifying the source of connection to servers in the clustertimeouts - the Timeouts specifying the time limit for clustered cache operationsclientMode - behavioral mode when connecting to the clusterserverSideConfiguration - the server side entity configuration requiredproperties - the non-null connection Propertiesprotected ClusteringServiceConfiguration(ClusteringServiceConfiguration baseConfig)
public java.net.URI getClusterUri()
URI of the cluster that will be connected to.URIpublic org.ehcache.clustered.client.internal.ConnectionSource getConnectionSource()
ConnectionSource of the cluster, containing either a URI, or an Iterable<InetSocketAddress>
 of the servers in the cluster.ConnectionSource@Deprecated public boolean isAutoCreate()
getClientMode()true is server side components should be automatically created.true is auto-create is enabledpublic ClusteringServiceConfiguration.ClientMode getClientMode()
public ServerSideConfiguration getServerConfiguration()
null if one is not defined.public Timeouts getTimeouts()
public java.util.Properties getProperties()
Properties for the connection.Properties@Deprecated public java.time.Duration getReadOperationTimeout()
getTimeouts()public java.lang.Class<org.ehcache.clustered.client.service.ClusteringService> getServiceType()
getServiceType in interface org.ehcache.spi.service.ServiceCreationConfiguration<org.ehcache.clustered.client.service.ClusteringService,ClusteringServiceConfigurationBuilder>public org.ehcache.config.builders.CacheManagerBuilder<org.ehcache.PersistentCacheManager> builder(org.ehcache.config.builders.CacheManagerBuilder<? extends org.ehcache.CacheManager> other)
builder in interface org.ehcache.config.builders.CacheManagerConfiguration<org.ehcache.PersistentCacheManager>public java.lang.String readableString()
readableString in interface org.ehcache.core.HumanReadablepublic ClusteringServiceConfigurationBuilder derive()
derive in interface org.ehcache.spi.service.ServiceCreationConfiguration<org.ehcache.clustered.client.service.ClusteringService,ClusteringServiceConfigurationBuilder>public ClusteringServiceConfiguration build(ClusteringServiceConfigurationBuilder representation)
build in interface org.ehcache.spi.service.ServiceCreationConfiguration<org.ehcache.clustered.client.service.ClusteringService,ClusteringServiceConfigurationBuilder>