ClientConfig (Hazelcast Root 5.3.8 API)

java.lang.Object
- com.hazelcast.client.config.ClientConfig

Direct Known Subclasses:

ClientClasspathXmlConfig, ClientClasspathYamlConfig
```
public class ClientConfig
extends Object
```
Main configuration to setup a Hazelcast Client

Constructor Summary

Constructors
Constructor and Description

ClientConfig()

ClientConfig(ClientConfig config)

Constructors
Constructor and Description
`ClientConfig()`
`ClientConfig(ClientConfig config)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClientConfig`	`addFlakeIdGeneratorConfig(ClientFlakeIdGeneratorConfig config)` Adds a flake ID generator configuration.
`ClientConfig`	`addLabel(String label)` Adds a label for this client `Client` available
`ClientConfig`	`addListenerConfig(ListenerConfig listenerConfig)` Helper method to add a new ListenerConfig
`ClientConfig`	`addNearCacheConfig(NearCacheConfig nearCacheConfig)` Helper method to add a new NearCacheConfig
`ClientConfig`	`addProxyFactoryConfig(ProxyFactoryConfig proxyFactoryConfig)` Helper method to add a new `ProxyFactoryConfig`
`ClientConfig`	`addQueryCacheConfig(String mapName, QueryCacheConfig queryCacheConfig)`
`ClientConfig`	`addReliableTopicConfig(ClientReliableTopicConfig reliableTopicConfig)` Adds a ClientReliableTopicConfig.
`boolean`	`equals(Object obj)`
`ClientFlakeIdGeneratorConfig`	`findFlakeIdGeneratorConfig(String name)` Returns a `ClientFlakeIdGeneratorConfig` configuration for the given flake ID generator name.
`ClassLoader`	`getClassLoader()` Gets the classLoader
`String`	`getClusterName()` Returns the configured cluster name.
`ConfigPatternMatcher`	`getConfigPatternMatcher()` Returns the pattern matcher which is used to match item names to configuration objects.
`ClientConnectionStrategyConfig`	`getConnectionStrategyConfig()`
`ClientFlakeIdGeneratorConfig`	`getFlakeIdGeneratorConfig(String name)` Returns the `ClientFlakeIdGeneratorConfig` for the given name, creating one if necessary and adding it to the collection of known configurations.
`Map<String,ClientFlakeIdGeneratorConfig>`	`getFlakeIdGeneratorConfigMap()` Returns the map of `FlakeIdGenerator` configurations, mapped by config name.
`String`	`getInstanceName()`
`InstanceTrackingConfig`	`getInstanceTrackingConfig()` Returns the configuration for tracking use of this Hazelcast instance.
`Set<String>`	`getLabels()`
`List<ListenerConfig>`	`getListenerConfigs()` Gets list of all configured `ListenerConfig`'s
`LoadBalancer`	`getLoadBalancer()` Gets LoadBalancer
`String`	`getLoadBalancerClassName()` Gets load balancer class name
`ManagedContext`	`getManagedContext()` Gets `ManagedContext`
`ClientMetricsConfig`	`getMetricsConfig()` Returns the metrics collection config.
`NativeMemoryConfig`	`getNativeMemoryConfig()`
`NearCacheConfig`	`getNearCacheConfig(String name)` Gets the `NearCacheConfig` configured for the map / cache with name
`Map<String,NearCacheConfig>`	`getNearCacheConfigMap()` Map of all configured NearCacheConfig's with the name key and configuration as the value
`ClientNetworkConfig`	`getNetworkConfig()` Gets `ClientNetworkConfig`
`QueryCacheConfig`	`getOrCreateQueryCacheConfig(String mapName, String cacheName)`
`QueryCacheConfig`	`getOrNullQueryCacheConfig(String mapName, String cacheName)`
`Properties`	`getProperties()` Gets `Properties` object
`String`	`getProperty(String name)` Gets a named property already set or from system properties if not exists.
`List<ProxyFactoryConfig>`	`getProxyFactoryConfigs()` Gets list of `ProxyFactoryConfig`
`Map<String,Map<String,QueryCacheConfig>>`	`getQueryCacheConfigs()`
`ClientReliableTopicConfig`	`getReliableTopicConfig(String name)` Gets the ClientReliableTopicConfig for a given reliable topic name.
`Map<String,ClientReliableTopicConfig>`	`getReliableTopicConfigMap()` Returns the map of reliable topic configurations, mapped by config name.
`ClientSecurityConfig`	`getSecurityConfig()` Gets `ClientSecurityConfig` object which allows client credentials configuration.
`SerializationConfig`	`getSerializationConfig()` Gets `SerializationConfig`
`ClientSqlConfig`	`getSqlConfig()` Returns the configuration for the SQL feature.
`ClientTpcConfig`	`getTpcConfig()` Returns the ClientTpcConfig
`ClientUserCodeDeploymentConfig`	`getUserCodeDeploymentConfig()` Get current configuration of User Code Deployment.
`ConcurrentMap<String,Object>`	`getUserContext()`
`int`	`hashCode()`
`boolean`	`isBackupAckToClientEnabled()` Note that backup acks to client can be enabled only for smart client.
`static ClientConfig`	`load()` Populates Hazelcast `ClientConfig` object from an external configuration file.
`ClientConfig`	`setBackupAckToClientEnabled(boolean backupAckToClientEnabled)` This feature reduces number of hops and increase performance for smart clients.
`ClientConfig`	`setClassLoader(ClassLoader classLoader)` Sets the classLoader which is used by serialization and listener configuration
`ClientConfig`	`setClusterName(String clusterName)`
`ClientConfig`	`setConfigPatternMatcher(ConfigPatternMatcher configPatternMatcher)` Sets the pattern matcher which is used to match item names to configuration objects.
`ClientConfig`	`setConnectionStrategyConfig(ClientConnectionStrategyConfig connectionStrategyConfig)`
`ClientConfig`	`setCredentials(Credentials credentials)` Shortcut for `getSecurityConfig().setCredentials()`
`ClientConfig`	`setFlakeIdGeneratorConfigMap(Map<String,ClientFlakeIdGeneratorConfig> map)` Sets the map of `FlakeIdGenerator` configurations, mapped by config name.
`ClientConfig`	`setInstanceName(String instanceName)`
`ClientConfig`	`setInstanceTrackingConfig(InstanceTrackingConfig instanceTrackingConfig)` Returns the configuration for tracking use of this Hazelcast instance.
`ClientConfig`	`setLabels(Set<String> labels)` Set labels for the client.
`ClientConfig`	`setListenerConfigs(List<ListenerConfig> listenerConfigs)` Sets all `ListenerConfig`'s
`ClientConfig`	`setLoadBalancer(LoadBalancer loadBalancer)` Sets the `LoadBalancer`.
`ClientConfig`	`setLoadBalancerClassName(String loadBalancerClassName)` Sets load balancer class name.
`ClientConfig`	`setManagedContext(ManagedContext managedContext)` Sets `ManagedContext`
`ClientConfig`	`setMetricsConfig(ClientMetricsConfig metricsConfig)` Sets the metrics collection config.
`ClientConfig`	`setNativeMemoryConfig(NativeMemoryConfig nativeMemoryConfig)`
`ClientConfig`	`setNearCacheConfigMap(Map<String,NearCacheConfig> nearCacheConfigMap)` Sets all `NearCacheConfig`'s with the provided map
`ClientConfig`	`setNetworkConfig(ClientNetworkConfig networkConfig)` Sets `ClientNetworkConfig`
`ClientConfig`	`setProperties(Properties properties)` sets all properties
`ClientConfig`	`setProperty(String name, String value)` Sets the value of a named property.
`ClientConfig`	`setProxyFactoryConfigs(List<ProxyFactoryConfig> proxyFactoryConfigs)` Sets the `ProxyFactoryConfig`
`ClientConfig`	`setQueryCacheConfigs(Map<String,Map<String,QueryCacheConfig>> queryCacheConfigs)`
`ClientConfig`	`setReliableTopicConfigMap(Map<String,ClientReliableTopicConfig> map)` Sets the map of `ClientReliableTopicConfig`, mapped by config name.
`ClientConfig`	`setSecurityConfig(ClientSecurityConfig securityConfig)` Sets `ClientSecurityConfig` object
`ClientConfig`	`setSerializationConfig(SerializationConfig serializationConfig)` Sets `SerializationConfig`
`ClientConfig`	`setSqlConfig(ClientSqlConfig sqlConfig)` Sets the configuration for the SQL feature.
`ClientConfig`	`setTpcConfig(ClientTpcConfig tpcConfig)` Sets the TpcConfig
`ClientConfig`	`setUserCodeDeploymentConfig(ClientUserCodeDeploymentConfig userCodeDeploymentConfig)` Set User Code Deployment configuration
`ClientConfig`	`setUserContext(ConcurrentMap<String,Object> userContext)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ClientConfig
```
public ClientConfig()
```
  - ClientConfig
```
public ClientConfig(ClientConfig config)
```
- Method Detail
  - load
```
public static ClientConfig load()
```
    Populates Hazelcast ClientConfig object from an external configuration file.
    It tries to load Hazelcast Client configuration from a list of well-known locations, and then applies overrides found in environment variables/system properties When no location contains Hazelcast Client configuration then it returns default.
    Note that the same mechanism is used when calling HazelcastClient.newHazelcastClient().
    
    Returns:
    
    ClientConfig created from a file when exists, otherwise default.
  - setConfigPatternMatcher
```
public ClientConfig setConfigPatternMatcher(ConfigPatternMatcher configPatternMatcher)
```
    Sets the pattern matcher which is used to match item names to configuration objects. By default the MatchingPointConfigPatternMatcher is used.
    
    Parameters:
    
    configPatternMatcher - the pattern matcher
    
    Returns:
    
    this configuration
    
    Throws:
    
    IllegalArgumentException - if the pattern matcher is null
  - getConfigPatternMatcher
```
public ConfigPatternMatcher getConfigPatternMatcher()
```
    Returns the pattern matcher which is used to match item names to configuration objects. By default the MatchingPointConfigPatternMatcher is used.
    
    Returns:
    
    the pattern matcher
  - getProperty
```
public String getProperty(String name)
```
    Gets a named property already set or from system properties if not exists.
    
    Parameters:
    
    name - property name
    
    Returns:
    
    value of the property
  - setProperty
```
public ClientConfig setProperty(String name,
                                String value)
```
    Sets the value of a named property.
    
    Parameters:
    
    name - property name
    
    value - value of the property
    
    Returns:
    
    configured ClientConfig for chaining
  - getProperties
```
public Properties getProperties()
```
    Gets Properties object
    
    Returns:
    
    Properties object
  - setProperties
```
public ClientConfig setProperties(Properties properties)
```
    sets all properties
    
    Parameters:
    
    properties - Properties object
    
    Returns:
    
    configured ClientConfig for chaining
  - getSecurityConfig
```
public ClientSecurityConfig getSecurityConfig()
```
    Gets ClientSecurityConfig object which allows client credentials configuration.
    
    Returns:
    
    ClientSecurityConfig instance
  - setSecurityConfig
```
public ClientConfig setSecurityConfig(ClientSecurityConfig securityConfig)
```
    Sets ClientSecurityConfig object
    
    Parameters:
    
    securityConfig - ClientSecurityConfig to be set
    
    Returns:
    
    configured ClientConfig for chaining
    
    See Also:
    
    ClientSecurityConfig
  - setCredentials
```
public ClientConfig setCredentials(Credentials credentials)
```
    Shortcut for getSecurityConfig().setCredentials()
    
    Parameters:
    
    credentials - Credentials instance to be set
    
    Returns:
    
    configured ClientConfig for chaining
  - getNetworkConfig
```
public ClientNetworkConfig getNetworkConfig()
```
    Gets ClientNetworkConfig
    
    Returns:
    
    ClientNetworkConfig
    
    See Also:
    
    ClientNetworkConfig
  - setNetworkConfig
```
public ClientConfig setNetworkConfig(ClientNetworkConfig networkConfig)
```
    Sets ClientNetworkConfig
    
    Parameters:
    
    networkConfig - ClientNetworkConfig to be set
    
    Returns:
    
    configured ClientConfig for chaining
    
    See Also:
    
    ClientNetworkConfig
  - addReliableTopicConfig
```
public ClientConfig addReliableTopicConfig(ClientReliableTopicConfig reliableTopicConfig)
```
    Adds a ClientReliableTopicConfig.
    
    Parameters:
    
    reliableTopicConfig - the ClientReliableTopicConfig to add
    
    Returns:
    
    configured ClientConfig for chaining
  - getReliableTopicConfig
```
public ClientReliableTopicConfig getReliableTopicConfig(String name)
```
    Gets the ClientReliableTopicConfig for a given reliable topic name.
    
    Parameters:
    
    name - the name of the reliable topic
    
    Returns:
    
    the found config. If none is found, a default configured one is returned.
  - addNearCacheConfig
```
public ClientConfig addNearCacheConfig(NearCacheConfig nearCacheConfig)
```
    Helper method to add a new NearCacheConfig
    
    Parameters:
    
    nearCacheConfig - NearCacheConfig
    
    Returns:
    
    configured ClientConfig for chaining
    
    See Also:
    
    NearCacheConfig
  - addListenerConfig
```
public ClientConfig addListenerConfig(ListenerConfig listenerConfig)
```
    Helper method to add a new ListenerConfig
    
    Parameters:
    
    listenerConfig - ListenerConfig
    
    Returns:
    
    configured ClientConfig for chaining
    
    See Also:
    
    ListenerConfig
  - addProxyFactoryConfig
```
public ClientConfig addProxyFactoryConfig(ProxyFactoryConfig proxyFactoryConfig)
```
    Helper method to add a new ProxyFactoryConfig
    
    Parameters:
    
    proxyFactoryConfig - ProxyFactoryConfig
    
    Returns:
    
    configured ClientConfig for chaining
    
    See Also:
    
    ProxyFactoryConfig
  - getNearCacheConfig
```
public NearCacheConfig getNearCacheConfig(String name)
```
    Gets the NearCacheConfig configured for the map / cache with name
    
    Parameters:
    
    name - name of the map / cache
    
    Returns:
    
    Configured NearCacheConfig
    
    See Also:
    
    NearCacheConfig
  - getNearCacheConfigMap
```
public Map<String,NearCacheConfig> getNearCacheConfigMap()
```
    Map of all configured NearCacheConfig's with the name key and configuration as the value
    
    Returns:
    
    map of NearCacheConfig
    
    See Also:
    
    NearCacheConfig
  - setNearCacheConfigMap
```
public ClientConfig setNearCacheConfigMap(Map<String,NearCacheConfig> nearCacheConfigMap)
```
    Sets all NearCacheConfig's with the provided map
    
    Parameters:
    
    nearCacheConfigMap - map of (name, NearCacheConfig)
    
    Returns:
    
    configured ClientConfig for chaining
  - getFlakeIdGeneratorConfigMap
```
public Map<String,ClientFlakeIdGeneratorConfig> getFlakeIdGeneratorConfigMap()
```
    Returns the map of FlakeIdGenerator configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.
    
    Returns:
    
    the map configurations mapped by config name
  - findFlakeIdGeneratorConfig
```
public ClientFlakeIdGeneratorConfig findFlakeIdGeneratorConfig(String name)
```
    Returns a ClientFlakeIdGeneratorConfig configuration for the given flake ID generator name.
    The name is matched by pattern to the configuration and by stripping the partition ID qualifier from the given name. If there is no config found by the name, it will return the configuration with the name "default".
    
    Parameters:
    
    name - name of the flake ID generator config
    
    Returns:
    
    the flake ID generator configuration
    
    Throws:
    
    InvalidConfigurationException - if ambiguous configurations are found
    
    See Also:
    
    StringPartitioningStrategy.getBaseName(java.lang.String), setConfigPatternMatcher(ConfigPatternMatcher), getConfigPatternMatcher()
  - getFlakeIdGeneratorConfig
```
public ClientFlakeIdGeneratorConfig getFlakeIdGeneratorConfig(String name)
```
    Returns the ClientFlakeIdGeneratorConfig for the given name, creating one if necessary and adding it to the collection of known configurations.
    The configuration is found by matching the the configuration name pattern to the provided name without the partition qualifier (the part of the name after '@'). If no configuration matches, it will create one by cloning the "default" configuration and add it to the configuration collection.
    This method is intended to easily and fluently create and add configurations more specific than the default configuration without explicitly adding it by invoking addFlakeIdGeneratorConfig(ClientFlakeIdGeneratorConfig).
    Because it adds new configurations if they are not already present, this method is intended to be used before this config is used to create a hazelcast instance. Afterwards, newly added configurations may be ignored.
    
    Parameters:
    
    name - name of the flake ID generator config
    
    Returns:
    
    the cache configuration
    
    Throws:
    
    InvalidConfigurationException - if ambiguous configurations are found
    
    See Also:
    
    StringPartitioningStrategy.getBaseName(java.lang.String), setConfigPatternMatcher(ConfigPatternMatcher), getConfigPatternMatcher()
  - addFlakeIdGeneratorConfig
```
public ClientConfig addFlakeIdGeneratorConfig(ClientFlakeIdGeneratorConfig config)
```
    Adds a flake ID generator configuration. The configuration is saved under the config name, which may be a pattern with which the configuration will be obtained in the future.
    
    Parameters:
    
    config - the flake ID configuration
    
    Returns:
    
    this config instance
  - setFlakeIdGeneratorConfigMap
```
public ClientConfig setFlakeIdGeneratorConfigMap(Map<String,ClientFlakeIdGeneratorConfig> map)
```
    Sets the map of FlakeIdGenerator configurations, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.
    
    Parameters:
    
    map - the FlakeIdGenerator configuration map to set
    
    Returns:
    
    this config instance
  - setReliableTopicConfigMap
```
public ClientConfig setReliableTopicConfigMap(Map<String,ClientReliableTopicConfig> map)
```
    Sets the map of ClientReliableTopicConfig, mapped by config name. The config name may be a pattern with which the configuration will be obtained in the future.
    
    Parameters:
    
    map - the FlakeIdGenerator configuration map to set
    
    Returns:
    
    this config instance
  - getReliableTopicConfigMap
```
public Map<String,ClientReliableTopicConfig> getReliableTopicConfigMap()
```
    Returns the map of reliable topic configurations, mapped by config name. The config name may be a pattern with which the configuration was initially obtained.
    
    Returns:
    
    the map configurations mapped by config name
  - getListenerConfigs
```
public List<ListenerConfig> getListenerConfigs()
```
    Gets list of all configured ListenerConfig's
    
    Returns:
    
    ListenerConfig
    
    See Also:
    
    ListenerConfig
  - setListenerConfigs
```
public ClientConfig setListenerConfigs(List<ListenerConfig> listenerConfigs)
```
    Sets all ListenerConfig's
    
    Parameters:
    
    listenerConfigs - list of ListenerConfig
    
    Returns:
    
    configured ClientConfig for chaining
    
    See Also:
    
    ListenerConfig
  - getLoadBalancer
```
public LoadBalancer getLoadBalancer()
```
    Gets LoadBalancer
    
    Returns:
    
    LoadBalancer
    
    See Also:
    
    LoadBalancer
  - setLoadBalancer
```
public ClientConfig setLoadBalancer(LoadBalancer loadBalancer)
```
    Sets the LoadBalancer.
    If a load balancer class name was set, it will be removed.
    
    Parameters:
    
    loadBalancer - LoadBalancer
    
    Returns:
    
    configured ClientConfig for chaining
    
    See Also:
    
    LoadBalancer
  - getLoadBalancerClassName
```
public String getLoadBalancerClassName()
```
    Gets load balancer class name
    
    Returns:
    
    load balancer class name
    
    See Also:
    
    LoadBalancer
  - setLoadBalancerClassName
```
public ClientConfig setLoadBalancerClassName(@Nonnull
                                             String loadBalancerClassName)
```
    Sets load balancer class name.
    If a load balancer implementation was set, it will be removed.
    
    Parameters:
    
    loadBalancerClassName - LoadBalancer
    
    Returns:
    
    configured ClientConfig for chaining
    
    See Also:
    
    LoadBalancer
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Gets the classLoader
    
    Returns:
    
    configured classLoader, null if not yet configured
  - setClassLoader
```
public ClientConfig setClassLoader(ClassLoader classLoader)
```
    Sets the classLoader which is used by serialization and listener configuration
    
    Parameters:
    
    classLoader - the classLoader
    
    Returns:
    
    configured ClientConfig for chaining
  - getManagedContext
```
public ManagedContext getManagedContext()
```
    Gets ManagedContext
    
    Returns:
    
    ManagedContext
    
    See Also:
    
    ManagedContext
  - setManagedContext
```
public ClientConfig setManagedContext(ManagedContext managedContext)
```
    Sets ManagedContext
    
    Parameters:
    
    managedContext - ManagedContext
    
    Returns:
    
    configured ClientConfig for chaining
    
    See Also:
    
    ManagedContext
  - getProxyFactoryConfigs
```
public List<ProxyFactoryConfig> getProxyFactoryConfigs()
```
    Gets list of ProxyFactoryConfig
    
    Returns:
    
    list of ProxyFactoryConfig
    
    See Also:
    
    ProxyFactoryConfig
  - setProxyFactoryConfigs
```
public ClientConfig setProxyFactoryConfigs(List<ProxyFactoryConfig> proxyFactoryConfigs)
```
    Sets the ProxyFactoryConfig
    
    Parameters:
    
    proxyFactoryConfigs - list to assign
    
    Returns:
    
    configured ClientConfig for chaining
  - getSerializationConfig
```
public SerializationConfig getSerializationConfig()
```
    Gets SerializationConfig
    
    Returns:
    
    SerializationConfig
    
    See Also:
    
    SerializationConfig
  - setSerializationConfig
```
public ClientConfig setSerializationConfig(SerializationConfig serializationConfig)
```
    Sets SerializationConfig
    
    Parameters:
    
    serializationConfig - SerializationConfig
    
    Returns:
    
    configured ClientConfig for chaining
    
    See Also:
    
    SerializationConfig
  - getNativeMemoryConfig
```
public NativeMemoryConfig getNativeMemoryConfig()
```
  - setNativeMemoryConfig
```
public ClientConfig setNativeMemoryConfig(NativeMemoryConfig nativeMemoryConfig)
```
  - addQueryCacheConfig
```
public ClientConfig addQueryCacheConfig(String mapName,
                                        QueryCacheConfig queryCacheConfig)
```
  - getQueryCacheConfigs
```
public Map<String,Map<String,QueryCacheConfig>> getQueryCacheConfigs()
```
  - setQueryCacheConfigs
```
public ClientConfig setQueryCacheConfigs(Map<String,Map<String,QueryCacheConfig>> queryCacheConfigs)
```
  - getInstanceName
```
public String getInstanceName()
```
  - setInstanceName
```
public ClientConfig setInstanceName(String instanceName)
```
  - getClusterName
```
public String getClusterName()
```
    Returns the configured cluster name. The name is sent as part of client authentication message and may be verified on the member.
    
    Returns:
    
    the configured cluster name
  - setClusterName
```
public ClientConfig setClusterName(String clusterName)
```
  - getConnectionStrategyConfig
```
public ClientConnectionStrategyConfig getConnectionStrategyConfig()
```
  - setConnectionStrategyConfig
```
public ClientConfig setConnectionStrategyConfig(ClientConnectionStrategyConfig connectionStrategyConfig)
```
  - getUserCodeDeploymentConfig
```
public ClientUserCodeDeploymentConfig getUserCodeDeploymentConfig()
```
    Get current configuration of User Code Deployment.
    
    Returns:
    
    User Code Deployment configuration
    
    Since:
    
    3.9
  - setUserCodeDeploymentConfig
```
public ClientConfig setUserCodeDeploymentConfig(ClientUserCodeDeploymentConfig userCodeDeploymentConfig)
```
    Set User Code Deployment configuration
    
    Parameters:
    
    userCodeDeploymentConfig - the configuration of User Code Deployment
    
    Returns:
    
    configured ClientConfig for chaining
    
    Since:
    
    3.9
  - getOrCreateQueryCacheConfig
```
public QueryCacheConfig getOrCreateQueryCacheConfig(String mapName,
                                                    String cacheName)
```
    Parameters:
    
    mapName - The name of the map for which the query cache config is to be returned.
    
    cacheName - The name of the query cache.
    
    Returns:
    
    The query cache config. If the config does not exist, it is created.
  - getOrNullQueryCacheConfig
```
public QueryCacheConfig getOrNullQueryCacheConfig(String mapName,
                                                  String cacheName)
```
    Parameters:
    
    mapName - The name of the map for which the query cache config is to be returned.
    
    cacheName - The name of the query cache.
    
    Returns:
    
    The query cache config. If no such config exist null is returned.
  - addLabel
```
public ClientConfig addLabel(String label)
```
    Adds a label for this client Client available
    
    Parameters:
    
    label - The label to be added.
    
    Returns:
    
    configured ClientConfig for chaining
  - getLabels
```
public Set<String> getLabels()
```
    Returns:
    
    all the labels assigned to this client
  - setLabels
```
public ClientConfig setLabels(Set<String> labels)
```
    Set labels for the client. Deletes old labels if added earlier.
    
    Parameters:
    
    labels - The labels to be set
    
    Returns:
    
    configured ClientConfig for chaining
  - setUserContext
```
public ClientConfig setUserContext(ConcurrentMap<String,Object> userContext)
```
  - getUserContext
```
public ConcurrentMap<String,Object> getUserContext()
```
  - setBackupAckToClientEnabled
```
public ClientConfig setBackupAckToClientEnabled(boolean backupAckToClientEnabled)
```
    This feature reduces number of hops and increase performance for smart clients. It is enabled by default for smart clients. This config has no effect for unisocket clients.
    
    Parameters:
    
    backupAckToClientEnabled - enables client to get backup acknowledgements directly from the member that backups are applied
    
    Returns:
    
    configured ClientConfig for chaining
  - isBackupAckToClientEnabled
```
public boolean isBackupAckToClientEnabled()
```
    Note that backup acks to client can be enabled only for smart client. This config has no effect for unisocket clients.
    
    Returns:
    
    true if backup acknowledgements comes to client
  - getMetricsConfig
```
@Nonnull
public ClientMetricsConfig getMetricsConfig()
```
    Returns the metrics collection config.
  - setMetricsConfig
```
@Nonnull
public ClientConfig setMetricsConfig(@Nonnull
                                              ClientMetricsConfig metricsConfig)
```
    Sets the metrics collection config.
  - getInstanceTrackingConfig
```
@Nonnull
public InstanceTrackingConfig getInstanceTrackingConfig()
```
    Returns the configuration for tracking use of this Hazelcast instance.
  - setInstanceTrackingConfig
```
@Nonnull
public ClientConfig setInstanceTrackingConfig(@Nonnull
                                                       InstanceTrackingConfig instanceTrackingConfig)
```
    Returns the configuration for tracking use of this Hazelcast instance.
  - getSqlConfig
```
@Nonnull
public ClientSqlConfig getSqlConfig()
```
    Returns the configuration for the SQL feature.
    
    Since:
    
    5.2
  - setSqlConfig
```
@Nonnull
public ClientConfig setSqlConfig(ClientSqlConfig sqlConfig)
```
    Sets the configuration for the SQL feature.
    
    Since:
    
    5.2
  - getTpcConfig
```
@Beta
 @Nonnull
public ClientTpcConfig getTpcConfig()
```
    Returns the ClientTpcConfig
    
    Returns:
    
    the ClientTpcConfig
    
    Since:
    
    5.3
  - setTpcConfig
```
@Beta
 @Nonnull
public ClientConfig setTpcConfig(@Nonnull
                                                 ClientTpcConfig tpcConfig)
```
    Sets the TpcConfig
    
    Parameters:
    
    tpcConfig - TpcConfig to set
    
    Returns:
    
    configured ClientConfig for chaining
    
    Throws:
    
    IllegalArgumentException - if the tpcConfig is null
    
    Since:
    
    5.3
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ClientConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClientConfig

ClientConfig

Method Detail

load

setConfigPatternMatcher

getConfigPatternMatcher

getProperty

setProperty

getProperties

setProperties

getSecurityConfig

setSecurityConfig

setCredentials

getNetworkConfig

setNetworkConfig

addReliableTopicConfig

getReliableTopicConfig

addNearCacheConfig

addListenerConfig

addProxyFactoryConfig

getNearCacheConfig

getNearCacheConfigMap

setNearCacheConfigMap

getFlakeIdGeneratorConfigMap

findFlakeIdGeneratorConfig

getFlakeIdGeneratorConfig

addFlakeIdGeneratorConfig

setFlakeIdGeneratorConfigMap

setReliableTopicConfigMap

getReliableTopicConfigMap

getListenerConfigs

setListenerConfigs

getLoadBalancer

setLoadBalancer

getLoadBalancerClassName

setLoadBalancerClassName

getClassLoader

setClassLoader

getManagedContext

setManagedContext

getProxyFactoryConfigs

setProxyFactoryConfigs

getSerializationConfig

setSerializationConfig

getNativeMemoryConfig

setNativeMemoryConfig

addQueryCacheConfig

getQueryCacheConfigs

setQueryCacheConfigs

getInstanceName

setInstanceName

getClusterName

setClusterName

getConnectionStrategyConfig

setConnectionStrategyConfig

getUserCodeDeploymentConfig

setUserCodeDeploymentConfig

getOrCreateQueryCacheConfig

getOrNullQueryCacheConfig

addLabel

getLabels

setLabels

setUserContext

getUserContext

setBackupAckToClientEnabled

isBackupAckToClientEnabled

getMetricsConfig

setMetricsConfig

getInstanceTrackingConfig

setInstanceTrackingConfig

getSqlConfig

setSqlConfig

getTpcConfig

setTpcConfig

hashCode