Package com.hazelcast.config

Class AdvancedNetworkConfig

java.lang.Object
com.hazelcast.config.AdvancedNetworkConfig
@Beta public class AdvancedNetworkConfig extends Object
Similar to NetworkConfig with the additional ability to define multiple endpoints, each with its own separate protocol/security and/or socket properties. When AdvancedNetworkConfig is present and enabled then it always takes precedence over the NetworkingConfig.
Since:
3.12
See Also:

  • Constructor Details

    • AdvancedNetworkConfig

      public AdvancedNetworkConfig()

  • Method Details

    • getMemberAddressProviderConfig

      public MemberAddressProviderConfig getMemberAddressProviderConfig()

    • setMemberAddressProviderConfig

      public AdvancedNetworkConfig setMemberAddressProviderConfig(MemberAddressProviderConfig memberAddressProviderConfig)

    • addWanEndpointConfig

      public AdvancedNetworkConfig addWanEndpointConfig(EndpointConfig endpointConfig)
      Adds the given WAN EndpointConfig to the endpoints configuration. When the argument is an EndpointConfig, then it configures network settings for the client side of outgoing network connections opened from that member. When the provided endpointconfig is a ServerSocketEndpointConfig, then the HazelcastInstance will additionally listen on the configured port for incoming WAN connections.

      Example of how to configure Hazelcast instances for active-passive WAN replication:

      • On the passive side, configure the Hazelcast instance to listen on port 8765 with SSL enabled: 
        
 Config config = new Config();
 ServerSocketEndpointConfig wanServerSocketConfig = new ServerSocketEndpointConfig().setPort(8765);
 // setup SSL config etc
 wanServerSocketConfig.getSSLConfig()
                          .setEnabled(true)
                          .setFactoryImplementation(new OpenSSLEngineFactory());
 config.getAdvancedNetworkConfig()
           .setEnabled(true)
           .addWanEndpointConfig(wanServerSocketConfig);

 HazelcastInstance passive = Hazelcast.newHazelcastInstance(config);
      • On the active side, configure the client-side of outgoing connections with SSL: 
        
 Config config = new Config();
 EndpointConfig wanEndpointConfig = new EndpointConfig().setName("wan-tokyo");
 wanEndpointConfig.getSSLConfig()
                      .setEnabled(true)
                      .setFactoryImplementation(new OpenSSLEngineFactory());
 config.getAdvancedNetworkConfig()
       .setEnabled(true)
       .addWanEndpointConfig(wanEndpointConfig);
 // setup WAN replication
 WanReplicationConfig wanReplicationConfig = new WanReplicationConfig();
 // WAN publisher config references endpoint config by name
 WanBatchReplicationPublisherConfig publisherConfig = new WanBatchReplicationPublisherConfig()
                 .setEndpoint("wan-tokyo")
                 .setTargetEndpoints("tokyo.hazelcast.com:8765");
 wanReplicationConfig.addWanBatchReplicationPublisherConfig(publisherConfig);
 config.addWanReplicationConfig(wanReplicationConfig);

 HazelcastInstance active = Hazelcast.newHazelcastInstance(config);
      Parameters:
      endpointConfig - the endpoint configuration to add
      Returns:
      this object for fluent chaining

    • setMemberEndpointConfig

      public AdvancedNetworkConfig setMemberEndpointConfig(ServerSocketEndpointConfig serverSocketEndpointConfig)
      Sets the server socket endpoint config for MEMBER protocol. If another ServerSocketEndpointConfig was previously set, it will be replaced. When starting a Hazelcast instance with AdvancedNetworkConfig enabled, its configuration must include one ServerSocketEndpointConfig for protocol type MEMBER.
      Parameters:
      serverSocketEndpointConfig - the server socket endpoint configuration
      Returns:
      this object for fluent chaining

    • setClientEndpointConfig

      public AdvancedNetworkConfig setClientEndpointConfig(ServerSocketEndpointConfig serverSocketEndpointConfig)
      Sets the server socket endpoint config for CLIENT protocol. If another ServerSocketEndpointConfig was previously set, it will be replaced. When starting a Hazelcast instance with AdvancedNetworkConfig enabled, its configuration may include at most one ServerSocketEndpointConfig for protocol type CLIENT.
      Parameters:
      serverSocketEndpointConfig - the server socket endpoint configuration
      Returns:
      this object for fluent chaining

    • setRestEndpointConfig

      @Deprecated(since="5.5", forRemoval=true) public AdvancedNetworkConfig setRestEndpointConfig(RestServerEndpointConfig restServerEndpointConfig)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 5.5, use RestConfig instead. Will be removed at 6.0.
      Sets the server socket endpoint config for REST protocol. If another ServerSocketEndpointConfig was previously set, it will be replaced. When starting a Hazelcast instance with AdvancedNetworkConfig enabled, its configuration may include at most one ServerSocketEndpointConfig for protocol type REST.
      Parameters:
      restServerEndpointConfig - the server socket endpoint configuration
      Returns:
      this object for fluent chaining
      See Also:

    • setMemcacheEndpointConfig

      public AdvancedNetworkConfig setMemcacheEndpointConfig(ServerSocketEndpointConfig memcacheEndpointConfig)
      Sets the server socket endpoint config for memcache protocol. If another ServerSocketEndpointConfig was previously set, it will be replaced.
      Parameters:
      memcacheEndpointConfig - the server socket endpoint configuration
      Returns:
      this object for fluent chaining

    • getEndpointConfigs

      public Map<com.hazelcast.instance.EndpointQualifier,EndpointConfig> getEndpointConfigs()

    • setEndpointConfigs

      public AdvancedNetworkConfig setEndpointConfigs(Map<com.hazelcast.instance.EndpointQualifier,EndpointConfig> endpointConfigs)

    • isEnabled

      public boolean isEnabled()

    • setEnabled

      public AdvancedNetworkConfig setEnabled(boolean enabled)

    • getJoin

      public JoinConfig getJoin()
      Returns the JoinConfig.
      Returns:
      the join

    • setJoin

      public AdvancedNetworkConfig setJoin(JoinConfig join)
      Parameters:
      join - the join to set

    • setIcmpFailureDetectorConfig

      public AdvancedNetworkConfig 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

      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:

    • getRestEndpointConfig

      public RestServerEndpointConfig getRestEndpointConfig()

    • 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