org.ehcache.clustered.client.config.ClusteringServiceConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ehcache-clustered Show documentation
Show all versions of ehcache-clustered Show documentation
Ehcache 3 Clustered: Defines the client jar and the kit containing the Terracotta server
The newest version!
/*
* Copyright Terracotta, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ehcache.clustered.client.config;
import org.ehcache.CacheManager;
import org.ehcache.PersistentCacheManager;
import org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder;
import org.ehcache.clustered.client.internal.ConnectionSource;
import org.ehcache.clustered.client.service.ClusteringService;
import org.ehcache.config.builders.CacheManagerBuilder;
import org.ehcache.config.builders.CacheManagerConfiguration;
import org.ehcache.core.HumanReadable;
import org.ehcache.spi.service.ServiceCreationConfiguration;
import java.net.InetSocketAddress;
import java.net.URI;
import java.time.Duration;
import java.util.Objects;
import java.util.Properties;
import org.ehcache.clustered.common.ServerSideConfiguration;
import static java.util.Objects.requireNonNull;
import static org.ehcache.clustered.client.config.builders.ClusteringServiceConfigurationBuilder.seededFrom;
/**
* Specifies the configuration for a {@link ClusteringService}.
*/
public class ClusteringServiceConfiguration
implements ServiceCreationConfiguration,
CacheManagerConfiguration,
HumanReadable {
/**
* An enumeration of configurable client to server connection behaviors.
*/
public enum ClientMode {
/**
* Connect to the cluster with no expectations regarding the cluster state.
*/
CONNECT,
/**
* Connect to the cluster and validate the cluster state is compatible with {@link #getServerConfiguration()}.
*/
EXPECTING,
/**
* Connect to the cluster and create or validate the cluster state is compatible with {@link #getServerConfiguration()}.
*/
AUTO_CREATE,
/**
* Auto creates the necessary state on reconnecting to a cluster as well as on initial connection like {@link #AUTO_CREATE}.
*/
AUTO_CREATE_ON_RECONNECT
}
public static final ClientMode DEFAULT_CLIENT_MODE = ClientMode.CONNECT;
@Deprecated
public static final boolean DEFAULT_AUTOCREATE = DEFAULT_CLIENT_MODE.equals(ClientMode.AUTO_CREATE);
private final ConnectionSource connectionSource;
private final ClientMode clientMode;
private final ServerSideConfiguration serverConfiguration;
private final Timeouts timeouts;
private final Properties properties;
/**
* Creates a {@code ClusteringServiceConfiguration} from the properties provided.
*
* @param clusterUri the non-{@code null} URI identifying the cluster server
*
* @throws NullPointerException if {@code clusterUri} is {@code null}
* @throws IllegalArgumentException if {@code clusterUri} is not URI valid for cluster operations
* @deprecated In favor of {@link ClusteringServiceConfigurationBuilder#cluster(URI)}
*/
@Deprecated
public ClusteringServiceConfiguration(URI clusterUri) {
this(clusterUri, Timeouts.DEFAULT);
}
/**
* Creates a {@code ClusteringServiceConfiguration} from the properties provided.
*
* @param servers the non-{@code null} iterable of servers in the cluster
* @param clusterTierManager the non-{@code null} cluster tier manager identifier
*
* @throws NullPointerException if {@code servers} is {@code null}
* @deprecated In favor of {@link ClusteringServiceConfigurationBuilder#cluster(Iterable, String)}
*/
@Deprecated
public ClusteringServiceConfiguration(Iterable servers, String clusterTierManager) {
this(servers, clusterTierManager, Timeouts.DEFAULT);
}
/**
* Creates a {@code ClusteringServiceConfiguration} from the properties provided.
*
* @param clusterUri the non-{@code null} URI identifying the cluster server
* @param timeouts the {@link Timeouts} specifying the time limit for clustered cache operations
*
* @throws NullPointerException if {@code clusterUri} is {@code null}
* @throws IllegalArgumentException if {@code clusterUri} is not URI valid for cluster operations
* @deprecated In favor of {@link ClusteringServiceConfigurationBuilder#cluster(URI)}
*/
@Deprecated
public ClusteringServiceConfiguration(URI clusterUri, Timeouts timeouts) {
this(clusterUri, timeouts, null);
}
/**
* Creates a {@code ClusteringServiceConfiguration} from the properties provided.
*
* @param servers the non-{@code null} iterable of servers in the cluster
* @param clusterTierManager the non-{@code null} cluster tier manager identifier
* @param timeouts the {@link Timeouts} specifying the time limit for clustered cache operations
*
* @throws NullPointerException if {@code servers} is {@code null}
* @deprecated In favor of {@link ClusteringServiceConfigurationBuilder#cluster(Iterable, String)}
*/
@Deprecated
public ClusteringServiceConfiguration(Iterable servers, String clusterTierManager, Timeouts timeouts) {
this(servers, clusterTierManager, timeouts, null);
}
/**
* Creates a {@code ClusteringServiceConfiguration} from the properties provided.
*
* @param clusterUri the non-{@code null} URI identifying the cluster server
* @param serverConfig the server side entity configuration required
*
* @throws NullPointerException if {@code clusterUri} is {@code null}
* @throws IllegalArgumentException if {@code clusterUri} is not URI valid for cluster operations
* @deprecated In favor of {@link ClusteringServiceConfigurationBuilder#cluster(URI)}
*/
@Deprecated
public ClusteringServiceConfiguration(URI clusterUri, ServerSideConfiguration serverConfig) {
this(clusterUri, Timeouts.DEFAULT, serverConfig);
}
/**
* Creates a {@code ClusteringServiceConfiguration} from the properties provided.
*
* @param clusterUri the non-{@code null} URI identifying the cluster server
* @param timeouts the {@link Timeouts} specifying the time limit for clustered cache operations
* @param serverConfig the server side entity configuration required
*
* @throws NullPointerException if {@code clusterUri} is {@code null}
* @throws IllegalArgumentException if {@code clusterUri} is not URI valid for cluster operations
* @deprecated In favor of {@link ClusteringServiceConfigurationBuilder#cluster(URI)}
*/
@Deprecated
public ClusteringServiceConfiguration(URI clusterUri, Timeouts timeouts, ServerSideConfiguration serverConfig) {
this(clusterUri, timeouts, DEFAULT_AUTOCREATE, serverConfig);
}
/**
* Creates a {@code ClusteringServiceConfiguration} from the properties provided.
*
* @param servers the non-{@code null} iterable of servers in the cluster
* @param clusterTierManager the non-{@code null} cluster tier manager identifier
* @param timeouts the {@link Timeouts} specifying the time limit for clustered cache operations
* @param serverConfig the server side entity configuration required
*
* @throws NullPointerException if {@code servers} is {@code null}
* @deprecated In favor of {@link ClusteringServiceConfigurationBuilder#cluster(Iterable, String)}
*/
@Deprecated
public ClusteringServiceConfiguration(Iterable servers, String clusterTierManager, Timeouts timeouts,
ServerSideConfiguration serverConfig) {
this(servers, clusterTierManager, timeouts, DEFAULT_AUTOCREATE, serverConfig);
}
/**
* Creates a {@code ClusteringServiceConfiguration} from the properties provided.
*
* @param clusterUri the non-{@code null} URI identifying the cluster server
* @param autoCreate {@code true} if server components should be auto created
* @param serverConfig the server side entity configuration required
*
* @throws NullPointerException if {@code clusterUri} is {@code null}
* @throws IllegalArgumentException if {@code clusterUri} is not URI valid for cluster operations
* @deprecated In favor of {@link ClusteringServiceConfigurationBuilder#cluster(URI)}
*/
@Deprecated
public ClusteringServiceConfiguration(URI clusterUri, boolean autoCreate, ServerSideConfiguration serverConfig) {
this(clusterUri, Timeouts.DEFAULT, autoCreate, serverConfig);
}
/**
* Creates a {@code ClusteringServiceConfiguration} from the properties provided.
*
* @param servers the non-{@code null} iterable of servers in the cluster
* @param clusterTierManager the non-{@code null} cluster tier manager identifier
* @param autoCreate {@code true} if server components should be auto created
* @param serverConfig the server side entity configuration required
*
* @throws NullPointerException if {@code servers} is {@code null}
* @deprecated In favor of {@link ClusteringServiceConfigurationBuilder#cluster(Iterable, String)}
*/
@Deprecated
public ClusteringServiceConfiguration(Iterable servers, String clusterTierManager, boolean autoCreate,
ServerSideConfiguration serverConfig) {
this(servers, clusterTierManager, Timeouts.DEFAULT, autoCreate, serverConfig);
}
/**
* Creates a {@code ClusteringServiceConfiguration} from the properties provided.
*
* @param clusterUri the non-{@code null} URI identifying the cluster server
* @param timeouts the {@link Timeouts} specifying the time limit for clustered cache operations
* @param autoCreate {@code true} if server components should be auto created
* @param serverConfig the server side entity configuration required
*
* @throws NullPointerException if {@code clusterUri} is {@code null}
* @throws IllegalArgumentException if {@code clusterUri} is not URI valid for cluster operations
* @deprecated In favor of {@link ClusteringServiceConfigurationBuilder#cluster(URI)}
*/
@Deprecated
public ClusteringServiceConfiguration(URI clusterUri, Timeouts timeouts, boolean autoCreate, ServerSideConfiguration serverConfig) {
this(clusterUri, timeouts, autoCreate, serverConfig, new Properties());
}
/**
* Creates a {@code ClusteringServiceConfiguration} from the properties provided.
*
* @param servers the non-{@code null} iterable of servers in the cluster
* @param clusterTierManager the non-{@code null} cluster tier manager identifier
* @param timeouts the {@link Timeouts} specifying the time limit for clustered cache operations
* @param autoCreate {@code true} if server components should be auto created
* @param serverConfig the server side entity configuration required
*
* @throws NullPointerException if {@code servers} is {@code null}
* @deprecated In favor of {@link ClusteringServiceConfigurationBuilder#cluster(Iterable, String)}
*/
@Deprecated
public ClusteringServiceConfiguration(Iterable servers, String clusterTierManager, Timeouts timeouts,
boolean autoCreate, ServerSideConfiguration serverConfig) {
this(servers, clusterTierManager, timeouts, autoCreate, serverConfig, new Properties());
}
/**
* Creates a {@code ClusteringServiceConfiguration} from the properties provided.
*
* @param clusterUri the non-{@code null} URI identifying the cluster server
* @param timeouts the {@link Timeouts} specifying the time limit for clustered cache operations
* @param autoCreate {@code true} if server components should be auto created
* @param serverConfig the server side entity configuration required
* @param properties the non-{@code null} connection Properties
*
* @throws NullPointerException if {@code clusterUri} is {@code null}
* @throws IllegalArgumentException if {@code clusterUri} is not URI valid for cluster operations
* @deprecated In favor of {@link ClusteringServiceConfigurationBuilder#cluster(URI)}
*/
@Deprecated
public ClusteringServiceConfiguration(URI clusterUri, Timeouts timeouts, boolean autoCreate, ServerSideConfiguration serverConfig, Properties properties) {
this(new ConnectionSource.ClusterUri(clusterUri), timeouts, autoCreate, serverConfig, properties);
}
/**
* Creates a {@code ClusteringServiceConfiguration} from the properties provided.
*
* @param servers the non-{@code null} iterable of servers in the cluster
* @param clusterTierManager the non-{@code null} cluster tier manager identifier
* @param timeouts the {@link Timeouts} specifying the time limit for clustered cache operations
* @param autoCreate {@code true} if server components should be auto created
* @param serverConfig the server side entity configuration required
* @param properties the non-{@code null} connection Properties
*
* @throws NullPointerException if {@code servers} is {@code null}
* @deprecated In favor of {@link ClusteringServiceConfigurationBuilder#cluster(Iterable, String)}
*/
@Deprecated
public ClusteringServiceConfiguration(Iterable servers, String clusterTierManager, Timeouts timeouts,
boolean autoCreate, ServerSideConfiguration serverConfig, Properties properties) {
this(new ConnectionSource.ServerList(servers, clusterTierManager), timeouts, autoCreate, serverConfig, properties);
}
/**
* Creates a {@code ClusteringServiceConfiguration} from the properties provided.
*
* @param connectionSource the non-{@code null} {@code ConnectionSource} identifying the source of connection to servers in the cluster
* @param timeouts the {@link Timeouts} specifying the time limit for clustered cache operations
* @param autoCreate {@code true} if server components should be auto created
* @param serverSideConfiguration the server side entity configuration required
* @param properties the non-{@code null} connection Properties
*
* @throws NullPointerException if {@code servers} is {@code null}
* @deprecated In favor of {@link #ClusteringServiceConfiguration(ConnectionSource, Timeouts, ClientMode, ServerSideConfiguration, Properties)} )}
*/
@Deprecated
public ClusteringServiceConfiguration(ConnectionSource connectionSource, Timeouts timeouts, boolean autoCreate,
ServerSideConfiguration serverSideConfiguration, Properties properties) {
this(connectionSource, timeouts,
autoCreate ? ClientMode.AUTO_CREATE : (serverSideConfiguration == null ? ClientMode.CONNECT : ClientMode.EXPECTING),
serverSideConfiguration, properties);
}
/**
* Creates a {@code ClusteringServiceConfiguration} from the properties provided.
*
* @param connectionSource the non-{@code null} {@code ConnectionSource} identifying the source of connection to servers in the cluster
* @param timeouts the {@link Timeouts} specifying the time limit for clustered cache operations
* @param clientMode behavioral mode when connecting to the cluster
* @param serverSideConfiguration the server side entity configuration required
* @param properties the non-{@code null} connection Properties
*/
public ClusteringServiceConfiguration(ConnectionSource connectionSource, Timeouts timeouts, ClientMode clientMode,
ServerSideConfiguration serverSideConfiguration, Properties properties) {
this.connectionSource = requireNonNull(connectionSource);
this.clientMode = requireNonNull(clientMode);
this.serverConfiguration = serverSideConfiguration;
this.timeouts = requireNonNull(timeouts, "Operation timeouts cannot be null");
this.properties = (Properties) requireNonNull(properties, "Properties cannot be null").clone();
}
protected ClusteringServiceConfiguration(ClusteringServiceConfiguration baseConfig) {
Objects.requireNonNull(baseConfig, "Base configuration cannot be null");
this.connectionSource = baseConfig.getConnectionSource();
this.timeouts = baseConfig.getTimeouts();
this.clientMode = baseConfig.getClientMode();
this.serverConfiguration = baseConfig.getServerConfiguration();
this.properties = baseConfig.getProperties();
}
/**
* The {@code URI} of the cluster that will be connected to.
*
* @return the cluster {@code URI}
*/
public URI getClusterUri() {
return connectionSource.getClusterUri();
}
/**
* The {@code ConnectionSource} of the cluster, containing either a {@code URI}, or an {@code Iterable}
* of the servers in the cluster.
*
* @return a cluster {@code ConnectionSource}
*/
public ConnectionSource getConnectionSource() {
return connectionSource;
}
/**
* Returns {@code true} is server side components should be automatically created.
*
* @return {@code true} is auto-create is enabled
* @deprecated Deprecated in favor of {@link #getClientMode()}
*/
@Deprecated
public boolean isAutoCreate() {
final ClientMode clientMode = getClientMode();
return ClientMode.AUTO_CREATE.equals(clientMode) || ClientMode.AUTO_CREATE_ON_RECONNECT.equals(clientMode);
}
/**
* Returns the client connection mode.
*
* @return the client mode
*/
public ClientMode getClientMode() {
return clientMode;
}
/**
* The default server resource to use for caches and pools, or {@code null} if one is not defined.
*
* @return the default server resource
*/
public ServerSideConfiguration getServerConfiguration() {
return serverConfiguration;
}
/**
* The timeouts for all cache operations
*
* @return the cache timeouts
*/
public Timeouts getTimeouts() {
return timeouts;
}
/**
* The {@code Properties} for the connection.
*
* @return the connection {@code Properties}
*/
public Properties getProperties() {
return (Properties) properties.clone();
}
/**
* The timeout for cache read operations.
*
* @return the cache read operation timeout
*
* @deprecated Use {@link #getTimeouts()}
*/
@Deprecated
public Duration getReadOperationTimeout() {
return timeouts.getReadOperationTimeout();
}
@Override
public Class getServiceType() {
return ClusteringService.class;
}
@SuppressWarnings("unchecked")
@Override
public CacheManagerBuilder builder(CacheManagerBuilder other) {
return (CacheManagerBuilder) other.using(this); // unchecked
}
@Override
public String readableString() {
return this.getClass().getName() + ":\n " +
getConnectionSource() + "\n " +
"timeouts: " + getTimeouts()+ "\n " +
"clientMode: " + getClientMode() + "\n " +
"defaultServerResource: " + (serverConfiguration == null ? null : serverConfiguration.getDefaultServerResource()) + "\n " +
readablePoolsString();
}
private String readablePoolsString() {
StringBuilder pools = new StringBuilder("resourcePools:\n");
if (serverConfiguration != null) {
serverConfiguration.getResourcePools().forEach((key, value) -> {
pools.append(" ");
pools.append(key);
pools.append(": ");
pools.append(value);
pools.append("\n");
});
} else {
pools.append(" None.");
}
return pools.toString();
}
@Override
public ClusteringServiceConfigurationBuilder derive() {
return seededFrom(this);
}
@Override
public ClusteringServiceConfiguration build(ClusteringServiceConfigurationBuilder representation) {
return representation.build();
}
}