NetworkConfig (Hazelcast Root 5.3.0-BETA-1 API)

java.lang.Object
- com.hazelcast.config.NetworkConfig

Direct Known Subclasses:

AdvancedNetworkConfig.MemberNetworkingView
```
public class NetworkConfig
extends Object
```
Contains configuration for Network.

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_PORT
Default value of port number.

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_PORT` Default value of port number.

Constructor Summary

Constructors
Constructor and Description

NetworkConfig()

Constructors
Constructor and Description
`NetworkConfig()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`NetworkConfig`	`addOutboundPort(int port)`
`NetworkConfig`	`addOutboundPortDefinition(String portDef)`
`boolean`	`equals(Object o)`
`AltoSocketConfig`	`getAltoSocketConfig()` Gets the Alto socket config.
`IcmpFailureDetectorConfig`	`getIcmpFailureDetectorConfig()` Returns the current `IcmpFailureDetectorConfig`.
`InterfacesConfig`	`getInterfaces()`
`JoinConfig`	`getJoin()` Returns the `JoinConfig`.
`MemberAddressProviderConfig`	`getMemberAddressProviderConfig()`
`MemcacheProtocolConfig`	`getMemcacheProtocolConfig()`
`Collection<String>`	`getOutboundPortDefinitions()`
`Collection<Integer>`	`getOutboundPorts()`
`int`	`getPort()` Returns the port the Hazelcast member will try to bind on.
`int`	`getPortCount()` Returns the maximum number of ports allowed to try to bind on.
`String`	`getPublicAddress()`
`RestApiConfig`	`getRestApiConfig()`
`SocketInterceptorConfig`	`getSocketInterceptorConfig()` Gets the `SocketInterceptorConfig`.
`SSLConfig`	`getSSLConfig()` Returns the current `SSLConfig`.
`SymmetricEncryptionConfig`	`getSymmetricEncryptionConfig()` Deprecated. since 4.2
`int`	`hashCode()`
`boolean`	`isPortAutoIncrement()` Checks if a Hazelcast member is allowed find a free port by incrementing the port number when it encounters an occupied port.
`boolean`	`isReuseAddress()`
`NetworkConfig`	`setAltoSocketConfig(AltoSocketConfig altoSocketConfig)` Sets the Alto socket config.
`NetworkConfig`	`setIcmpFailureDetectorConfig(IcmpFailureDetectorConfig icmpFailureDetectorConfig)` Sets the `IcmpFailureDetectorConfig`.
`NetworkConfig`	`setInterfaces(InterfacesConfig interfaces)`
`NetworkConfig`	`setJoin(JoinConfig join)`
`NetworkConfig`	`setMemberAddressProviderConfig(MemberAddressProviderConfig memberAddressProviderConfig)`
`NetworkConfig`	`setMemcacheProtocolConfig(MemcacheProtocolConfig memcacheProtocolConfig)`
`NetworkConfig`	`setOutboundPortDefinitions(Collection<String> outboundPortDefs)`
`NetworkConfig`	`setOutboundPorts(Collection<Integer> outboundPorts)`
`NetworkConfig`	`setPort(int port)` Sets the port the Hazelcast member will try to bind on.
`NetworkConfig`	`setPortAutoIncrement(boolean portAutoIncrement)` Sets if a Hazelcast member is allowed to find a free port by incrementing the port number when it encounters an occupied port.
`NetworkConfig`	`setPortCount(int portCount)` The maximum number of ports allowed to use.
`NetworkConfig`	`setPublicAddress(String publicAddress)` Overrides the public address of a member.
`NetworkConfig`	`setRestApiConfig(RestApiConfig restApiConfig)`
`NetworkConfig`	`setReuseAddress(boolean reuseAddress)` Sets the reuse address.
`NetworkConfig`	`setSocketInterceptorConfig(SocketInterceptorConfig socketInterceptorConfig)` Sets the `SocketInterceptorConfig`.
`NetworkConfig`	`setSSLConfig(SSLConfig sslConfig)` Sets the `SSLConfig`.
`NetworkConfig`	`setSymmetricEncryptionConfig(SymmetricEncryptionConfig symmetricEncryptionConfig)` Deprecated. since 4.2
`String`	`toString()`

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

- Field Detail
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    Default value of port number.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NetworkConfig
```
public NetworkConfig()
```
- Method Detail
  - getPort
```
public int getPort()
```
    Returns the port the Hazelcast member will try to bind on. A port number of 0 will let the system pick up an ephemeral port.
    
    Returns:
    
    the port the Hazelcast member will try to bind on
    
    See Also:
    
    setPort(int)
  - setPort
```
public NetworkConfig setPort(int port)
```
    Sets the port the Hazelcast member will try to bind on.
    A valid port value is between 0 and 65535. A port number of 0 will let the system pick up an ephemeral port.
    
    Parameters:
    
    port - the port the Hazelcast member will try to bind on
    
    Returns:
    
    NetworkConfig the updated NetworkConfig
    
    See Also:
    
    getPort(), for more information
  - getPortCount
```
public int getPortCount()
```
    Returns the maximum number of ports allowed to try to bind on.
    
    Returns:
    
    the maximum number of ports allowed to try to bind on
    
    See Also:
    
    setPortCount(int), for more information
  - setPortCount
```
public NetworkConfig setPortCount(int portCount)
```
    The maximum number of ports allowed to use.
    
    Parameters:
    
    portCount - the maximum number of ports allowed to use
    
    Returns:
    
    this configuration
    
    See Also:
    
    for more information
  - isPortAutoIncrement
```
public boolean isPortAutoIncrement()
```
    Checks if a Hazelcast member is allowed find a free port by incrementing the port number when it encounters an occupied port.
    
    Returns:
    
    the portAutoIncrement
    
    See Also:
    
    setPortAutoIncrement(boolean)
  - setPortAutoIncrement
```
public NetworkConfig setPortAutoIncrement(boolean portAutoIncrement)
```
    Sets if a Hazelcast member is allowed to find a free port by incrementing the port number when it encounters an occupied port.
    If you explicitly want to control the port a Hazelcast member is going to use, you probably want to set portAutoincrement to false. In this case, the Hazelcast member is going to try the port setPort(int) and if the port is not free, the member will not start and throw an exception.
    If this value is set to true, Hazelcast will start at the port specified by setPort(int) and will try until it finds a free port, or until it runs out of ports to try setPortCount(int).
    
    Parameters:
    
    portAutoIncrement - the portAutoIncrement to set
    
    Returns:
    
    the updated NetworkConfig
    
    See Also:
    
    isPortAutoIncrement(), setPortCount(int), setPort(int)
  - isReuseAddress
```
public boolean isReuseAddress()
```
  - setReuseAddress
```
public NetworkConfig setReuseAddress(boolean reuseAddress)
```
    Sets the reuse address.
    When should setReuseAddress(true) be used?
    When the member is shutdown, the server socket port will be in TIME_WAIT state for the next 2 minutes or so. If you start the member right after shutting it down, you may not be able to bind to the same port because it is in TIME_WAIT state. if you set reuseAddress=true then TIME_WAIT will be ignored and you will be able to bind to the same port again.
    This property should not be set to true on the Windows platform: see
    1. http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6421091
    2. http://www.hsc.fr/ressources/articles/win_net_srv/multiple_bindings.html
    By default, if the OS is Windows then reuseAddress will be false.
  - getOutboundPortDefinitions
```
public Collection<String> getOutboundPortDefinitions()
```
  - setOutboundPortDefinitions
```
public NetworkConfig setOutboundPortDefinitions(Collection<String> outboundPortDefs)
```
  - addOutboundPortDefinition
```
public NetworkConfig addOutboundPortDefinition(String portDef)
```
  - getOutboundPorts
```
public Collection<Integer> getOutboundPorts()
```
  - setOutboundPorts
```
public NetworkConfig setOutboundPorts(Collection<Integer> outboundPorts)
```
  - addOutboundPort
```
public NetworkConfig addOutboundPort(int port)
```
  - getInterfaces
```
public InterfacesConfig getInterfaces()
```
    Returns:
    
    the interfaces
  - setInterfaces
```
public NetworkConfig setInterfaces(InterfacesConfig interfaces)
```
    Parameters:
    
    interfaces - the interfaces to set
  - getJoin
```
public JoinConfig getJoin()
```
    Returns the JoinConfig.
    
    Returns:
    
    the join
  - setJoin
```
public NetworkConfig setJoin(JoinConfig join)
```
    Parameters:
    
    join - the join to set
  - getPublicAddress
```
public String getPublicAddress()
```
  - setPublicAddress
```
public NetworkConfig setPublicAddress(String publicAddress)
```
    Overrides the public address of a member. Behind a NAT, two endpoints may not be able to see/access each other. If both nodes set their public addresses to their defined addresses on NAT, then that way they can communicate with each other. It should be set in the format “host IP address:port number”.
  - getSocketInterceptorConfig
```
public SocketInterceptorConfig getSocketInterceptorConfig()
```
    Gets the SocketInterceptorConfig. The value can be null if no socket interception is needed.
    
    Returns:
    
    the SocketInterceptorConfig
    
    See Also:
    
    setSocketInterceptorConfig(SocketInterceptorConfig)
  - setSocketInterceptorConfig
```
public NetworkConfig setSocketInterceptorConfig(SocketInterceptorConfig socketInterceptorConfig)
```
    Sets the SocketInterceptorConfig. The value can be null if no socket interception is needed.
    
    Parameters:
    
    socketInterceptorConfig - the SocketInterceptorConfig to set
    
    Returns:
    
    the updated NetworkConfig
  - getSymmetricEncryptionConfig
```
@Deprecated
public SymmetricEncryptionConfig getSymmetricEncryptionConfig()
```
    Deprecated. since 4.2
    
    Gets the SymmetricEncryptionConfig. The value can be null which means that no symmetric encryption should be used.
    
    Returns:
    
    the SymmetricEncryptionConfig
  - setSymmetricEncryptionConfig
```
@Deprecated
public NetworkConfig setSymmetricEncryptionConfig(SymmetricEncryptionConfig symmetricEncryptionConfig)
```
    Deprecated. since 4.2
    
    Sets the SymmetricEncryptionConfig. The value can be null if no symmetric encryption should be used.
    
    Parameters:
    
    symmetricEncryptionConfig - the SymmetricEncryptionConfig to set
    
    Returns:
    
    the updated NetworkConfig
    
    See Also:
    
    getSymmetricEncryptionConfig()
  - getSSLConfig
```
public SSLConfig getSSLConfig()
```
    Returns the current SSLConfig. It is possible that null is returned if no SSLConfig has been set.
    
    Returns:
    
    the SSLConfig
    
    Throws:
    
    SecurityException - If a security manager exists and the calling method doesn't have corresponding HazelcastRuntimePermission
    
    See Also:
    
    setSSLConfig(SSLConfig)
  - setSSLConfig
```
public NetworkConfig setSSLConfig(SSLConfig sslConfig)
```
    Sets the SSLConfig. null value indicates that no SSLConfig should be used.
    
    Parameters:
    
    sslConfig - the SSLConfig
    
    Returns:
    
    the updated NetworkConfig
    
    Throws:
    
    SecurityException - If a security manager exists and the calling method doesn't have corresponding HazelcastRuntimePermission
    
    See Also:
    
    getSSLConfig()
  - getMemberAddressProviderConfig
```
public MemberAddressProviderConfig getMemberAddressProviderConfig()
```
  - setMemberAddressProviderConfig
```
public NetworkConfig setMemberAddressProviderConfig(MemberAddressProviderConfig memberAddressProviderConfig)
```
  - setIcmpFailureDetectorConfig
```
public NetworkConfig setIcmpFailureDetectorConfig(IcmpFailureDetectorConfig icmpFailureDetectorConfig)
```
    Sets the IcmpFailureDetectorConfig. The value can be null if this detector isn't needed.
    
    Parameters:
    
    icmpFailureDetectorConfig - the IcmpFailureDetectorConfig to set
    
    Returns:
    
    the updated NetworkConfig
    
    See Also:
    
    getIcmpFailureDetectorConfig()
  - getIcmpFailureDetectorConfig
```
public IcmpFailureDetectorConfig getIcmpFailureDetectorConfig()
```
    Returns the current IcmpFailureDetectorConfig. It is possible that null is returned if no IcmpFailureDetectorConfig has been set.
    
    Returns:
    
    the IcmpFailureDetectorConfig
    
    See Also:
    
    setIcmpFailureDetectorConfig(IcmpFailureDetectorConfig)
  - getRestApiConfig
```
public RestApiConfig getRestApiConfig()
```
  - setRestApiConfig
```
public NetworkConfig setRestApiConfig(RestApiConfig restApiConfig)
```
  - getMemcacheProtocolConfig
```
public MemcacheProtocolConfig getMemcacheProtocolConfig()
```
  - setMemcacheProtocolConfig
```
public NetworkConfig setMemcacheProtocolConfig(MemcacheProtocolConfig memcacheProtocolConfig)
```
  - getAltoSocketConfig
```
@Beta
 @Nonnull
public AltoSocketConfig getAltoSocketConfig()
```
    Gets the Alto socket config.
    
    Returns:
    
    the Alto socket config
    
    Since:
    
    5.3
    
    See Also:
    
    AltoConfig
  - setAltoSocketConfig
```
@Beta
 @Nonnull
public NetworkConfig setAltoSocketConfig(@Nonnull
                                                         AltoSocketConfig altoSocketConfig)
```
    Sets the Alto socket config.
    
    Parameters:
    
    altoSocketConfig - the Alto socket config to set
    
    Returns:
    
    this network config
    
    Throws:
    
    IllegalArgumentException - if altoSocketConfig is null
    
    Since:
    
    5.3
    
    See Also:
    
    AltoConfig
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class NetworkConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PORT

Constructor Detail

NetworkConfig

Method Detail

getPort

setPort

getPortCount

setPortCount

isPortAutoIncrement

setPortAutoIncrement

isReuseAddress

setReuseAddress

getOutboundPortDefinitions

setOutboundPortDefinitions

addOutboundPortDefinition

getOutboundPorts

setOutboundPorts

addOutboundPort

getInterfaces

setInterfaces

getJoin

setJoin

getPublicAddress

setPublicAddress

getSocketInterceptorConfig

setSocketInterceptorConfig

getSymmetricEncryptionConfig

setSymmetricEncryptionConfig

getSSLConfig

setSSLConfig

getMemberAddressProviderConfig

setMemberAddressProviderConfig

setIcmpFailureDetectorConfig

getIcmpFailureDetectorConfig

getRestApiConfig

setRestApiConfig

getMemcacheProtocolConfig

setMemcacheProtocolConfig

getAltoSocketConfig

setAltoSocketConfig

toString

equals

hashCode