Package org.apereo.cas.configuration.model.support.hazelcast

Class HazelcastNetworkClusterProperties

java.lang.Object
org.apereo.cas.configuration.model.support.hazelcast.HazelcastNetworkClusterProperties
All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-support-hazelcast-core") public class HazelcastNetworkClusterProperties extends Object implements Serializable
This is HazelcastNetworkClusterProperties.
Since:
6.4.0
See Also:

  • Constructor Details

    • HazelcastNetworkClusterProperties

      public HazelcastNetworkClusterProperties()

  • Method Details

    • isTcpipEnabled

      public boolean isTcpipEnabled()
      Enable TCP/IP config. Contains the configuration for the Tcp/Ip join mechanism. The Tcp/Ip join mechanism relies on one or more well known members. So when a new member wants to join a cluster, it will try to connect to one of the well known members. If it is able to connect, it will now about all members in the cluster and doesn't rely on these well known members anymore.

    • getMembers

      public List<String> getMembers()
      Sets the well known members. If members is empty, calling this method will have the same effect as calling clear(). A member can be a comma separated string, e..g 10.11.12.1,10.11.12.2 which indicates multiple members are going to be added. The list of members must include ALL CAS server node, including the current node that owns this configuration.

    • isPortAutoIncrement

      public boolean isPortAutoIncrement()
      You may also want to choose to use only one port. In that case, you can disable the auto-increment feature of port.

    • getPort

      public int getPort()
      You can specify the ports which Hazelcast will use to communicate between cluster members. The name of the parameter for this is port and its default value is 5701. By default, Hazelcast will try 100 ports to bind. Meaning that, if you set the value of port as 5701, as members are joining to the cluster, Hazelcast tries to find ports between 5701 and 5801.

    • getOutboundPorts

      public List<String> getOutboundPorts()
      The outbound ports for the Hazelcast configuration.

    • getLocalAddress

      public String getLocalAddress()
      If this property is set, then this is the address where the server socket is bound to.

    • getPublicAddress

      public String getPublicAddress()
      The default public address to be advertised to other cluster members and clients.

    • getNetworkInterfaces

      public String getNetworkInterfaces()
      You can specify which network interfaces that Hazelcast should use. Servers mostly have more than one network interface, so you may want to list the valid IPs. Range characters ('*' and '-') can be used for simplicity. For instance, 10.3.10.* refers to IPs between 10.3.10.0 and 10.3.10.255. Interface 10.3.10.4-18 refers to IPs between 10.3.10.4 and 10.3.10.18 (4 and 18 included). If network interface configuration is enabled (it is disabled by default) and if Hazelcast cannot find an matching interface, then it will print a message on the console and will not start on that node.

      Interfaces can be separated by a comma.

    • isIpv4Enabled

      public boolean isIpv4Enabled()
      IPv6 support has been switched off by default, since some platforms have issues in use of IPv6 stack. And some other platforms such as Amazon AWS have no support at all. To enable IPv6 support set this setting to false.

    • getSsl

      public HazelcastNetworkSslProperties getSsl()
      You can use the SSL (Secure Sockets Layer) protocol to establish an encrypted communication across your Hazelcast cluster with key stores and trust stores.

    • setTcpipEnabled

      public HazelcastNetworkClusterProperties setTcpipEnabled(boolean tcpipEnabled)
      Enable TCP/IP config. Contains the configuration for the Tcp/Ip join mechanism. The Tcp/Ip join mechanism relies on one or more well known members. So when a new member wants to join a cluster, it will try to connect to one of the well known members. If it is able to connect, it will now about all members in the cluster and doesn't rely on these well known members anymore.
      Returns:
      this.

    • setMembers

      public HazelcastNetworkClusterProperties setMembers(List<String> members)
      Sets the well known members. If members is empty, calling this method will have the same effect as calling clear(). A member can be a comma separated string, e..g 10.11.12.1,10.11.12.2 which indicates multiple members are going to be added. The list of members must include ALL CAS server node, including the current node that owns this configuration.
      Returns:
      this.

    • setPortAutoIncrement

      public HazelcastNetworkClusterProperties setPortAutoIncrement(boolean portAutoIncrement)
      You may also want to choose to use only one port. In that case, you can disable the auto-increment feature of port.
      Returns:
      this.

    • setPort

      public HazelcastNetworkClusterProperties setPort(int port)
      You can specify the ports which Hazelcast will use to communicate between cluster members. The name of the parameter for this is port and its default value is 5701. By default, Hazelcast will try 100 ports to bind. Meaning that, if you set the value of port as 5701, as members are joining to the cluster, Hazelcast tries to find ports between 5701 and 5801.
      Returns:
      this.

    • setOutboundPorts

      public HazelcastNetworkClusterProperties setOutboundPorts(List<String> outboundPorts)
      The outbound ports for the Hazelcast configuration.
      Returns:
      this.

    • setLocalAddress

      public HazelcastNetworkClusterProperties setLocalAddress(String localAddress)
      If this property is set, then this is the address where the server socket is bound to.
      Returns:
      this.

    • setPublicAddress

      public HazelcastNetworkClusterProperties setPublicAddress(String publicAddress)
      The default public address to be advertised to other cluster members and clients.
      Returns:
      this.

    • setNetworkInterfaces

      public HazelcastNetworkClusterProperties setNetworkInterfaces(String networkInterfaces)
      You can specify which network interfaces that Hazelcast should use. Servers mostly have more than one network interface, so you may want to list the valid IPs. Range characters ('*' and '-') can be used for simplicity. For instance, 10.3.10.* refers to IPs between 10.3.10.0 and 10.3.10.255. Interface 10.3.10.4-18 refers to IPs between 10.3.10.4 and 10.3.10.18 (4 and 18 included). If network interface configuration is enabled (it is disabled by default) and if Hazelcast cannot find an matching interface, then it will print a message on the console and will not start on that node.

      Interfaces can be separated by a comma.

      Returns:
      this.

    • setIpv4Enabled

      public HazelcastNetworkClusterProperties setIpv4Enabled(boolean ipv4Enabled)
      IPv6 support has been switched off by default, since some platforms have issues in use of IPv6 stack. And some other platforms such as Amazon AWS have no support at all. To enable IPv6 support set this setting to false.
      Returns:
      this.

    • setSsl

      public HazelcastNetworkClusterProperties setSsl(HazelcastNetworkSslProperties ssl)
      You can use the SSL (Secure Sockets Layer) protocol to establish an encrypted communication across your Hazelcast cluster with key stores and trust stores.
      Returns:
      this.