com.hazelcast.config

Class EndpointConfig

java.lang.Object

com.hazelcast.config.EndpointConfig

All Implemented Interfaces:

NamedConfig

Direct Known Subclasses:

ServerSocketEndpointConfig

public class EndpointConfig
extends Object
implements NamedConfig

Endpoint configuration that defines communication/networking properties common to both incoming/outgoing connections eg. - Encryption / Security - Hazelcast protocol type

Since:

3.12

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SOCKET_CONNECT_TIMEOUT_SECONDS See SocketOptions.SO_TIMEOUT
static int	DEFAULT_SOCKET_KEEP_COUNT See jdk.net.ExtendedSocketOptions#TCP_KEEPINTERVAL
static int	DEFAULT_SOCKET_KEEP_IDLE_SECONDS See jdk.net.ExtendedSocketOptions#TCP_KEEPIDLE
static int	DEFAULT_SOCKET_KEEP_INTERVAL_SECONDS See jdk.net.ExtendedSocketOptions#TCP_KEEPINTERVAL
static int	DEFAULT_SOCKET_LINGER_SECONDS See SocketOptions.SO_LINGER
static int	DEFAULT_SOCKET_RECEIVE_BUFFER_SIZE_KB See SocketOptions.SO_RCVBUF.
static int	DEFAULT_SOCKET_SEND_BUFFER_SIZE_KB See SocketOptions.SO_SNDBUF
protected InterfacesConfig	interfaces
protected String	name
protected com.hazelcast.instance.ProtocolType	protocolType
protected SocketInterceptorConfig	socketInterceptorConfig
protected SSLConfig	sslConfig
protected SymmetricEncryptionConfig	symmetricEncryptionConfig

Constructor Summary

Constructors

Constructor and Description
EndpointConfig()

Method Summary

Modifier and Type	Method and Description
EndpointConfig	addOutboundPort(int port)
EndpointConfig	addOutboundPortDefinition(String portDef)
boolean	equals(Object o)
AltoSocketConfig	getAltoSocketConfig() Gets the Alto socket config.
InterfacesConfig	getInterfaces()
String	getName()
Collection<String>	getOutboundPortDefinitions()
Collection<Integer>	getOutboundPorts()
com.hazelcast.instance.ProtocolType	getProtocolType()
com.hazelcast.instance.EndpointQualifier	getQualifier()
int	getSocketConnectTimeoutSeconds()
SocketInterceptorConfig	getSocketInterceptorConfig() Gets the SocketInterceptorConfig.
int	getSocketKeepCount() Keep-Alive count: the maximum number of TCP keep-alive probes to send before giving up and closing the connection if no response is obtained from the other side.
int	getSocketKeepIdleSeconds() Keep-Alive idle time: the number of seconds of idle time before keep-alive initiates a probe.
int	getSocketKeepIntervalSeconds() Keep-Alive interval: the number of seconds between keep-alive probes.
int	getSocketLingerSeconds()
int	getSocketRcvBufferSizeKb()
int	getSocketSendBufferSizeKb()
SSLConfig	getSSLConfig() Returns the current SSLConfig.
SymmetricEncryptionConfig	getSymmetricEncryptionConfig() Deprecated. since 4.2
int	hashCode()
boolean	isSocketBufferDirect()
boolean	isSocketKeepAlive()
boolean	isSocketTcpNoDelay()
EndpointConfig	setAltoSocketConfig(AltoSocketConfig altoSocketConfig) Sets the Alto socket config.
EndpointConfig	setInterfaces(InterfacesConfig interfaces)
EndpointConfig	setName(String name)
EndpointConfig	setOutboundPortDefinitions(Collection<String> outboundPortDefs)
EndpointConfig	setOutboundPorts(Collection<Integer> outboundPorts)
EndpointConfig	setProtocolType(com.hazelcast.instance.ProtocolType protocolType)
EndpointConfig	setSocketBufferDirect(boolean socketBufferDirect)
EndpointConfig	setSocketConnectTimeoutSeconds(int socketConnectTimeoutSeconds)
EndpointConfig	setSocketInterceptorConfig(SocketInterceptorConfig socketInterceptorConfig) Sets the SocketInterceptorConfig.
EndpointConfig	setSocketKeepAlive(boolean socketKeepAlive)
EndpointConfig	setSocketKeepCount(int socketKeepCount) Set the maximum number of TCP keep-alive probes to send before giving up and closing the connection if no response is obtained from the other side.
EndpointConfig	setSocketKeepIdleSeconds(int socketKeepIdleSeconds) Set the number of seconds a connection needs to be idle before TCP begins sending out keep-alive probes.
EndpointConfig	setSocketKeepIntervalSeconds(int socketKeepIntervalSeconds) Set the number of seconds between keep-alive probes.
EndpointConfig	setSocketLingerSeconds(int socketLingerSeconds)
EndpointConfig	setSocketRcvBufferSizeKb(int socketRcvBufferSizeKb)
EndpointConfig	setSocketSendBufferSizeKb(int socketSendBufferSizeKb)
EndpointConfig	setSocketTcpNoDelay(boolean socketTcpNoDelay)
EndpointConfig	setSSLConfig(SSLConfig sslConfig) Sets the SSLConfig.
EndpointConfig	setSymmetricEncryptionConfig(SymmetricEncryptionConfig symmetricEncryptionConfig) Deprecated. since 4.2

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_SOCKET_CONNECT_TIMEOUT_SECONDS

public static final int DEFAULT_SOCKET_CONNECT_TIMEOUT_SECONDS

See SocketOptions.SO_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SOCKET_SEND_BUFFER_SIZE_KB

public static final int DEFAULT_SOCKET_SEND_BUFFER_SIZE_KB

See SocketOptions.SO_SNDBUF

See Also:

Constant Field Values

DEFAULT_SOCKET_RECEIVE_BUFFER_SIZE_KB

public static final int DEFAULT_SOCKET_RECEIVE_BUFFER_SIZE_KB

See SocketOptions.SO_RCVBUF.

See Also:

Constant Field Values

DEFAULT_SOCKET_LINGER_SECONDS

public static final int DEFAULT_SOCKET_LINGER_SECONDS

See SocketOptions.SO_LINGER

See Also:

Constant Field Values

DEFAULT_SOCKET_KEEP_IDLE_SECONDS

public static final int DEFAULT_SOCKET_KEEP_IDLE_SECONDS

See jdk.net.ExtendedSocketOptions#TCP_KEEPIDLE

See Also:

Constant Field Values

DEFAULT_SOCKET_KEEP_INTERVAL_SECONDS

public static final int DEFAULT_SOCKET_KEEP_INTERVAL_SECONDS

See jdk.net.ExtendedSocketOptions#TCP_KEEPINTERVAL

See Also:

Constant Field Values

DEFAULT_SOCKET_KEEP_COUNT

public static final int DEFAULT_SOCKET_KEEP_COUNT

See jdk.net.ExtendedSocketOptions#TCP_KEEPINTERVAL

See Also:

Constant Field Values

name

protected String name

protocolType

protected com.hazelcast.instance.ProtocolType protocolType

interfaces

protected InterfacesConfig interfaces

socketInterceptorConfig

protected SocketInterceptorConfig socketInterceptorConfig

sslConfig

protected SSLConfig sslConfig

symmetricEncryptionConfig

protected SymmetricEncryptionConfig symmetricEncryptionConfig

Constructor Detail

EndpointConfig

public EndpointConfig()

Method Detail

getProtocolType

public com.hazelcast.instance.ProtocolType getProtocolType()

getName

public String getName()

Specified by:

getName in interface NamedConfig

setName

public EndpointConfig setName(String name)

Specified by:

setName in interface NamedConfig

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 EndpointConfig 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()

getQualifier

public com.hazelcast.instance.EndpointQualifier getQualifier()

getOutboundPortDefinitions

public Collection<String> getOutboundPortDefinitions()

setOutboundPortDefinitions

public EndpointConfig setOutboundPortDefinitions(Collection<String> outboundPortDefs)

addOutboundPortDefinition

public EndpointConfig addOutboundPortDefinition(String portDef)

getOutboundPorts

public Collection<Integer> getOutboundPorts()

setOutboundPorts

public EndpointConfig setOutboundPorts(Collection<Integer> outboundPorts)

addOutboundPort

public EndpointConfig addOutboundPort(int port)

getInterfaces

public InterfacesConfig getInterfaces()

Returns:

the interfaces

setInterfaces

public EndpointConfig setInterfaces(InterfacesConfig interfaces)

Parameters:

interfaces - the interfaces to set

isSocketBufferDirect

public boolean isSocketBufferDirect()

setSocketBufferDirect

public EndpointConfig setSocketBufferDirect(boolean socketBufferDirect)

isSocketTcpNoDelay

public boolean isSocketTcpNoDelay()

isSocketKeepAlive

public boolean isSocketKeepAlive()

setSocketKeepAlive

public EndpointConfig setSocketKeepAlive(boolean socketKeepAlive)

setSocketTcpNoDelay

public EndpointConfig setSocketTcpNoDelay(boolean socketTcpNoDelay)

getSocketSendBufferSizeKb

public int getSocketSendBufferSizeKb()

setSocketSendBufferSizeKb

public EndpointConfig setSocketSendBufferSizeKb(int socketSendBufferSizeKb)

getSocketRcvBufferSizeKb

public int getSocketRcvBufferSizeKb()

setSocketRcvBufferSizeKb

public EndpointConfig setSocketRcvBufferSizeKb(int socketRcvBufferSizeKb)

getSocketLingerSeconds

public int getSocketLingerSeconds()

setSocketLingerSeconds

public EndpointConfig setSocketLingerSeconds(int socketLingerSeconds)

getSocketConnectTimeoutSeconds

public int getSocketConnectTimeoutSeconds()

setSocketConnectTimeoutSeconds

public EndpointConfig setSocketConnectTimeoutSeconds(int socketConnectTimeoutSeconds)

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 EndpointConfig 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

getSSLConfig

public SSLConfig getSSLConfig()

Returns the current SSLConfig. It is possible that null is returned if no SSLConfig has been set.

Returns:

the SSLConfig

See Also:

setSSLConfig(SSLConfig)

setSSLConfig

public EndpointConfig setSSLConfig(SSLConfig sslConfig)

Sets the SSLConfig. null value indicates that no SSLConfig should be used.

Parameters:

sslConfig - the SSLConfig

Returns:

the updated NetworkConfig

See Also:

getSSLConfig()

getAltoSocketConfig

@Beta
 @Nonnull
public AltoSocketConfig getAltoSocketConfig()

Gets the Alto socket config. Can't return null.

Returns:

the Alto socket config

Since:

5.3

See Also:

AltoConfig

setAltoSocketConfig

@Beta
 @Nonnull
public EndpointConfig setAltoSocketConfig(@Nonnull
                                                          AltoSocketConfig altoSocketConfig)

Sets the Alto socket config. Can't return null.

Parameters:

altoSocketConfig - Alto socket config to set

Returns:

this endpoint config

Throws:

NullPointerException - if altoSocketConfig is null

Since:

5.3

See Also:

AltoConfig

setProtocolType

@PrivateApi
public EndpointConfig setProtocolType(com.hazelcast.instance.ProtocolType protocolType)

getSocketKeepIdleSeconds

public int getSocketKeepIdleSeconds()

Keep-Alive idle time: the number of seconds of idle time before keep-alive initiates a probe. This option is only applicable when keep alive is true. Requires a recent JDK 8, JDK 11 or greater version that includes the required JDK support.

Returns:

the configured value of Keep-Alive idle time.

Since:

5.3.0

See Also:

setSocketKeepIdleSeconds

public EndpointConfig setSocketKeepIdleSeconds(int socketKeepIdleSeconds)

Set the number of seconds a connection needs to be idle before TCP begins sending out keep-alive probes. This option is only applicable when keep alive is true. Requires a recent JDK 8, JDK 11 or greater version that includes the required JDK support.

Since:

5.3.0

See Also:

getSocketKeepIntervalSeconds

public int getSocketKeepIntervalSeconds()

Keep-Alive interval: the number of seconds between keep-alive probes. This option is only applicable when keep alive is true. Requires a recent JDK 8, JDK 11 or greater version that includes the required JDK support.

Returns:

the configured value of Keep-Alive interval time.

Since:

5.3.0

See Also:

setSocketKeepIntervalSeconds

public EndpointConfig setSocketKeepIntervalSeconds(int socketKeepIntervalSeconds)

Set the number of seconds between keep-alive probes. Notice that this is the number of seconds between probes after the initial keep-alive idle time has passed. This option is only applicable when keep alive is true. Requires a recent JDK 8, JDK 11 or greater version that includes the required JDK support.

Since:

5.3.0

See Also:

getSocketKeepCount

public int getSocketKeepCount()

Keep-Alive count: the maximum number of TCP keep-alive probes to send before giving up and closing the connection if no response is obtained from the other side. This option is only applicable when keep alive is true. Requires a recent JDK 8, JDK 11 or greater version that includes the required JDK support.

Returns:

the configured value of Keep-Alive probe count.

Since:

5.3.0

See Also:

setSocketKeepCount

public EndpointConfig setSocketKeepCount(int socketKeepCount)

Set the maximum number of TCP keep-alive probes to send before giving up and closing the connection if no response is obtained from the other side. This option is only applicable when keep alive is true. Requires a recent JDK 8, JDK 11 or greater version that includes the required JDK support.

Since:

5.3.0

See Also:

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object