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_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 ProtocolType` | `protocolType`
    `protected SocketInterceptorConfig` | `socketInterceptorConfig`
    `protected SSLConfig` | `sslConfig`
    `protected SymmetricEncryptionConfig` | `symmetricEncryptionConfig`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `EndpointConfig()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `EndpointConfig` | `addOutboundPort(int port)`
    `EndpointConfig` | `addOutboundPortDefinition(String portDef)`
    `InterfacesConfig` | `getInterfaces()`
    `String` | `getName()`
    `Collection<String>` | `getOutboundPortDefinitions()`
    `Collection<Integer>` | `getOutboundPorts()`
    `ProtocolType` | `getProtocolType()`
    `EndpointQualifier` | `getQualifier()`
    `int` | `getSocketConnectTimeoutSeconds()`
    `SocketInterceptorConfig` | `getSocketInterceptorConfig()` Gets the `SocketInterceptorConfig`.
    `int` | `getSocketLingerSeconds()`
    `int` | `getSocketRcvBufferSizeKb()`
    `int` | `getSocketSendBufferSizeKb()`
    `SSLConfig` | `getSSLConfig()` Returns the current `SSLConfig`.
    `SymmetricEncryptionConfig` | `getSymmetricEncryptionConfig()` Gets the `SymmetricEncryptionConfig`.
    `boolean` | `isSocketBufferDirect()`
    `boolean` | `isSocketKeepAlive()`
    `boolean` | `isSocketTcpNoDelay()`
    `EndpointConfig` | `setInterfaces(InterfacesConfig interfaces)`
    `EndpointConfig` | `setName(String name)`
    `EndpointConfig` | `setOutboundPortDefinitions(Collection<String> outboundPortDefs)`
    `EndpointConfig` | `setOutboundPorts(Collection<Integer> outboundPorts)`
    `EndpointConfig` | `setSocketBufferDirect(boolean socketBufferDirect)`
    `EndpointConfig` | `setSocketConnectTimeoutSeconds(int socketConnectTimeoutSeconds)`
    `EndpointConfig` | `setSocketInterceptorConfig(SocketInterceptorConfig socketInterceptorConfig)` Sets the `SocketInterceptorConfig`.
    `EndpointConfig` | `setSocketKeepAlive(boolean socketKeepAlive)`
    `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)` Sets the `SymmetricEncryptionConfig`.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, 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

    - #### name

          protected String name

    - #### protocolType

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

          public SymmetricEncryptionConfig getSymmetricEncryptionConfig()

      Gets the `SymmetricEncryptionConfig`. The value can be `null` which means that no symmetric encryption should be used.
      Returns:
        the SymmetricEncryptionConfig

    - #### setSymmetricEncryptionConfig

          public EndpointConfig setSymmetricEncryptionConfig(SymmetricEncryptionConfig symmetricEncryptionConfig)

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

Copyright © 2019. All rights reserved.