Index (ehcache-clustered-dist 3.9.4 API)

A B C D E G H I N O R S T U V W

A

addConnectionRecoveryListener(Runnable) - Method in interface org.ehcache.clustered.client.service.ClusteringService: Add a block to execute when the connection is recovered after it was closed.
autoCreate() - Method in class org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder: Deprecated.
in favor of ClusteringServiceConfigurationBuilder.autoCreate(UnaryOperator)
autoCreate(UnaryOperator<ServerSideConfigurationBuilder>) - Method in class org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder: Support connection to an existing entity or create if the entity if absent.
autoCreateOnReconnect(UnaryOperator<ServerSideConfigurationBuilder>) - Method in class org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder: Support connection to an existing entity or create if the entity if absent on initial connection or any subsequent reconnect attempt.

B

build() - Method in class org.ehcache.clustered.client.config.builders.ClusteredStoreConfigurationBuilder
build() - Method in class org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder
build() - Method in class org.ehcache.clustered.client.config.builders.ServerSideConfigurationBuilder
build() - Method in class org.ehcache.clustered.client.config.builders.TimeoutsBuilder: Gets a new Timeouts instance using the current timeout duration settings.
build(Consistency) - Method in class org.ehcache.clustered.client.config.ClusteredStoreConfiguration
build(ClusteringServiceConfigurationBuilder) - Method in class org.ehcache.clustered.client.config.ClusteringServiceConfiguration
builder(CacheManagerBuilder<? extends CacheManager>) - Method in class org.ehcache.clustered.client.config.ClusteringServiceConfiguration

C

ClientEntityFactory<E extends org.terracotta.connection.entity.Entity,C> - Interface in org.ehcache.clustered.client.service: Factory used to create, fetch and destroy server entities.
cluster(URI) - Static method in class org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder: Creates a new builder connecting to the given cluster.
cluster(Iterable<InetSocketAddress>, String) - Static method in class org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder: Creates a new builder connecting to the given cluster.
clustered() - Static method in class org.ehcache.clustered.client.config.builders.ClusteredResourcePoolBuilder: Creates a resource pool that inherits the resources already configured on the server.
clusteredDedicated(long, MemoryUnit) - Static method in class org.ehcache.clustered.client.config.builders.ClusteredResourcePoolBuilder: Creates a new clustered resource pool using dedicated clustered resources.
clusteredDedicated(String, long, MemoryUnit) - Static method in class org.ehcache.clustered.client.config.builders.ClusteredResourcePoolBuilder: Creates a new clustered resource pool using dedicated clustered resources.
ClusteredResourcePool - Interface in org.ehcache.clustered.client.config: Defines a resource supported by a server-based resource.
ClusteredResourcePoolBuilder - Class in org.ehcache.clustered.client.config.builders: Constructs a ResourcePool for a clustered resource.
ClusteredResourceType<P extends ClusteredResourcePool> - Interface in org.ehcache.clustered.client.config: Defines the clustered ResourceType.
ClusteredResourceType.Types - Class in org.ehcache.clustered.client.config
clusteredShared(String) - Static method in class org.ehcache.clustered.client.config.builders.ClusteredResourcePoolBuilder: Creates a new resource pool based on the provided parameters.
ClusteredStoreConfiguration - Class in org.ehcache.clustered.client.config: ServiceConfiguration for the ClusteredStore.
ClusteredStoreConfiguration() - Constructor for class org.ehcache.clustered.client.config.ClusteredStoreConfiguration: Creates a new configuration with consistency set to EVENTUAL.
ClusteredStoreConfiguration(Consistency) - Constructor for class org.ehcache.clustered.client.config.ClusteredStoreConfiguration: Creates a new configuration with the provided Consistency.
ClusteredStoreConfigurationBuilder - Class in org.ehcache.clustered.client.config.builders: Builder for the ClusteredStoreConfiguration.
ClusteringService - Interface in org.ehcache.clustered.client.service: Provides support for accessing server-based resources.
ClusteringService.ClusteredCacheIdentifier - Interface in org.ehcache.clustered.client.service: A PersistenceSpaceIdentifier that can provide an id.
ClusteringServiceConfiguration - Class in org.ehcache.clustered.client.config: Specifies the configuration for a ClusteringService.
ClusteringServiceConfiguration(URI) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
In favor of ClusteringServiceConfigurationBuilder.cluster(URI)
ClusteringServiceConfiguration(Iterable<InetSocketAddress>, String) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
In favor of ClusteringServiceConfigurationBuilder.cluster(Iterable, String)
ClusteringServiceConfiguration(URI, Timeouts) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
In favor of ClusteringServiceConfigurationBuilder.cluster(URI)
ClusteringServiceConfiguration(Iterable<InetSocketAddress>, String, Timeouts) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
In favor of ClusteringServiceConfigurationBuilder.cluster(Iterable, String)
ClusteringServiceConfiguration(URI, ServerSideConfiguration) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
In favor of ClusteringServiceConfigurationBuilder.cluster(URI)
ClusteringServiceConfiguration(URI, Timeouts, ServerSideConfiguration) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
In favor of ClusteringServiceConfigurationBuilder.cluster(URI)
ClusteringServiceConfiguration(Iterable<InetSocketAddress>, String, Timeouts, ServerSideConfiguration) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
In favor of ClusteringServiceConfigurationBuilder.cluster(Iterable, String)
ClusteringServiceConfiguration(URI, boolean, ServerSideConfiguration) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
In favor of ClusteringServiceConfigurationBuilder.cluster(URI)
ClusteringServiceConfiguration(Iterable<InetSocketAddress>, String, boolean, ServerSideConfiguration) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
In favor of ClusteringServiceConfigurationBuilder.cluster(Iterable, String)
ClusteringServiceConfiguration(URI, Timeouts, boolean, ServerSideConfiguration) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
In favor of ClusteringServiceConfigurationBuilder.cluster(URI)
ClusteringServiceConfiguration(Iterable<InetSocketAddress>, String, Timeouts, boolean, ServerSideConfiguration) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
In favor of ClusteringServiceConfigurationBuilder.cluster(Iterable, String)
ClusteringServiceConfiguration(URI, Timeouts, boolean, ServerSideConfiguration, Properties) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
In favor of ClusteringServiceConfigurationBuilder.cluster(URI)
ClusteringServiceConfiguration(Iterable<InetSocketAddress>, String, Timeouts, boolean, ServerSideConfiguration, Properties) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
In favor of ClusteringServiceConfigurationBuilder.cluster(Iterable, String)
ClusteringServiceConfiguration(ConnectionSource, Timeouts, boolean, ServerSideConfiguration, Properties) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
In favor of ClusteringServiceConfiguration(ConnectionSource, Timeouts, ClientMode, ServerSideConfiguration, Properties) )}
ClusteringServiceConfiguration(ConnectionSource, Timeouts, ClusteringServiceConfiguration.ClientMode, ServerSideConfiguration, Properties) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Creates a ClusteringServiceConfiguration from the properties provided.
ClusteringServiceConfiguration(ClusteringServiceConfiguration) - Constructor for class org.ehcache.clustered.client.config.ClusteringServiceConfiguration
ClusteringServiceConfiguration.ClientMode - Enum in org.ehcache.clustered.client.config: An enumeration of configurable client to server connection behaviors.
ClusteringServiceConfigurationBuilder - Class in org.ehcache.clustered.client.config.builders: A builder of ClusteringService configurations.
connection(Duration) - Method in class org.ehcache.clustered.client.config.builders.TimeoutsBuilder: Sets the timeout for connecting to the server.
create() - Method in interface org.ehcache.clustered.client.service.ClientEntityFactory: Creates the entity and validate that it can be effectively fetched

D

DEDICATED - Static variable in class org.ehcache.clustered.client.config.ClusteredResourceType.Types: Identifies the clustered-dedicated ResourceType.
DedicatedClusteredResourcePool - Interface in org.ehcache.clustered.client.config: Specifies a ClusteredResourcePool reserving space from a server-based clustered resource.
DEFAULT - Static variable in class org.ehcache.clustered.client.config.Timeouts
DEFAULT_AUTOCREATE - Static variable in class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
DEFAULT_CLIENT_MODE - Static variable in class org.ehcache.clustered.client.config.ClusteringServiceConfiguration
DEFAULT_CONNECTION_TIMEOUT - Static variable in class org.ehcache.clustered.client.config.Timeouts
DEFAULT_OPERATION_TIMEOUT - Static variable in class org.ehcache.clustered.client.config.Timeouts
defaultServerResource(String) - Method in class org.ehcache.clustered.client.config.builders.ServerSideConfigurationBuilder: Sets the default server resource for pools and caches.
derive() - Method in class org.ehcache.clustered.client.config.ClusteredStoreConfiguration
derive() - Method in class org.ehcache.clustered.client.config.ClusteringServiceConfiguration
destroy() - Method in interface org.ehcache.clustered.client.service.ClientEntityFactory: Destroy the entity matching the factory entity identifier and type

E

EntityBusyException - Exception in org.ehcache.clustered.client.service: Thrown by Entity operations requiring access to the org.terracotta.entity.ActiveServerEntity when the org.terracotta.entity.ActiveServerEntity is not available.
EntityBusyException(String) - Constructor for exception org.ehcache.clustered.client.service.EntityBusyException
EntityBusyException(String, Throwable) - Constructor for exception org.ehcache.clustered.client.service.EntityBusyException
EntityBusyException(Throwable) - Constructor for exception org.ehcache.clustered.client.service.EntityBusyException
EntityService - Interface in org.ehcache.clustered.client.service: Provides support for accessing server entities through the Cache Manager connection
equals(Object) - Method in class org.ehcache.clustered.client.config.Timeouts
expecting() - Method in class org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder: Deprecated.
in favor of ClusteringServiceConfigurationBuilder.expecting(UnaryOperator)
expecting(UnaryOperator<ServerSideConfigurationBuilder>) - Method in class org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder: Only support connection to an existing entity.

G

getClientMode() - Method in class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Returns the client connection mode.
getClusterUri() - Method in class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: The URI of the cluster that will be connected to.
getConfiguration() - Method in interface org.ehcache.clustered.client.service.ClientEntityFactory
getConfiguration() - Method in interface org.ehcache.clustered.client.service.ClusteringService
getConnectionSource() - Method in class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: The ConnectionSource of the cluster, containing either a URI, or an Iterable<InetSocketAddress> of the servers in the cluster.
getConnectionTimeout() - Method in class org.ehcache.clustered.client.config.Timeouts
getConsistency() - Method in class org.ehcache.clustered.client.config.ClusteredStoreConfiguration: Returns the Consistency for this configuration instance.
getEntityIdentifier() - Method in interface org.ehcache.clustered.client.service.ClientEntityFactory
getEntityType() - Method in interface org.ehcache.clustered.client.service.ClientEntityFactory
getEntityVersion() - Method in interface org.ehcache.clustered.client.service.ClientEntityFactory
getFromResource() - Method in interface org.ehcache.clustered.client.config.DedicatedClusteredResourcePool: Identifies the server-side clustered resource from which space for this pool is reserved.
getId() - Method in interface org.ehcache.clustered.client.service.ClusteringService.ClusteredCacheIdentifier: The id associated with this identifier.
getPoolAllocation() - Method in interface org.ehcache.clustered.client.config.ClusteredResourcePool: Converts this ClusteredResourcePool into the PoolAllocation used by the cluster server.
getProperties() - Method in class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: The Properties for the connection.
getReadOperationTimeout() - Method in class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
Use ClusteringServiceConfiguration.getTimeouts()
getReadOperationTimeout() - Method in class org.ehcache.clustered.client.config.Timeouts
getServerConfiguration() - Method in class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: The default server resource to use for caches and pools, or null if one is not defined.
getServerStoreProxy(ClusteringService.ClusteredCacheIdentifier, Store.Configuration<K, V>, Consistency, ServerStoreProxy.ServerCallback) - Method in interface org.ehcache.clustered.client.service.ClusteringService: Gets a ServerStoreProxy though which a server-resident ServerStore is accessed.
getServiceType() - Method in class org.ehcache.clustered.client.config.ClusteredStoreConfiguration
getServiceType() - Method in class org.ehcache.clustered.client.config.ClusteringServiceConfiguration
getSharedResourcePool() - Method in interface org.ehcache.clustered.client.config.SharedClusteredResourcePool: Identifies the server-side clustered resource shared with this resource pool.
getTimeouts() - Method in class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: The timeouts for all cache operations
getType() - Method in interface org.ehcache.clustered.client.config.ClusteredResourcePool
getUnit() - Method in interface org.ehcache.clustered.client.config.DedicatedClusteredResourcePool
getWriteOperationTimeout() - Method in class org.ehcache.clustered.client.config.Timeouts

H

hashCode() - Method in class org.ehcache.clustered.client.config.Timeouts

I

INFINITE_TIMEOUT - Static variable in class org.ehcache.clustered.client.config.Timeouts
isAutoCreate() - Method in class org.ehcache.clustered.client.config.ClusteringServiceConfiguration: Deprecated.
Deprecated in favor of ClusteringServiceConfiguration.getClientMode()
isConnected() - Method in interface org.ehcache.clustered.client.service.ClusteringService

N

nanosStartingFromNow(Duration) - Static method in class org.ehcache.clustered.client.config.Timeouts
newClientEntityFactory(String, Class<E>, long, C) - Method in interface org.ehcache.clustered.client.service.EntityService: Creates a factory class used to create, fetch and destroy server entities through the same connection used by this CacheManager

O

org.ehcache.clustered.client.config - package org.ehcache.clustered.client.config
org.ehcache.clustered.client.config.builders - package org.ehcache.clustered.client.config.builders
org.ehcache.clustered.client.service - package org.ehcache.clustered.client.service

R

read(Duration) - Method in class org.ehcache.clustered.client.config.builders.TimeoutsBuilder: Sets the timeout for read operations.
readableString() - Method in class org.ehcache.clustered.client.config.ClusteringServiceConfiguration
readOperationTimeout(long, TimeUnit) - Method in class org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder: Deprecated.
Use ClusteringServiceConfigurationBuilder.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.
releaseServerStoreProxy(ServerStoreProxy, boolean) - Method in interface org.ehcache.clustered.client.service.ClusteringService: Releases access to a ServerStoreProxy and the server-resident ServerStore it represents.
removeConnectionRecoveryListener(Runnable) - Method in interface org.ehcache.clustered.client.service.ClusteringService: Remove a block to execute when the connection is recovered after it was closed.
resourcePool(String, long, MemoryUnit, String) - Method in class org.ehcache.clustered.client.config.builders.ServerSideConfigurationBuilder: Adds a resource pool with the given name and size and consuming the given server resource.
resourcePool(String, long, MemoryUnit) - Method in class org.ehcache.clustered.client.config.builders.ServerSideConfigurationBuilder: Adds a resource pool with the given name and size and consuming the default server resource.
resourcePool(String, ServerSideConfiguration.Pool) - Method in class org.ehcache.clustered.client.config.builders.ServerSideConfigurationBuilder: Adds a resource pool with the given name and definition
retrieve() - Method in interface org.ehcache.clustered.client.service.ClientEntityFactory

S

seededFrom(ClusteringServiceConfiguration) - Static method in class org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder: Creates a new builder seeded from an existing configuration.
ServerSideConfigurationBuilder - Class in org.ehcache.clustered.client.config.builders: Constructs the server-side portion of a ClusteringServiceConfiguration.
ServerSideConfigurationBuilder(ServerSideConfiguration) - Constructor for class org.ehcache.clustered.client.config.builders.ServerSideConfigurationBuilder
SHARED - Static variable in class org.ehcache.clustered.client.config.ClusteredResourceType.Types: Identifies the cluster-shared ResourceType.
SharedClusteredResourcePool - Interface in org.ehcache.clustered.client.config: Specifies a ClusteredResourcePool sharing space in a server-based clustered resource.

T

timeouts(Timeouts) - Method in class org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder: Adds timeouts.
timeouts(Builder<? extends Timeouts>) - Method in class org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder: Adds timeouts.
timeouts() - Static method in class org.ehcache.clustered.client.config.builders.TimeoutsBuilder: Obtain a new get for timeouts
Timeouts - Class in org.ehcache.clustered.client.config: Describes the timeouts for ClusterTierManagerClientEntity operations.
Timeouts(Duration, Duration, Duration) - Constructor for class org.ehcache.clustered.client.config.Timeouts
TimeoutsBuilder - Class in org.ehcache.clustered.client.config.builders: Constructs instances of Timeouts.
toString() - Method in class org.ehcache.clustered.client.config.Timeouts
Types() - Constructor for class org.ehcache.clustered.client.config.ClusteredResourceType.Types

U

UNKNOWN - Static variable in class org.ehcache.clustered.client.config.ClusteredResourceType.Types: Identifies the clustered ResourceType.
usingServers(Iterable<InetSocketAddress>) - Method in class org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder: Reconfigure to connect to a different cluster.
usingServers(Iterable<InetSocketAddress>, String) - Method in class org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder: Reconfigure to connect to a different cluster and manager name.
usingUri(URI) - Method in class org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder: Reconfigure to connect to a different URI.

V

valueOf(String) - Static method in enum org.ehcache.clustered.client.config.ClusteringServiceConfiguration.ClientMode: Returns the enum constant of this type with the specified name.
values() - Static method in class org.ehcache.clustered.client.config.ClusteredResourceType.Types: Returns an array containing the constants of the ClusteredResourceType.
values() - Static method in enum org.ehcache.clustered.client.config.ClusteringServiceConfiguration.ClientMode: Returns an array containing the constants of this enum type, in the order they are declared.

W

withConsistency(Consistency) - Static method in class org.ehcache.clustered.client.config.builders.ClusteredStoreConfigurationBuilder: Creates a new builder instance with the provided Consistency configured.
write(Duration) - Method in class org.ehcache.clustered.client.config.builders.TimeoutsBuilder: Sets the timeout for write operations like put and remove.

A B C D E G H I N O R S T U V W