| Package | Description | 
|---|---|
| com.hazelcast.client | Contains classes/interfaces related to Client | 
| com.hazelcast.client.config | Contains classes related to config for com.hazelcast.client | 
| 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). | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | ClientClasspathXmlConfigA  ClientConfigwhich is initialized by loading an XML configuration file from the classpath. | 
| class  | ClientClasspathYamlConfigA  ClientConfigwhich is initialized by loading an YAML configuration file from the classpath. | 
| 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  Clientavailable | 
| 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 | XmlClientConfigBuilder. build() | 
| ClientConfig | YamlClientConfigBuilder. build() | 
| ClientConfig | XmlClientConfigBuilder. build(ClassLoader classLoader) | 
| ClientConfig | YamlClientConfigBuilder. build(ClassLoader classLoader) | 
| static ClientConfig | ClientConfig. load()Populates Hazelcast  ClientConfigobject from an external configuration file. | 
| 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  FlakeIdGeneratorconfigurations,
 mapped by config name. | 
| ClientConfig | ClientConfig. setInstanceName(String instanceName) | 
| 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  ClientSecurityConfigobject | 
| ClientConfig | ClientConfig. setSerializationConfig(SerializationConfig serializationConfig)Sets  SerializationConfig | 
| ClientConfig | ClientConfig. setUserCodeDeploymentConfig(ClientUserCodeDeploymentConfig userCodeDeploymentConfig)Set User Code Deployment configuration | 
| ClientConfig | ClientConfig. setUserContext(ConcurrentMap<String,Object> userContext) | 
| Modifier and Type | Method and Description | 
|---|---|
| List<ClientConfig> | ClientFailoverConfig. getClientConfigs() | 
| Modifier and Type | Method and Description | 
|---|---|
| ClientFailoverConfig | ClientFailoverConfig. addClientConfig(ClientConfig clientConfig) | 
| 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  ClientConfigto xml string
 formatting the output with givenindent, -1 means no
 formatting. | 
| Modifier and Type | Method and Description | 
|---|---|
| ClientFailoverConfig | ClientFailoverConfig. setClientConfigs(List<ClientConfig> clientConfigs) | 
| Constructor and Description | 
|---|
| ClientConfig(ClientConfig config) | 
Copyright © 2020 Hazelcast, Inc.. All rights reserved.