public class ClusteringServiceConfiguration extends java.lang.Object implements org.ehcache.spi.service.ServiceCreationConfiguration<ClusteringService>, org.ehcache.config.builders.CacheManagerConfiguration<org.ehcache.PersistentCacheManager>, org.ehcache.core.HumanReadable
ClusteringService
.Modifier and Type | Field and Description |
---|---|
static boolean |
DEFAULT_AUTOCREATE |
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)
Creates a
ClusteringServiceConfiguration from the properties provided. |
|
ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
java.lang.String clusterTierManager)
Creates a
ClusteringServiceConfiguration from the properties provided. |
|
ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
java.lang.String clusterTierManager,
boolean autoCreate,
ServerSideConfiguration serverConfig)
Creates a
ClusteringServiceConfiguration from the properties provided. |
|
ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
java.lang.String clusterTierManager,
Timeouts timeouts)
Creates a
ClusteringServiceConfiguration from the properties provided. |
|
ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
java.lang.String clusterTierManager,
Timeouts timeouts,
boolean autoCreate,
ServerSideConfiguration serverConfig)
Creates a
ClusteringServiceConfiguration from the properties provided. |
|
ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
java.lang.String clusterTierManager,
Timeouts timeouts,
boolean autoCreate,
ServerSideConfiguration serverConfig,
java.util.Properties properties)
Creates a
ClusteringServiceConfiguration from the properties provided. |
|
ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers,
java.lang.String clusterTierManager,
Timeouts timeouts,
ServerSideConfiguration serverConfig)
Creates a
ClusteringServiceConfiguration from the properties provided. |
|
ClusteringServiceConfiguration(java.net.URI clusterUri)
Creates a
ClusteringServiceConfiguration from the properties provided. |
|
ClusteringServiceConfiguration(java.net.URI clusterUri,
boolean autoCreate,
ServerSideConfiguration serverConfig)
Creates a
ClusteringServiceConfiguration from the properties provided. |
|
ClusteringServiceConfiguration(java.net.URI clusterUri,
ServerSideConfiguration serverConfig)
Creates a
ClusteringServiceConfiguration from the properties provided. |
|
ClusteringServiceConfiguration(java.net.URI clusterUri,
Timeouts timeouts)
Creates a
ClusteringServiceConfiguration from the properties provided. |
|
ClusteringServiceConfiguration(java.net.URI clusterUri,
Timeouts timeouts,
boolean autoCreate,
ServerSideConfiguration serverConfig)
Creates a
ClusteringServiceConfiguration from the properties provided. |
|
ClusteringServiceConfiguration(java.net.URI clusterUri,
Timeouts timeouts,
boolean autoCreate,
ServerSideConfiguration serverConfig,
java.util.Properties properties)
Creates a
ClusteringServiceConfiguration from the properties provided. |
|
ClusteringServiceConfiguration(java.net.URI clusterUri,
Timeouts timeouts,
ServerSideConfiguration serverConfig)
Creates a
ClusteringServiceConfiguration from the properties provided. |
Modifier and Type | Method and Description |
---|---|
org.ehcache.config.builders.CacheManagerBuilder<org.ehcache.PersistentCacheManager> |
builder(org.ehcache.config.builders.CacheManagerBuilder<? extends org.ehcache.CacheManager> other) |
java.net.URI |
getClusterUri()
The
URI of the cluster that will be connected to. |
org.ehcache.clustered.client.internal.ConnectionSource |
getConnectionSource()
The
ConnectionSource of the cluster, containing either a URI , or an Iterable<InetSocketAddress>
of the servers in the cluster. |
java.util.Properties |
getProperties()
The
Properties for the connection. |
java.time.Duration |
getReadOperationTimeout()
Deprecated.
Use
getTimeouts() |
ServerSideConfiguration |
getServerConfiguration()
The default server resource to use for caches and pools, or
null if one is not defined. |
java.lang.Class<ClusteringService> |
getServiceType() |
Timeouts |
getTimeouts()
The timeouts for all cache operations
|
boolean |
isAutoCreate()
Returns
true is server side components should be automatically created. |
java.lang.String |
readableString() |
public static final boolean DEFAULT_AUTOCREATE
public ClusteringServiceConfiguration(java.net.URI clusterUri)
ClusteringServiceConfiguration
from the properties provided.clusterUri
- the non-null
URI identifying the cluster serverjava.lang.NullPointerException
- if clusterUri
is null
java.lang.IllegalArgumentException
- if clusterUri
is not URI valid for cluster operationspublic ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers, java.lang.String clusterTierManager)
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
public ClusteringServiceConfiguration(java.net.URI clusterUri, Timeouts timeouts)
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 null
java.lang.IllegalArgumentException
- if clusterUri
is not URI valid for cluster operationspublic ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers, java.lang.String clusterTierManager, Timeouts timeouts)
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
public ClusteringServiceConfiguration(java.net.URI clusterUri, ServerSideConfiguration serverConfig)
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 null
java.lang.IllegalArgumentException
- if clusterUri
is not URI valid for cluster operationspublic ClusteringServiceConfiguration(java.net.URI clusterUri, Timeouts timeouts, ServerSideConfiguration serverConfig)
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 null
java.lang.IllegalArgumentException
- if clusterUri
is not URI valid for cluster operationspublic ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers, java.lang.String clusterTierManager, Timeouts timeouts, ServerSideConfiguration serverConfig)
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
public ClusteringServiceConfiguration(java.net.URI clusterUri, boolean autoCreate, ServerSideConfiguration serverConfig)
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 null
java.lang.IllegalArgumentException
- if clusterUri
is not URI valid for cluster operationspublic ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers, java.lang.String clusterTierManager, boolean autoCreate, ServerSideConfiguration serverConfig)
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
public ClusteringServiceConfiguration(java.net.URI clusterUri, Timeouts timeouts, boolean autoCreate, ServerSideConfiguration serverConfig)
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 null
java.lang.IllegalArgumentException
- if clusterUri
is not URI valid for cluster operationspublic ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers, java.lang.String clusterTierManager, Timeouts timeouts, boolean autoCreate, ServerSideConfiguration serverConfig)
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
public ClusteringServiceConfiguration(java.net.URI clusterUri, Timeouts timeouts, boolean autoCreate, ServerSideConfiguration serverConfig, java.util.Properties properties)
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 null
java.lang.IllegalArgumentException
- if clusterUri
is not URI valid for cluster operationspublic ClusteringServiceConfiguration(java.lang.Iterable<java.net.InetSocketAddress> servers, java.lang.String clusterTierManager, Timeouts timeouts, boolean autoCreate, ServerSideConfiguration serverConfig, java.util.Properties properties)
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
public ClusteringServiceConfiguration(org.ehcache.clustered.client.internal.ConnectionSource connectionSource, Timeouts timeouts, boolean autoCreate, 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 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 null
protected ClusteringServiceConfiguration(ClusteringServiceConfiguration baseConfig)
public java.net.URI getClusterUri()
URI
of the cluster that will be connected to.URI
public 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
public boolean isAutoCreate()
true
is server side components should be automatically created.true
is auto-create is enabledpublic 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<ClusteringService> getServiceType()
getServiceType
in interface org.ehcache.spi.service.ServiceCreationConfiguration<ClusteringService>
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.HumanReadable