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

Class IgniteProperties

java.lang.Object
org.apereo.cas.configuration.model.support.ignite.IgniteProperties
All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-support-ignite-ticket-registry") public class IgniteProperties extends Object implements Serializable
This is IgniteProperties.
Since:
5.0.0
See Also:

  • Constructor Details

    • IgniteProperties

      public IgniteProperties()

  • Method Details

    • getIgniteAddress

      public List<String> getIgniteAddress()
      Used by TcpDiscoveryVmIpFinder which is an IP Finder which works only with pre-configured list of IP addresses specified via this setting. By default, this IP finder is not shared, which means that all grid nodes have to be configured with the same list of IP addresses when this IP finder is used. Parses provided values and initializes the internal collection of addresses. Addresses may be represented as follows:
      • IP address (e.g. 127.0.0.1, 9.9.9.9, etc);
      • IP address and port (e.g. 127.0.0.1:47500, 9.9.9.9:47501, etc);
      • IP address and port range (e.g. 127.0.0.1:47500..47510, 9.9.9.9:47501..47504, etc);
      • Hostname (e.g. host1.com, host2, etc);
      • Hostname and port (e.g. host1.com:47500, host2:47502, etc).
      • Hostname and port range (e.g. host1.com:47500..47510, host2:47502..47508, etc).
      If port is 0 or not provided then default port will be used (depends on discovery SPI configuration). If port range is provided (e.g. host:port1..port2) the following should be considered:
      • port1 < port2 should be true;
      • Both port1 and port2 should be greater than 0.

    • getTicketsCache

      public IgniteProperties.TicketsCache getTicketsCache()
      Settings related to tickets cache.

    • getKeyStoreType

      public String getKeyStoreType()
      Keystore type used to create a SSL context for the ticket registry.

    • getKeyStoreFilePath

      public String getKeyStoreFilePath()
      Keystore file path used to create a SSL context for the ticket registry.

    • getKeyStorePassword

      public String getKeyStorePassword()
      Keystore password used to create a SSL context for the ticket registry.

    • getTrustStoreType

      public String getTrustStoreType()
      Truststore type used to create a SSL context for the ticket registry.

    • getProtocol

      public String getProtocol()
      SSL protocol used to create a SSL context for the ticket registry.

    • getKeyAlgorithm

      public String getKeyAlgorithm()
      The key algorithm to use when creating SSL context.

    • getTrustStoreFilePath

      public String getTrustStoreFilePath()
      Truststore file path used to create a SSL context for the ticket registry.

    • getTrustStorePassword

      public String getTrustStorePassword()
      Truststore password used to create a SSL context for the ticket registry.

    • getAckTimeout

      public String getAckTimeout()
      Sets timeout for receiving acknowledgement for sent message. If acknowledgement is not received within this timeout, sending is considered as failed and SPI tries to repeat message sending.

    • getJoinTimeout

      public String getJoinTimeout()
      Sets join timeout. If non-shared IP finder is used and node fails to connect to any address from IP finder, node keeps trying to join within this timeout. If all addresses are still unresponsive, exception is thrown and node startup fails.

    • getLocalAddress

      public String getLocalAddress()
      Sets local host IP address that discovery SPI uses. If not provided, by default a first found non-loopback address will be used. If there is no non-loopback address available, then InetAddress.getLocalHost() will be used.

    • getLocalPort

      public int getLocalPort()
      Sets local port to listen to.

    • getNetworkTimeout

      public String getNetworkTimeout()
      Sets maximum network timeout to use for network operations.

    • getSocketTimeout

      public String getSocketTimeout()
      Sets socket operations timeout. This timeout is used to limit connection time and write-to-socket time. Note that when running Ignite on Amazon EC2, socket timeout must be set to a value significantly greater than the default (e.g. to 30000).

    • getThreadPriority

      public int getThreadPriority()
      Sets thread priority. All threads within SPI will be started with it.

    • getDefaultRegionMaxSize

      public long getDefaultRegionMaxSize()
      By default, Ignite nodes consume up to 20% of the RAM available locally, and in most cases, ​this is the only parameter you might need to change. Using the below setting allows you to change the default region memory size.

    • isDefaultPersistenceEnabled

      public boolean isDefaultPersistenceEnabled()
      Ignite native persistence is a distributed ACID and SQL-compliant disk store that transparently integrates with Ignite's durable memory. Ignite persistence is optional and can be turned on and off. When turned off Ignite becomes a pure in-memory store. With the native persistence enabled, Ignite always stores a superset of data on disk, and as much as it can in RAM based on the capacity of the latter. For example, if there are 100 entries and RAM has the capacity to store only 20, then all 100 will be stored on disk and only 20 will be cached in RAM for better performance. Also, it is worth mentioning that as with a pure in-memory use case, when the persistence is turned on, every individual cluster node persists only a subset of the data, only including partitions for which the node is either primary or backup. Collectively, the whole cluster contains the full data set.

    • isClientMode

      public boolean isClientMode()
      Start in client mode. If true the local node is started as a client.

    • isForceServerMode

      public boolean isForceServerMode()
      Sets force server mode flag. If true TcpDiscoverySpi is started in server mode regardless of IgniteConfiguration.isClientMode().

    • getCrypto

      public EncryptionRandomizedSigningJwtCryptographyProperties getCrypto()
      Crypto settings for the registry.

    • setIgniteAddress

      public IgniteProperties setIgniteAddress(List<String> igniteAddress)
      Used by TcpDiscoveryVmIpFinder which is an IP Finder which works only with pre-configured list of IP addresses specified via this setting. By default, this IP finder is not shared, which means that all grid nodes have to be configured with the same list of IP addresses when this IP finder is used. Parses provided values and initializes the internal collection of addresses. Addresses may be represented as follows:
      • IP address (e.g. 127.0.0.1, 9.9.9.9, etc);
      • IP address and port (e.g. 127.0.0.1:47500, 9.9.9.9:47501, etc);
      • IP address and port range (e.g. 127.0.0.1:47500..47510, 9.9.9.9:47501..47504, etc);
      • Hostname (e.g. host1.com, host2, etc);
      • Hostname and port (e.g. host1.com:47500, host2:47502, etc).
      • Hostname and port range (e.g. host1.com:47500..47510, host2:47502..47508, etc).
      If port is 0 or not provided then default port will be used (depends on discovery SPI configuration). If port range is provided (e.g. host:port1..port2) the following should be considered:
      • port1 < port2 should be true;
      • Both port1 and port2 should be greater than 0.
      Returns:
      this.

    • setTicketsCache

      public IgniteProperties setTicketsCache(IgniteProperties.TicketsCache ticketsCache)
      Settings related to tickets cache.
      Returns:
      this.

    • setKeyStoreType

      public IgniteProperties setKeyStoreType(String keyStoreType)
      Keystore type used to create a SSL context for the ticket registry.
      Returns:
      this.

    • setKeyStoreFilePath

      public IgniteProperties setKeyStoreFilePath(String keyStoreFilePath)
      Keystore file path used to create a SSL context for the ticket registry.
      Returns:
      this.

    • setKeyStorePassword

      public IgniteProperties setKeyStorePassword(String keyStorePassword)
      Keystore password used to create a SSL context for the ticket registry.
      Returns:
      this.

    • setTrustStoreType

      public IgniteProperties setTrustStoreType(String trustStoreType)
      Truststore type used to create a SSL context for the ticket registry.
      Returns:
      this.

    • setProtocol

      public IgniteProperties setProtocol(String protocol)
      SSL protocol used to create a SSL context for the ticket registry.
      Returns:
      this.

    • setKeyAlgorithm

      public IgniteProperties setKeyAlgorithm(String keyAlgorithm)
      The key algorithm to use when creating SSL context.
      Returns:
      this.

    • setTrustStoreFilePath

      public IgniteProperties setTrustStoreFilePath(String trustStoreFilePath)
      Truststore file path used to create a SSL context for the ticket registry.
      Returns:
      this.

    • setTrustStorePassword

      public IgniteProperties setTrustStorePassword(String trustStorePassword)
      Truststore password used to create a SSL context for the ticket registry.
      Returns:
      this.

    • setAckTimeout

      public IgniteProperties setAckTimeout(String ackTimeout)
      Sets timeout for receiving acknowledgement for sent message. If acknowledgement is not received within this timeout, sending is considered as failed and SPI tries to repeat message sending.
      Returns:
      this.

    • setJoinTimeout

      public IgniteProperties setJoinTimeout(String joinTimeout)
      Sets join timeout. If non-shared IP finder is used and node fails to connect to any address from IP finder, node keeps trying to join within this timeout. If all addresses are still unresponsive, exception is thrown and node startup fails.
      Returns:
      this.

    • setLocalAddress

      public IgniteProperties setLocalAddress(String localAddress)
      Sets local host IP address that discovery SPI uses. If not provided, by default a first found non-loopback address will be used. If there is no non-loopback address available, then InetAddress.getLocalHost() will be used.
      Returns:
      this.

    • setLocalPort

      public IgniteProperties setLocalPort(int localPort)
      Sets local port to listen to.
      Returns:
      this.

    • setNetworkTimeout

      public IgniteProperties setNetworkTimeout(String networkTimeout)
      Sets maximum network timeout to use for network operations.
      Returns:
      this.

    • setSocketTimeout

      public IgniteProperties setSocketTimeout(String socketTimeout)
      Sets socket operations timeout. This timeout is used to limit connection time and write-to-socket time. Note that when running Ignite on Amazon EC2, socket timeout must be set to a value significantly greater than the default (e.g. to 30000).
      Returns:
      this.

    • setThreadPriority

      public IgniteProperties setThreadPriority(int threadPriority)
      Sets thread priority. All threads within SPI will be started with it.
      Returns:
      this.

    • setDefaultRegionMaxSize

      public IgniteProperties setDefaultRegionMaxSize(long defaultRegionMaxSize)
      By default, Ignite nodes consume up to 20% of the RAM available locally, and in most cases, ​this is the only parameter you might need to change. Using the below setting allows you to change the default region memory size.
      Returns:
      this.

    • setDefaultPersistenceEnabled

      public IgniteProperties setDefaultPersistenceEnabled(boolean defaultPersistenceEnabled)
      Ignite native persistence is a distributed ACID and SQL-compliant disk store that transparently integrates with Ignite's durable memory. Ignite persistence is optional and can be turned on and off. When turned off Ignite becomes a pure in-memory store. With the native persistence enabled, Ignite always stores a superset of data on disk, and as much as it can in RAM based on the capacity of the latter. For example, if there are 100 entries and RAM has the capacity to store only 20, then all 100 will be stored on disk and only 20 will be cached in RAM for better performance. Also, it is worth mentioning that as with a pure in-memory use case, when the persistence is turned on, every individual cluster node persists only a subset of the data, only including partitions for which the node is either primary or backup. Collectively, the whole cluster contains the full data set.
      Returns:
      this.

    • setClientMode

      public IgniteProperties setClientMode(boolean clientMode)
      Start in client mode. If true the local node is started as a client.
      Returns:
      this.

    • setForceServerMode

      public IgniteProperties setForceServerMode(boolean forceServerMode)
      Sets force server mode flag. If true TcpDiscoverySpi is started in server mode regardless of IgniteConfiguration.isClientMode().
      Returns:
      this.

    • setCrypto

      public IgniteProperties setCrypto(EncryptionRandomizedSigningJwtCryptographyProperties crypto)
      Crypto settings for the registry.
      Returns:
      this.