com.hazelcast.client.config.ClientConfigXmlGenerator Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2008-2020, Hazelcast, Inc. All Rights Reserved.
*
* 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 com.hazelcast.client.config;
import com.hazelcast.client.LoadBalancer;
import com.hazelcast.client.util.RandomLB;
import com.hazelcast.client.util.RoundRobinLB;
import com.hazelcast.config.AliasedDiscoveryConfig;
import com.hazelcast.config.AliasedDiscoveryConfigUtils;
import com.hazelcast.config.ConfigXmlGenerator.XmlGenerator;
import com.hazelcast.config.DiscoveryConfig;
import com.hazelcast.config.DiscoveryStrategyConfig;
import com.hazelcast.config.EntryListenerConfig;
import com.hazelcast.config.EvictionConfig;
import com.hazelcast.config.GlobalSerializerConfig;
import com.hazelcast.config.GroupConfig;
import com.hazelcast.config.ListenerConfig;
import com.hazelcast.config.MapIndexConfig;
import com.hazelcast.config.NativeMemoryConfig;
import com.hazelcast.config.NearCacheConfig;
import com.hazelcast.config.NearCachePreloaderConfig;
import com.hazelcast.config.PredicateConfig;
import com.hazelcast.config.QueryCacheConfig;
import com.hazelcast.config.SSLConfig;
import com.hazelcast.config.SerializationConfig;
import com.hazelcast.config.SerializerConfig;
import com.hazelcast.config.SocketInterceptorConfig;
import com.hazelcast.nio.serialization.DataSerializableFactory;
import com.hazelcast.nio.serialization.PortableFactory;
import com.hazelcast.security.Credentials;
import com.hazelcast.util.Preconditions;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import static com.hazelcast.client.config.ClientAliasedDiscoveryConfigUtils.aliasedDiscoveryConfigsFrom;
import static com.hazelcast.util.StringUtil.formatXml;
import static com.hazelcast.util.StringUtil.isNullOrEmpty;
/**
* The ClientConfigXmlGenerator is responsible for transforming a
* {@link ClientConfig} to a Hazelcast Client XML string.
*/
public final class ClientConfigXmlGenerator {
private ClientConfigXmlGenerator() {
}
/**
* Convenience for {@link #generate(ClientConfig, int)}, which
* generates the xml without any formatting.
*/
public static String generate(ClientConfig clientConfig) {
return generate(clientConfig, -1);
}
/**
* Transforms the given {@link ClientConfig} to xml string
* formatting the output with given {@code indent}, -1 means no
* formatting.
*/
public static String generate(ClientConfig clientConfig, int indent) {
Preconditions.isNotNull(clientConfig, "ClientConfig");
StringBuilder xml = new StringBuilder();
xml.append("");
XmlGenerator gen = new XmlGenerator(xml);
gen.open("hazelcast-client", "xmlns", "http://www.hazelcast.com/schema/client-config",
"xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance",
"xsi:schemaLocation", "http://www.hazelcast.com/schema/client-config "
+ "http://www.hazelcast.com/schema/client-config/hazelcast-client-config-3.11.xsd");
//GroupConfig
group(gen, clientConfig.getGroupConfig());
//InstanceName
gen.node("instance-name", clientConfig.getInstanceName());
//attributes
gen.appendLabels(clientConfig.getLabels());
//Properties
gen.appendProperties(clientConfig.getProperties());
//Network
network(gen, clientConfig.getNetworkConfig());
//ExecutorPoolSize
if (clientConfig.getExecutorPoolSize() > 0) {
gen.node("executor-pool-size", clientConfig.getExecutorPoolSize());
}
//Security
security(gen, clientConfig.getSecurityConfig());
//Listeners
listener(gen, clientConfig.getListenerConfigs());
//Serialization
serialization(gen, clientConfig.getSerializationConfig());
//Native
nativeMemory(gen, clientConfig.getNativeMemoryConfig());
//ProxyFactories
proxyFactory(gen, clientConfig.getProxyFactoryConfigs());
//LoadBalancer
loadBalancer(gen, clientConfig.getLoadBalancer());
//NearCache
nearCaches(gen, clientConfig.getNearCacheConfigMap());
//QueryCaches
queryCaches(gen, clientConfig.getQueryCacheConfigs());
//ConnectionStrategy
ClientConnectionStrategyConfig connectionStrategy = clientConfig.getConnectionStrategyConfig();
gen.node("connection-strategy", null, "async-start", connectionStrategy.isAsyncStart(),
"reconnect-mode", connectionStrategy.getReconnectMode());
//UserCodeDeployment
userCodeDeployment(gen, clientConfig.getUserCodeDeploymentConfig());
//FlakeIdGenerator
flakeIdGenerator(gen, clientConfig.getFlakeIdGeneratorConfigMap());
//close HazelcastClient
gen.close();
return formatXml(xml.toString(), indent);
}
private static void group(XmlGenerator gen, GroupConfig group) {
gen.open("group")
.node("name", group.getName())
.node("password", group.getPassword())
.close();
}
private static void network(XmlGenerator gen, ClientNetworkConfig network) {
gen.open("network")
.node("smart-routing", network.isSmartRouting())
.node("redo-operation", network.isRedoOperation())
.node("connection-timeout", network.getConnectionTimeout())
.node("connection-attempt-period", network.getConnectionAttemptPeriod());
if (network.getConnectionAttemptLimit() >= 0) {
gen.node("connection-attempt-limit", network.getConnectionAttemptLimit());
}
clusterMembers(gen, network.getAddresses());
socketOptions(gen, network.getSocketOptions());
socketInterceptor(gen, network.getSocketInterceptorConfig());
ssl(gen, network.getSSLConfig());
aliasedDiscoveryConfigsGenerator(gen, aliasedDiscoveryConfigsFrom(network));
discovery(gen, network.getDiscoveryConfig());
outboundPort(gen, network.getOutboundPortDefinitions());
icmp(gen, network.getClientIcmpPingConfig());
gen.close();
}
private static void security(XmlGenerator gen, ClientSecurityConfig security) {
String credentialsClassname = security.getCredentialsClassname();
Credentials credentials = security.getCredentials();
if (credentialsClassname == null && credentials == null) {
return;
}
gen.open("security")
.node("credentials", classNameOrImplClass(credentialsClassname, credentials))
.close();
}
private static void listener(XmlGenerator gen, List listeners) {
if (listeners.isEmpty()) {
return;
}
gen.open("listeners");
for (ListenerConfig listener : listeners) {
gen.node("listener", classNameOrImplClass(listener.getClassName(), listener.getImplementation()));
}
gen.close();
}
private static void serialization(XmlGenerator gen, SerializationConfig serialization) {
gen.open("serialization")
.node("portable-version", serialization.getPortableVersion())
.node("use-native-byte-order", serialization.isUseNativeByteOrder())
.node("byte-order", serialization.getByteOrder())
.node("enable-compression", serialization.isEnableCompression())
.node("enable-shared-object", serialization.isEnableSharedObject())
.node("allow-unsafe", serialization.isAllowUnsafe())
.node("check-class-def-errors", serialization.isCheckClassDefErrors());
Map dsfClasses = serialization.getDataSerializableFactoryClasses();
Map dsfImpls = serialization.getDataSerializableFactories();
if (!dsfClasses.isEmpty() || !dsfImpls.isEmpty()) {
gen.open("data-serializable-factories");
for (Map.Entry entry : dsfClasses.entrySet()) {
gen.node("data-serializable-factory", entry.getValue(), "factory-id", entry.getKey());
}
for (Map.Entry entry : dsfImpls.entrySet()) {
gen.node("data-serializable-factory",
entry.getValue().getClass().getName(), "factory-id", entry.getKey());
}
gen.close();
}
Map portableClasses = serialization.getPortableFactoryClasses();
Map portableImpls = serialization.getPortableFactories();
if (!portableClasses.isEmpty() || !portableImpls.isEmpty()) {
gen.open("portable-factories");
for (Map.Entry entry : portableClasses.entrySet()) {
gen.node("portable-factory", entry.getValue(), "factory-id", entry.getKey());
}
for (Map.Entry entry : portableImpls.entrySet()) {
gen.node("portable-factory",
entry.getValue().getClass().getName(), "factory-id", entry.getKey());
}
gen.close();
}
serializers(gen, serialization);
//close serialization
gen.close();
}
private static void serializers(XmlGenerator gen, SerializationConfig serialization) {
GlobalSerializerConfig global = serialization.getGlobalSerializerConfig();
Collection serializers = serialization.getSerializerConfigs();
if (global != null || !serializers.isEmpty()) {
gen.open("serializers");
if (global != null) {
gen.node("global-serializer", classNameOrImplClass(global.getClassName(), global.getImplementation()),
"override-java-serialization", global.isOverrideJavaSerialization());
}
for (SerializerConfig serializer : serializers) {
gen.node("serializer", null,
"type-class", classNameOrImplClass(serializer.getTypeClassName(), serializer.getTypeClass()),
"class-name", classNameOrImplClass(serializer.getClassName(), serializer.getImplementation()));
}
//close serializers
gen.close();
}
}
private static void nativeMemory(XmlGenerator gen, NativeMemoryConfig nativeMemory) {
gen.open("native-memory", "enabled", nativeMemory.isEnabled(),
"allocator-type", nativeMemory.getAllocatorType())
.node("size", null, "value", nativeMemory.getSize().getValue(),
"unit", nativeMemory.getSize().getUnit())
.node("min-block-size", nativeMemory.getMinBlockSize())
.node("page-size", nativeMemory.getPageSize())
.node("metadata-space-percentage", nativeMemory.getMetadataSpacePercentage())
.close();
}
private static void proxyFactory(XmlGenerator gen, List proxyFactories) {
if (proxyFactories.isEmpty()) {
return;
}
gen.open("proxy-factories");
for (ProxyFactoryConfig proxyFactory : proxyFactories) {
gen.node("proxy-factory", null,
"class-name", classNameOrImplClass(proxyFactory.getClassName(), proxyFactory.getFactoryImpl()),
"service", proxyFactory.getService());
}
gen.close();
}
private static void loadBalancer(XmlGenerator gen, LoadBalancer loadBalancer) {
if (loadBalancer == null) {
return;
}
String type;
if (loadBalancer instanceof RandomLB) {
type = "random";
} else if (loadBalancer instanceof RoundRobinLB) {
type = "round-robin";
} else {
type = "custom";
}
if ("custom".equals(type)) {
gen.node("load-balancer", loadBalancer.getClass().getName(), "type", type);
} else {
gen.node("load-balancer", null, "type", type);
}
}
private static void nearCaches(XmlGenerator gen, Map nearCacheMap) {
if (nearCacheMap.isEmpty()) {
return;
}
for (Map.Entry entry : nearCacheMap.entrySet()) {
nearCache(gen, entry.getKey(), entry.getValue());
}
}
private static void queryCaches(XmlGenerator gen, Map> queryCaches) {
if (queryCaches.isEmpty()) {
return;
}
gen.open("query-caches");
for (Map.Entry> entry : queryCaches.entrySet()) {
String mapName = entry.getKey();
Map queryCachesPerMap = entry.getValue();
for (QueryCacheConfig queryCache : queryCachesPerMap.values()) {
gen.open("query-cache", "mapName", mapName, "name", queryCache.getName())
.node("include-value", queryCache.isIncludeValue())
.node("in-memory-format", queryCache.getInMemoryFormat())
.node("populate", queryCache.isPopulate())
.node("coalesce", queryCache.isCoalesce())
.node("delay-seconds", queryCache.getDelaySeconds())
.node("batch-size", queryCache.getBatchSize())
.node("buffer-size", queryCache.getBufferSize())
.node("eviction", null, "size", queryCache.getEvictionConfig().getSize(),
"max-size-policy", queryCache.getEvictionConfig().getMaximumSizePolicy(),
"eviction-policy", queryCache.getEvictionConfig().getEvictionPolicy(),
"comparator-class-name", queryCache.getEvictionConfig().getComparatorClassName());
queryCachePredicate(gen, queryCache.getPredicateConfig());
entryListeners(gen, queryCache.getEntryListenerConfigs());
indexes(gen, queryCache.getIndexConfigs());
//close query-cache
gen.close();
}
}
//close query-caches
gen.close();
}
private static void userCodeDeployment(XmlGenerator gen, ClientUserCodeDeploymentConfig userCodeDeployment) {
gen.open("user-code-deployment", "enabled", userCodeDeployment.isEnabled());
List classNames = userCodeDeployment.getClassNames();
if (!classNames.isEmpty()) {
gen.open("classNames");
for (String className : classNames) {
gen.node("className", className);
}
//close classNames
gen.close();
}
List jarPaths = userCodeDeployment.getJarPaths();
if (!jarPaths.isEmpty()) {
gen.open("jarPaths");
for (String jarPath : jarPaths) {
gen.node("jarPath", jarPath);
}
//close jarPaths
gen.close();
}
//close user-code-deployment
gen.close();
}
private static void flakeIdGenerator(XmlGenerator gen, Map flakeIdGenerators) {
for (Map.Entry entry : flakeIdGenerators.entrySet()) {
ClientFlakeIdGeneratorConfig flakeIdGenerator = entry.getValue();
gen.open("flake-id-generator", "name", entry.getKey())
.node("prefetch-count", flakeIdGenerator.getPrefetchCount())
.node("prefetch-validity-millis", flakeIdGenerator.getPrefetchValidityMillis())
.close();
}
}
private static void indexes(XmlGenerator gen, List indexes) {
if (indexes.isEmpty()) {
return;
}
gen.open("indexes");
for (MapIndexConfig index : indexes) {
gen.node("index", index.getAttribute(), "ordered", index.isOrdered());
}
gen.close();
}
private static void entryListeners(XmlGenerator gen, List entryListeners) {
if (entryListeners.isEmpty()) {
return;
}
gen.open("entry-listeners");
for (EntryListenerConfig listener : entryListeners) {
gen.node("entry-listener",
classNameOrImplClass(listener.getClassName(), listener.getImplementation()),
"include-value", listener.isIncludeValue(), "local", listener.isLocal());
}
gen.close();
}
private static void queryCachePredicate(XmlGenerator gen, PredicateConfig predicate) {
String sql = predicate.getSql();
String content = sql != null ? sql : classNameOrImplClass(predicate.getClassName(), predicate.getImplementation());
String type = sql != null ? "sql" : "class-name";
gen.node("predicate", content, "type", type);
}
private static void clusterMembers(XmlGenerator gen, List addresses) {
if (addresses == null || addresses.isEmpty()) {
return;
}
gen.open("cluster-members");
for (String address : addresses) {
gen.node("address", address);
}
gen.close();
}
private static void socketOptions(XmlGenerator gen, SocketOptions socketOptions) {
gen.open("socket-options")
.node("tcp-no-delay", socketOptions.isTcpNoDelay())
.node("keep-alive", socketOptions.isKeepAlive())
.node("reuse-address", socketOptions.isReuseAddress())
.node("linger-seconds", socketOptions.getLingerSeconds())
.node("buffer-size", socketOptions.getBufferSize())
.close();
}
private static void socketInterceptor(XmlGenerator gen, SocketInterceptorConfig socketInterceptor) {
if (socketInterceptor == null) {
return;
}
gen.open("socket-interceptor", "enabled", socketInterceptor.isEnabled())
.node("class-name", classNameOrImplClass(socketInterceptor.getClassName(),
socketInterceptor.getImplementation()))
.appendProperties(socketInterceptor.getProperties())
.close();
}
private static void ssl(XmlGenerator gen, SSLConfig ssl) {
if (ssl == null) {
return;
}
gen.open("ssl", "enabled", ssl.isEnabled())
.node("factory-class-name", classNameOrImplClass(ssl.getFactoryClassName(),
ssl.getFactoryImplementation()))
.appendProperties(ssl.getProperties())
.close();
}
private static void aliasedDiscoveryConfigsGenerator(XmlGenerator gen, List> configs) {
if (configs == null) {
return;
}
for (AliasedDiscoveryConfig c : configs) {
gen.open(AliasedDiscoveryConfigUtils.tagFor(c), "enabled", c.isEnabled());
if (c.isUsePublicIp()) {
gen.node("use-public-ip", "true");
}
for (String key : c.getProperties().keySet()) {
gen.node(key, c.getProperties().get(key));
}
gen.close();
}
}
private static void discovery(XmlGenerator gen, DiscoveryConfig discovery) {
if (discovery.getNodeFilter() == null && discovery.getNodeFilterClass() == null
&& discovery.getDiscoveryStrategyConfigs().isEmpty()) {
return;
}
gen.open("discovery-strategies")
.node("node-filter", null, "class",
classNameOrImplClass(discovery.getNodeFilterClass(), discovery.getNodeFilter()));
for (DiscoveryStrategyConfig strategy : discovery.getDiscoveryStrategyConfigs()) {
gen.open("discovery-strategy", "class", strategy.getClassName(), "enabled", true)
.appendProperties(strategy.getProperties())
.close();
}
gen.close();
}
private static void outboundPort(XmlGenerator gen, Collection outboundPortDefinitions) {
if (outboundPortDefinitions != null && !outboundPortDefinitions.isEmpty()) {
gen.open("outbound-ports");
for (String portDefinitions : outboundPortDefinitions) {
gen.node("ports", portDefinitions);
}
gen.close();
}
}
private static void icmp(XmlGenerator gen, ClientIcmpPingConfig icmp) {
gen.open("icmp-ping", "enabled", icmp.isEnabled())
.node("timeout-milliseconds", icmp.getTimeoutMilliseconds())
.node("interval-milliseconds", icmp.getIntervalMilliseconds())
.node("ttl", icmp.getTtl())
.node("max-attempts", icmp.getMaxAttempts())
.node("echo-fail-fast-on-startup", icmp.isEchoFailFastOnStartup())
.close();
}
private static void nearCache(XmlGenerator gen, String name, NearCacheConfig nearCache) {
EvictionConfig eviction = nearCache.getEvictionConfig();
NearCachePreloaderConfig preloader = nearCache.getPreloaderConfig();
gen.open("near-cache", "name", name)
.node("in-memory-format", nearCache.getInMemoryFormat())
.node("serialize-keys", nearCache.isSerializeKeys())
.node("invalidate-on-change", nearCache.isInvalidateOnChange())
.node("cache-local-entries", nearCache.isCacheLocalEntries())
.node("time-to-live-seconds", nearCache.getTimeToLiveSeconds())
.node("max-idle-seconds", nearCache.getMaxIdleSeconds())
.node("local-update-policy", nearCache.getLocalUpdatePolicy())
.node("eviction", null, "size", eviction.getSize(),
"max-size-policy", eviction.getMaximumSizePolicy(),
"eviction-policy", eviction.getEvictionPolicy(), "comparator-class-name", eviction.getComparatorClassName())
.node("preloader", null, "enabled", preloader.isEnabled(),
"directory", preloader.getDirectory(),
"store-initial-delay-seconds", preloader.getStoreInitialDelaySeconds(),
"store-interval-seconds", preloader.getStoreIntervalSeconds());
//close near-cache
gen.close();
}
private static String classNameOrImplClass(String className, Object impl) {
return !isNullOrEmpty(className) ? className
: impl != null ? impl.getClass().getName()
: null;
}
}