Uses of Class
com.hazelcast.client.config.ClientConfig

Packages that use ClientConfig

Package	Description
com.hazelcast.client	Contains classes/interfaces related to Client
com.hazelcast.client.config	Contains classes related to config for com.hazelcast.client
com.hazelcast.client.util	This package contains some utility classes and the base implementations of the loadbalancer implementations
com.hazelcast.jet	Hazelcast Jet is a distributed computation engine running on top of Hazelcast IMDG technology.
com.hazelcast.jet.cdc	Contains source/sink connectors that deal with Change Data Capture (CDC) events from various databases as well as a generic connector for Debezium CDC sources.
com.hazelcast.jet.core.processor	Contains static utility classes with factories of Jet processors.
com.hazelcast.jet.pipeline	The Pipeline API is Jet's high-level API to build and execute distributed computation jobs.
com.hazelcast.spring.config	Contains config factory classes.

Uses of ClientConfig in com.hazelcast.client

Methods in com.hazelcast.client with parameters of type ClientConfig

Modifier and Type	Method and Description
static HazelcastInstance	HazelcastClient.getOrCreateHazelcastClient(ClientConfig config) Gets or creates a new HazelcastInstance (a new client in a cluster) with a certain name.
void	LoadBalancer.init(Cluster cluster, ClientConfig config) Initializes the LoadBalancer.
static HazelcastInstance	HazelcastClient.newHazelcastClient(ClientConfig config) Creates a new HazelcastInstance (a new client in a cluster).

Uses of ClientConfig in com.hazelcast.client.config

Subclasses of ClientConfig in com.hazelcast.client.config

Modifier and Type	Class and Description
class	ClientClasspathXmlConfig A ClientConfig which is initialized by loading an XML configuration file from the classpath.
class	ClientClasspathYamlConfig A ClientConfig which is initialized by loading an YAML configuration file from the classpath.

Methods in com.hazelcast.client.config that return ClientConfig

Modifier and Type	Method and Description
ClientConfig	ClientConfig.addFlakeIdGeneratorConfig(ClientFlakeIdGeneratorConfig config) Adds a flake ID generator configuration.
ClientConfig	ClientConfig.addLabel(String label) Adds a label for this client Client available
ClientConfig	ClientConfig.addListenerConfig(ListenerConfig listenerConfig) Helper method to add a new ListenerConfig
ClientConfig	ClientConfig.addNearCacheConfig(NearCacheConfig nearCacheConfig) Helper method to add a new NearCacheConfig
ClientConfig	ClientConfig.addProxyFactoryConfig(ProxyFactoryConfig proxyFactoryConfig) Helper method to add a new ProxyFactoryConfig
ClientConfig	ClientConfig.addQueryCacheConfig(String mapName, QueryCacheConfig queryCacheConfig)
ClientConfig	ClientConfig.addReliableTopicConfig(ClientReliableTopicConfig reliableTopicConfig) Adds a ClientReliableTopicConfig.
ClientConfig	YamlClientConfigBuilder.build()
ClientConfig	XmlClientConfigBuilder.build()
ClientConfig	YamlClientConfigBuilder.build(ClassLoader classLoader)
ClientConfig	XmlClientConfigBuilder.build(ClassLoader classLoader)
static ClientConfig	ClientConfig.load() Populates Hazelcast ClientConfig object from an external configuration file.
ClientConfig	ClientConfig.setAltoConfig(ClientAltoConfig altoConfig) Sets the Alto configuration.
ClientConfig	ClientConfig.setBackupAckToClientEnabled(boolean backupAckToClientEnabled) This feature reduces number of hops and increase performance for smart clients.
ClientConfig	ClientConfig.setClassLoader(ClassLoader classLoader) Sets the classLoader which is used by serialization and listener configuration
ClientConfig	ClientConfig.setClusterName(String clusterName)
ClientConfig	ClientConfig.setConfigPatternMatcher(ConfigPatternMatcher configPatternMatcher) Sets the pattern matcher which is used to match item names to configuration objects.
ClientConfig	ClientConfig.setConnectionStrategyConfig(ClientConnectionStrategyConfig connectionStrategyConfig)
ClientConfig	ClientConfig.setCredentials(Credentials credentials) Shortcut for getSecurityConfig().setCredentials()
ClientConfig	ClientConfig.setFlakeIdGeneratorConfigMap(Map<String,ClientFlakeIdGeneratorConfig> map) Sets the map of FlakeIdGenerator configurations, mapped by config name.
ClientConfig	ClientConfig.setInstanceName(String instanceName)
ClientConfig	ClientConfig.setInstanceTrackingConfig(InstanceTrackingConfig instanceTrackingConfig) Returns the configuration for tracking use of this Hazelcast instance.
ClientConfig	ClientConfig.setLabels(Set<String> labels) Set labels for the client.
ClientConfig	ClientConfig.setListenerConfigs(List<ListenerConfig> listenerConfigs) Sets all ListenerConfig's
ClientConfig	ClientConfig.setLoadBalancer(LoadBalancer loadBalancer) Sets the LoadBalancer.
ClientConfig	ClientConfig.setLoadBalancerClassName(String loadBalancerClassName) Sets load balancer class name.
ClientConfig	ClientConfig.setManagedContext(ManagedContext managedContext) Sets ManagedContext
ClientConfig	ClientConfig.setMetricsConfig(ClientMetricsConfig metricsConfig) Sets the metrics collection config.
ClientConfig	ClientConfig.setNativeMemoryConfig(NativeMemoryConfig nativeMemoryConfig)
ClientConfig	ClientConfig.setNearCacheConfigMap(Map<String,NearCacheConfig> nearCacheConfigMap) Sets all NearCacheConfig's with the provided map
ClientConfig	ClientConfig.setNetworkConfig(ClientNetworkConfig networkConfig) Sets ClientNetworkConfig
ClientConfig	ClientConfig.setProperties(Properties properties) sets all properties
ClientConfig	ClientConfig.setProperty(String name, String value) Sets the value of a named property.
ClientConfig	ClientConfig.setProxyFactoryConfigs(List<ProxyFactoryConfig> proxyFactoryConfigs) Sets the ProxyFactoryConfig
ClientConfig	ClientConfig.setQueryCacheConfigs(Map<String,Map<String,QueryCacheConfig>> queryCacheConfigs)
ClientConfig	ClientConfig.setReliableTopicConfigMap(Map<String,ClientReliableTopicConfig> map) Sets the map of ClientReliableTopicConfig, mapped by config name.
ClientConfig	ClientConfig.setSecurityConfig(ClientSecurityConfig securityConfig) Sets ClientSecurityConfig object
ClientConfig	ClientConfig.setSerializationConfig(SerializationConfig serializationConfig) Sets SerializationConfig
ClientConfig	ClientConfig.setSqlConfig(ClientSqlConfig sqlConfig) Sets the configuration for the SQL feature.
ClientConfig	ClientConfig.setUserCodeDeploymentConfig(ClientUserCodeDeploymentConfig userCodeDeploymentConfig) Set User Code Deployment configuration
ClientConfig	ClientConfig.setUserContext(ConcurrentMap<String,Object> userContext)

Methods in com.hazelcast.client.config that return types with arguments of type ClientConfig

Modifier and Type	Method and Description
List<ClientConfig>	ClientFailoverConfig.getClientConfigs() Gets the configured list of alternative client configurations.

Methods in com.hazelcast.client.config with parameters of type ClientConfig

Modifier and Type	Method and Description
ClientFailoverConfig	ClientFailoverConfig.addClientConfig(ClientConfig clientConfig) Adds the client config to the end of the alternative client configurations list.
static String	ClientConfigXmlGenerator.generate(ClientConfig clientConfig) Convenience for ClientConfigXmlGenerator.generate(ClientConfig, int), which generates the xml without any formatting.
static String	ClientConfigXmlGenerator.generate(ClientConfig clientConfig, int indent) Transforms the given ClientConfig to xml string formatting the output with given indent, -1 means no formatting.

Method parameters in com.hazelcast.client.config with type arguments of type ClientConfig

Modifier and Type	Method and Description
ClientFailoverConfig	ClientFailoverConfig.setClientConfigs(List<ClientConfig> clientConfigs) Sets the configured list of alternative client configurations.

Constructors in com.hazelcast.client.config with parameters of type ClientConfig

Constructor and Description
ClientConfig(ClientConfig config)

Uses of ClientConfig in com.hazelcast.client.util

Methods in com.hazelcast.client.util with parameters of type ClientConfig

Modifier and Type	Method and Description
void	AbstractLoadBalancer.init(Cluster cluster, ClientConfig config)
void	StaticLB.init(Cluster cluster, ClientConfig config)

Constructors in com.hazelcast.client.util with parameters of type ClientConfig

Constructor and Description
ClientStateListener(ClientConfig clientConfig) Registers this instance with the provided client configuration

Uses of ClientConfig in com.hazelcast.jet

Methods in com.hazelcast.jet with parameters of type ClientConfig

Modifier and Type	Method and Description
static JetInstance	Jet.newJetClient(ClientConfig config) Deprecated. since 5.0 Use HazelcastClient.newHazelcastClient(ClientConfig) and then get JetService from the created HazelcastInstance client by using HazelcastInstance.getJet()}.

Uses of ClientConfig in com.hazelcast.jet.cdc

Methods in com.hazelcast.jet.cdc with parameters of type ClientConfig

Modifier and Type

Method and Description

static <K,V> Sink<ChangeRecord>

CdcSinks.remoteMap(String mapName, ClientConfig clientConfig, FunctionEx<? super ChangeRecord,? extends K> keyFn, FunctionEx<? super ChangeRecord,? extends V> valueFn) Returns a sink equivalent to CdcSinks.map(java.lang.String, com.hazelcast.function.FunctionEx<? super com.hazelcast.jet.cdc.ChangeRecord, ? extends K>, com.hazelcast.function.FunctionEx<? super com.hazelcast.jet.cdc.ChangeRecord, ? extends V>), but for a map in a remote Hazelcast cluster identified by the supplied ClientConfig.

Uses of ClientConfig in com.hazelcast.jet.core.processor

Methods in com.hazelcast.jet.core.processor with parameters of type ClientConfig

Modifier and Type	Method and Description
static <T,K,V> ProcessorMetaSupplier	SinkProcessors.mergeRemoteMapP(String mapName, ClientConfig clientConfig, FunctionEx<? super T,? extends K> toKeyFn, FunctionEx<? super T,? extends V> toValueFn, BinaryOperatorEx<V> mergeFn) Returns a supplier of processors for Sinks.remoteMapWithMerging(String, ClientConfig, FunctionEx, FunctionEx, BinaryOperatorEx).
static ProcessorSupplier	SourceProcessors.readRemoteCacheP(String cacheName, ClientConfig clientConfig) Returns a supplier of processors for Sources.remoteCache(String, ClientConfig).
static ProcessorMetaSupplier	SourceProcessors.readRemoteListP(String listName, ClientConfig clientConfig) Returns a supplier of processors for Sources.remoteList(String, ClientConfig).
static ProcessorSupplier	SourceProcessors.readRemoteMapP(String mapName, ClientConfig clientConfig) Returns a supplier of processors for Sources.remoteMap(String, ClientConfig).
static <T,K,V> ProcessorSupplier	SourceProcessors.readRemoteMapP(String mapName, ClientConfig clientConfig, Predicate<K,V> predicate, Projection<? super Map.Entry<K,V>,? extends T> projection) Returns a supplier of processors for Sources.remoteMap(String, ClientConfig, Predicate, Projection).
static <K,V> ProcessorMetaSupplier	SourceProcessors.streamRemoteCacheP(String cacheName, ClientConfig clientConfig, JournalInitialPosition initialPos, EventTimePolicy<? super Map.Entry<K,V>> eventTimePolicy) Returns a supplier of processors for Sources.remoteCacheJournal(String, ClientConfig, JournalInitialPosition).
static <T,K,V> ProcessorMetaSupplier	SourceProcessors.streamRemoteCacheP(String cacheName, ClientConfig clientConfig, PredicateEx<? super EventJournalCacheEvent<K,V>> predicateFn, FunctionEx<? super EventJournalCacheEvent<K,V>,? extends T> projectionFn, JournalInitialPosition initialPos, EventTimePolicy<? super T> eventTimePolicy) Returns a supplier of processors for Sources.remoteCacheJournal(String, ClientConfig, JournalInitialPosition, FunctionEx, PredicateEx).
static <K,V> ProcessorMetaSupplier	SourceProcessors.streamRemoteMapP(String mapName, ClientConfig clientConfig, JournalInitialPosition initialPos, EventTimePolicy<? super Map.Entry<K,V>> eventTimePolicy) Returns a supplier of processors for Sources.remoteMapJournal(String, ClientConfig, JournalInitialPosition).
static <T,K,V> ProcessorMetaSupplier	SourceProcessors.streamRemoteMapP(String mapName, ClientConfig clientConfig, PredicateEx<? super EventJournalMapEvent<K,V>> predicateFn, FunctionEx<? super EventJournalMapEvent<K,V>,? extends T> projectionFn, JournalInitialPosition initialPos, EventTimePolicy<? super T> eventTimePolicy) Returns a supplier of processors for Sources.remoteMapJournal(String, ClientConfig, JournalInitialPosition, FunctionEx, PredicateEx).
static <T,K,V> ProcessorMetaSupplier	SinkProcessors.updateRemoteMapP(String mapName, ClientConfig clientConfig, FunctionEx<? super T,? extends K> toKeyFn, BiFunctionEx<? super V,? super T,? extends V> updateFn) Returns a supplier of processors for Sinks.remoteMapWithUpdating(String, ClientConfig, FunctionEx , BiFunctionEx).
static <T,K,V,R> ProcessorMetaSupplier	SinkProcessors.updateRemoteMapP(String mapName, ClientConfig clientConfig, FunctionEx<? super T,? extends K> toKeyFn, FunctionEx<? super T,? extends EntryProcessor<K,V,R>> toEntryProcessorFn) Returns a supplier of processors for Sinks.remoteMapWithEntryProcessor(String, ClientConfig, FunctionEx, FunctionEx).
static ProcessorMetaSupplier	SinkProcessors.writeRemoteCacheP(String cacheName, ClientConfig clientConfig) Returns a supplier of processors for Sinks.remoteCache(String, ClientConfig).
static ProcessorMetaSupplier	SinkProcessors.writeRemoteListP(String listName, ClientConfig clientConfig) Returns a supplier of processors for Sinks.remoteList(String, ClientConfig).
static ProcessorMetaSupplier	SinkProcessors.writeRemoteMapP(String mapName, ClientConfig clientConfig) Returns a supplier of processors for Sinks.remoteMap(String, ClientConfig).
static <T,K,V> ProcessorMetaSupplier	SinkProcessors.writeRemoteMapP(String mapName, ClientConfig clientConfig, FunctionEx<? super T,? extends K> toKeyFn, FunctionEx<? super T,? extends V> toValueFn) Returns a supplier of processors for Sinks.remoteMap(String, ClientConfig, FunctionEx, FunctionEx).

Uses of ClientConfig in com.hazelcast.jet.pipeline

Methods in com.hazelcast.jet.pipeline with parameters of type ClientConfig

Modifier and Type	Method and Description
static <K,V> BatchSource<Map.Entry<K,V>>	Sources.remoteCache(String cacheName, ClientConfig clientConfig) Returns a source that fetches entries from the Hazelcast ICache with the specified name in a remote cluster identified by the supplied ClientConfig and emits them as Map.Entry.
static <T extends Map.Entry> Sink<T>	Sinks.remoteCache(String cacheName, ClientConfig clientConfig) Returns a sink that puts Map.Entrys it receives into a Hazelcast ICache with the specified name in a remote cluster identified by the supplied ClientConfig.
static <K,V> StreamSource<Map.Entry<K,V>>	Sources.remoteCacheJournal(String cacheName, ClientConfig clientConfig, JournalInitialPosition initialPos) Convenience for Sources.remoteCacheJournal(String, ClientConfig, JournalInitialPosition, FunctionEx, PredicateEx) which will pass only CREATED and UPDATED events and will project the event's key and new value into a Map.Entry.
static <T,K,V> StreamSource<T>	Sources.remoteCacheJournal(String cacheName, ClientConfig clientConfig, JournalInitialPosition initialPos, FunctionEx<? super EventJournalCacheEvent<K,V>,? extends T> projectionFn, PredicateEx<? super EventJournalCacheEvent<K,V>> predicateFn) Returns a source that will stream the EventJournalCacheEvent events of the Hazelcast ICache with the specified name from a remote cluster.
static <T> Sink<T>	Sinks.remoteList(String listName, ClientConfig clientConfig) Returns a sink that adds the items it receives to a Hazelcast IList with the specified name in a remote cluster identified by the supplied ClientConfig.
static <T> BatchSource<T>	Sources.remoteList(String listName, ClientConfig clientConfig) Returns a source that emits items retrieved from a Hazelcast IList in a remote cluster identified by the supplied ClientConfig.
static <K,V> Sink<Map.Entry<K,V>>	Sinks.remoteMap(String mapName, ClientConfig clientConfig) Returns a sink that puts Map.Entrys it receives into a Hazelcast IMap with the specified name in a remote cluster identified by the supplied ClientConfig.
static <K,V> BatchSource<Map.Entry<K,V>>	Sources.remoteMap(String mapName, ClientConfig clientConfig) Returns a source that fetches entries from the Hazelcast IMap with the specified name in a remote cluster identified by the supplied ClientConfig and emits them as Map.Entry.
static <T,K,V> Sink<T>	Sinks.remoteMap(String mapName, ClientConfig clientConfig, FunctionEx<? super T,? extends K> toKeyFn, FunctionEx<? super T,? extends V> toValueFn) Returns a sink that uses the supplied functions to extract the key and value with which to put to a Hazelcast IMap in a remote cluster identified by the supplied ClientConfig.
static <T,K,V> BatchSource<T>	Sources.remoteMap(String mapName, ClientConfig clientConfig, Predicate<K,V> predicate, Projection<? super Map.Entry<K,V>,? extends T> projection) Returns a source that fetches entries from a remote Hazelcast IMap with the specified name in a remote cluster identified by the supplied ClientConfig.
static <K,V> StreamSource<Map.Entry<K,V>>	Sources.remoteMapJournal(String mapName, ClientConfig clientConfig, JournalInitialPosition initialPos) Convenience for Sources.remoteMapJournal(String, ClientConfig, JournalInitialPosition, FunctionEx, PredicateEx) which will pass only ADDED and UPDATED events and will project the event's key and new value into a Map.Entry.
static <T,K,V> StreamSource<T>	Sources.remoteMapJournal(String mapName, ClientConfig clientConfig, JournalInitialPosition initialPos, FunctionEx<? super EventJournalMapEvent<K,V>,? extends T> projectionFn, PredicateEx<? super EventJournalMapEvent<K,V>> predicateFn) Returns a source that will stream the EventJournalMapEvent events of the Hazelcast IMap with the specified name from a remote cluster.
static <E,K,V,R> Sink<E>	Sinks.remoteMapWithEntryProcessor(String mapName, ClientConfig clientConfig, FunctionEx<? super E,? extends K> toKeyFn, FunctionEx<? super E,? extends EntryProcessor<K,V,R>> toEntryProcessorFn) Returns a sink equivalent to Sinks.mapWithEntryProcessor(java.lang.String, com.hazelcast.function.FunctionEx<? super E, ? extends K>, com.hazelcast.function.FunctionEx<? super E, ? extends com.hazelcast.map.EntryProcessor<K, V, R>>), but for a map in a remote Hazelcast cluster identified by the supplied ClientConfig.
static <K,V> Sink<Map.Entry<K,V>>	Sinks.remoteMapWithMerging(String mapName, ClientConfig clientConfig, BinaryOperatorEx<V> mergeFn) Convenience for Sinks.remoteMapWithMerging(java.lang.String, com.hazelcast.client.config.ClientConfig, com.hazelcast.function.FunctionEx<? super T, ? extends K>, com.hazelcast.function.FunctionEx<? super T, ? extends V>, com.hazelcast.function.BinaryOperatorEx<V>) with Map.Entry as input item.
static <T,K,V> Sink<T>	Sinks.remoteMapWithMerging(String mapName, ClientConfig clientConfig, FunctionEx<? super T,? extends K> toKeyFn, FunctionEx<? super T,? extends V> toValueFn, BinaryOperatorEx<V> mergeFn) Returns a sink equivalent to Sinks.mapWithMerging(String, BinaryOperatorEx), but for a map in a remote Hazelcast cluster identified by the supplied ClientConfig.
static <K,V,E extends Map.Entry<K,V>> Sink<E>	Sinks.remoteMapWithUpdating(String mapName, ClientConfig clientConfig, BiFunctionEx<? super V,? super E,? extends V> updateFn) Convenience for Sinks.remoteMapWithUpdating(java.lang.String, com.hazelcast.client.config.ClientConfig, com.hazelcast.function.FunctionEx<? super T, ? extends K>, com.hazelcast.function.BiFunctionEx<? super V, ? super T, ? extends V>) with Map.Entry as input item.
static <T,K,V> Sink<T>	Sinks.remoteMapWithUpdating(String mapName, ClientConfig clientConfig, FunctionEx<? super T,? extends K> toKeyFn, BiFunctionEx<? super V,? super T,? extends V> updateFn) Returns a sink equivalent to Sinks.mapWithUpdating(java.lang.String, com.hazelcast.function.FunctionEx<? super T, ? extends K>, com.hazelcast.function.BiFunctionEx<? super V, ? super T, ? extends V>), but for a map in a remote Hazelcast cluster identified by the supplied ClientConfig.
static <T> Sink<T>	Sinks.remoteReliableTopic(String reliableTopicName, ClientConfig clientConfig) Returns a sink which publishes the items it receives to a distributed reliable topic with the provided name in a remote cluster identified by the supplied ClientConfig.

Uses of ClientConfig in com.hazelcast.spring.config

Methods in com.hazelcast.spring.config that return ClientConfig

Modifier and Type	Method and Description
static ClientConfig	ConfigFactory.newClientConfig()