| 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.impl.clientside | 
 Contains most of the client side HazelcastInstance implementation functionality. 
 | 
| com.hazelcast.client.impl.querycache.subscriber | 
 Contains Hazelcast Enterprise version client-side query cache
 subscriber implementation classes. 
 | 
| com.hazelcast.client.spi | 
 Contains classes/interfaces related to the Hazelcast client Service Provider Interface. 
 | 
| com.hazelcast.client.util | 
 This package contains some utility classes and the base implementations of the
 loadbalancer implementations 
 | 
| 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  | 
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. | 
| Modifier and Type | Method and Description | 
|---|---|
ClientConfig | 
ClientConfig.addAddress(String... addresses)
Deprecated.  
 | 
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.addNearCacheConfig(String name,
                  NearCacheConfig nearCacheConfig)
Deprecated.  
 | 
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.setAddresses(List<String> addresses)
Deprecated.  
 | 
ClientConfig | 
ClientConfig.setClassLoader(ClassLoader classLoader)
Sets the classLoader which is used by serialization and listener configuration 
 | 
ClientConfig | 
ClientConfig.setConnectionAttemptLimit(int connectionAttemptLimit)
Deprecated.  
 | 
ClientConfig | 
ClientConfig.setConnectionAttemptPeriod(int connectionAttemptPeriod)
Deprecated.  
 | 
ClientConfig | 
ClientConfig.setConnectionStrategyConfig(ClientConnectionStrategyConfig connectionStrategyConfig)  | 
ClientConfig | 
ClientConfig.setConnectionTimeout(int connectionTimeout)
Deprecated.  
 | 
ClientConfig | 
ClientConfig.setCredentials(Credentials credentials)
Sets  
Credentials | 
ClientConfig | 
ClientConfig.setExecutorPoolSize(int executorPoolSize)
Sets Client side Executor pool size. 
 | 
ClientConfig | 
ClientConfig.setFlakeIdGeneratorConfigMap(Map<String,ClientFlakeIdGeneratorConfig> map)
Sets the map of  
FlakeIdGenerator configurations,
 mapped by config name. | 
ClientConfig | 
ClientConfig.setGroupConfig(GroupConfig groupConfig)
Sets  
GroupConfig | 
ClientConfig | 
ClientConfig.setLabels(Set<String> labels)
Set labels for the client. 
 | 
ClientConfig | 
ClientConfig.setLicenseKey(String licenseKey)
Deprecated. 
 
As of Hazelcast 3.10.3, enterprise license keys are required only for members, and not for clients 
 | 
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.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.setRedoOperation(boolean redoOperation)
Deprecated.  
 | 
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.setSmartRouting(boolean smartRouting)
Deprecated.  
 | 
ClientConfig | 
ClientConfig.setSocketInterceptorConfig(SocketInterceptorConfig socketInterceptorConfig)
Deprecated.  
 | 
ClientConfig | 
ClientConfig.setSocketOptions(SocketOptions socketOptions)
Deprecated.  
 | 
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 List<DiscoveryStrategyConfig> | 
ClientAliasedDiscoveryConfigUtils.createDiscoveryStrategyConfigs(ClientConfig config)
Extracts aliased discovery configs from  
config and creates a list of DiscoveryStrategyConfig out of them. | 
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. | 
| Modifier and Type | Method and Description | 
|---|---|
ClientFailoverConfig | 
ClientFailoverConfig.setClientConfigs(List<ClientConfig> clientConfigs)  | 
| Constructor and Description | 
|---|
ClientConfig(ClientConfig config)  | 
| Modifier and Type | Method and Description | 
|---|---|
ClientConfig | 
HazelcastClientInstanceImpl.getClientConfig()  | 
ClientConfig | 
HazelcastClientProxy.getClientConfig()  | 
static ClientConfig | 
FailoverClientConfigSupport.resolveClientConfig(ClientConfig config)
If clientConfig is  
null, the client configuration is loaded
 using the resolution logic as described in HazelcastClient.newHazelcastClient()
 
 Used with
 HazelcastClient.newHazelcastClient() or
 HazelcastClient.newHazelcastClient(ClientConfig) | 
| Modifier and Type | Method and Description | 
|---|---|
static ClientConfig | 
FailoverClientConfigSupport.resolveClientConfig(ClientConfig config)
If clientConfig is  
null, the client configuration is loaded
 using the resolution logic as described in HazelcastClient.newHazelcastClient()
 
 Used with
 HazelcastClient.newHazelcastClient() or
 HazelcastClient.newHazelcastClient(ClientConfig) | 
| Constructor and Description | 
|---|
HazelcastClientInstanceImpl(String instanceName,
                           ClientConfig clientConfig,
                           ClientFailoverConfig clientFailoverConfig,
                           ClientConnectionManagerFactory clientConnectionManagerFactory,
                           AddressProvider externalAddressProvider)  | 
| Constructor and Description | 
|---|
ClientQueryCacheConfigurator(ClientConfig clientConfig,
                            QueryCacheEventService eventService)  | 
| Modifier and Type | Method and Description | 
|---|---|
ClientConfig | 
ClientContext.getClientConfig()  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
ProxyManager.init(ClientConfig config,
    ClientContext clientContext)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
AbstractLoadBalancer.init(Cluster cluster,
    ClientConfig config)  | 
void | 
StaticLB.init(Cluster cluster,
    ClientConfig config)  | 
| Constructor and Description | 
|---|
ClientStateListener(ClientConfig clientConfig)
Registers this instance with the provided client configuration 
 | 
Copyright © 2021 Hazelcast, Inc.. All Rights Reserved.