A cron-like expression, extending the usual UN*X definition to include triggers on the second, minute, hour, day of month, month, and day of week. For example, 0 * * * * MON-FRI means once per minute on weekdays (at the top of the minute - the 0th second) or 0 0 0 * * * means every day at midnight. * Note that when cron expressions are defined, the start delay and repeat interval settings are must be removed and set to blank.

org.apereo.cas.configuration.model.support.quartz.SchedulingProperties.

_{How can I configure this property?}

A time zone for which the cron expression will be resolved. By default, this attribute is empty (i.e. the scheduler's time zone will be used).

org.apereo.cas.configuration.model.support.quartz.SchedulingProperties.

_{How can I configure this property?}

Whether scheduler should be enabled to schedule the job to run.

org.apereo.cas.configuration.model.support.quartz.SchedulingProperties.

_{How can I configure this property?}

Overrides SchedulingProperties#enabled property value of true if this property does not match hostname of CAS server. This can be useful if deploying CAS with an image in a statefulset where all names are predictable but where having different configurations for different servers is hard. The value can be an exact hostname or a regular expression that will be used to match the hostname.

This settings supports regular expression patterns. ^[?].

org.apereo.cas.configuration.model.support.quartz.SchedulingProperties.

_{How can I configure this property?}

String representation of a repeat interval of re-loading data for a data store implementation. This is the timeout between consecutive job’s executions.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.quartz.SchedulingProperties.

_{How can I configure this property?}

String representation of a start delay of loading data for a data store implementation. This is the delay between scheduler startup and first job’s execution

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.quartz.SchedulingProperties.

_{How can I configure this property?}

Hazelcast supports both synchronous and asynchronous backups. By default, backup operations are synchronous. In this case, backup operations block operations until backups are successfully copied to backup members (or deleted from backup members in case of remove) and acknowledgements are received. Therefore, backups are updated before a put operation is completed, provided that the cluster is stable. Asynchronous backups, on the other hand, do not block operations. They are fire and forget and do not require acknowledgements; the backup operations are performed at some point in time.

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

_{How can I configure this property?}

Used when replication is turned on with #isReplicated().

If a new member joins the cluster, there are two ways you can handle the initial provisioning that is executed to replicate all existing values to the new member. Each involves how you configure the async fill up.

• First, you can configure async fill up to true, which does not block reads while the fill up operation is underway. That way, you have immediate access on the new member, but it will take time until all the values are eventually accessible. Not yet replicated values are returned as non-existing (null).
• Second, you can configure for a synchronous initial fill up (by configuring the async fill up to false), which blocks every read or write access to the map until the fill up operation is finished. Use this with caution since it might block your application from operating.

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

_{How can I configure this property?}

To provide data safety, Hazelcast allows you to specify the number of backup copies you want to have. That way, data on a cluster member will be copied onto other member(s). To create synchronous backups, select the number of backup copies. When this count is 1, a map entry will have its backup on one other member in the cluster. If you set it to 2, then a map entry will have its backup on two other members. You can set it to 0 if you do not want your entries to be backed up, e.g., if performance is more important than backing up. The maximum value for the backup count is 6. Sync backup operations have a blocking cost which may lead to latency issues.

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

_{How can I configure this property?}

CP Subsystem is a component of a Hazelcast cluster that builds a strongly consistent layer for a set of distributed data structures. Its data structures are CP with respect to the CAP principle, i.e., they always maintain linearizability and prefer consistency over availability during network partitions. Besides network partitions, CP Subsystem withstands server and client failures. All members of a Hazelcast cluster do not necessarily take part in CP Subsystem. The number of Hazelcast members that take part in CP Subsystem is specified here. CP Subsystem must have at least 3 CP members.

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

_{How can I configure this property?}

Hazelcast supports policy-based eviction for distributed maps. Currently supported policies are LRU (Least Recently Used) and LFU (Least Frequently Used) and NONE. See this for more info.

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

_{How can I configure this property?}

Hazelcast has a flexible logging configuration and doesn't depend on any logging framework except JDK logging. It has in-built adaptors for a number of logging frameworks and also supports custom loggers by providing logging interfaces. To use built-in adaptors you should set this setting to one of predefined types below.

• jdk: JDK logging
• log4j: Log4j
• slf4j: Slf4j
• none: Disable logging

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

_{How can I configure this property?}

Define how data items in Hazelcast maps are merged together from source to destination. By default, merges map entries from source to destination if they don't exist in the destination map. Accepted values are:

• PUT_IF_ABSENT: Merges data structure entries from source to destination if they don't exist in the destination data structure.
• HIGHER_HITS: * Merges data structure entries from source to destination data structure if the source entry has more hits than the destination one.
• DISCARD: Merges only entries from the destination data structure and discards all entries from the source data structure.
• PASS_THROUGH: Merges data structure entries from source to destination directly unless the merging entry is null
• EXPIRATION_TIME: Merges data structure entries from source to destination data structure if the source entry will expire later than the destination entry. This policy can only be used if the clocks of the nodes are in sync.
• LATEST_UPDATE: Merges data structure entries from source to destination data structure if the source entry was updated more frequently than the destination entry. This policy can only be used if the clocks of the nodes are in sync.
• LATEST_ACCESS: Merges data structure entries from source to destination data structure if the source entry has been accessed more recently than the destination entry. This policy can only be used if the clocks of the nodes are in sync.

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

_{How can I configure this property?}

Max timeout of heartbeat in seconds for a node to assume it is dead.

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

_{How can I configure this property?}

Sets the maximum size of the map.

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

_{How can I configure this property?}

• FREE_HEAP_PERCENTAGE: Policy based on minimum free JVM heap memory percentage per JVM.
• FREE_HEAP_SIZE: Policy based on minimum free JVM heap memory in megabytes per JVM.
• FREE_NATIVE_MEMORY_PERCENTAGE: Policy based on minimum free native memory percentage per Hazelcast instance.
• FREE_NATIVE_MEMORY_SIZE: Policy based on minimum free native memory in megabytes per Hazelcast instance.
• PER_NODE: Policy based on maximum number of entries stored per data structure (map, cache etc) on each Hazelcast instance.
• PER_PARTITION: Policy based on maximum number of entries stored per data structure (map, cache etc) on each partition.
• USED_HEAP_PERCENTAGE: Policy based on maximum used JVM heap memory percentage per data structure (map, cache etc) on each Hazelcast instance .
• USED_HEAP_SIZE: Policy based on maximum used JVM heap memory in megabytes per data structure (map, cache etc) on each Hazelcast instance.
• USED_NATIVE_MEMORY_PERCENTAGE: Policy based on maximum used native memory percentage per data structure (map, cache etc) on each Hazelcast instance.
• USED_NATIVE_MEMORY_SIZE: Policy based on maximum used native memory in megabytes per data structure (map, cache etc) on each Hazelcast instance .

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

_{How can I configure this property?}

With PartitionGroupConfig, you can control how primary and backup partitions are mapped to physical Members. Hazelcast will always place partitions on different partition groups so as to provide redundancy. Accepted value are: PER_MEMBER, HOST_AWARE, CUSTOM, ZONE_AWARE, SPI. In all cases a partition will never be created on the same group. If there are more partitions defined than there are partition groups, then only those partitions, up to the number of partition groups, will be created. For example, if you define 2 backups, then with the primary, that makes 3. If you have only two partition groups only two will be created.

• {}PER_MEMBER Partition Groups}: This is the default partition scheme and is used if no other scheme is defined. Each Member is in a group of its own.</li>
• {}HOST_AWARE Partition Groups}: In this scheme, a group corresponds to a host, based on its IP address. Partitions will not be written to any other members on the same host. This scheme provides good redundancy when multiple instances are being run on the same host.</li>
• {}CUSTOM Partition Groups}: In this scheme, IP addresses, or IP address ranges, are allocated to groups. Partitions are not written to the same group. This is very useful for ensuring partitions are written to different racks or even availability zones.</li>
• {}ZONE_AWARE Partition Groups}: In this scheme, groups are allocated according to the metadata provided by Discovery SPI Partitions are not written to the same group. This is very useful for ensuring partitions are written to availability zones or different racks without providing the IP addresses to the config ahead.</li>
• {}SPI Partition Groups}: In this scheme, groups are allocated according to the implementation provided by Discovery SPI.</li> </ul> </p>

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

  _{How can I configure this property?}

  CAS Property: cas.authn.throttle.hazelcast.cluster.core.partition-member-group-type

  Configuration properties can be included and activated using the following strategies.

  :information_source: Note

  When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

  • Java Property
  • YAML Property
  • System Property
  • Environment Variable
  • Command-line Argument

  CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

  
  1
  
  cas.authn.throttle.hazelcast.cluster.core.partition-member-group-type=...
  
  

  This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework.

  CAS properties can be specified using the YAML syntax:

  
  1
  
  cas: 
    authn: 
      throttle: 
        hazelcast: 
          cluster: 
            core: 
              partition-member-group-type: "..."
  
  

  Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

  CAS properties can be passed to the CAS web application as system properties, when the application is launched:

  
  1
  
  java -Dcas.authn.throttle.hazelcast.cluster.core.partition-member-group-type="..." -jar build/libs/cas.war
  
  

  The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory. Note the placement of the system property which must be specified before the CAS web application is launched.

  CAS properties can specified as system environment variables before the CAS web application is launched:

  
  1
  2
  3
  
  export CAS_AUTHN_THROTTLE_HAZELCAST_CLUSTER_CORE_PARTITION_MEMBER_GROUP_TYPE="..."
  
  java -jar build/libs/cas.war
  
  

  The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

  CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

  
  1
  
  java -jar build/libs/cas.war --cas.authn.throttle.hazelcast.cluster.core.partition-member-group-type="..."
  
  

  The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.
  </div></td> </tr>

A Replicated Map is a distributed key-value data structure where the data is replicated to all members in the cluster. It provides full replication of entries to all members for high speed access. A Replicated Map does not partition data (it does not spread data to different cluster members); instead, it replicates the data to all members. Replication leads to higher memory consumption. However, a Replicated Map has faster read and write access since the data is available on all members. Writes could take place on local/remote members in order to provide write-order, eventually being replicated to all other members.

If you have a large cluster or very high occurrences of updates, the Replicated Map may not scale linearly as expected since it has to replicate update operations to all members in the cluster. Since the replication of updates is performed in an asynchronous manner, Hazelcast recommends you enable back pressure in case your system has high occurrences of updates.

Note that Replicated Map does not guarantee eventual consistency because there are some edge cases that fail to provide consistency.

Replicated Map uses the internal partition system of Hazelcast in order to serialize updates happening on the same key at the same time. This happens by sending updates of the same key to the same Hazelcast member in the cluster.

Due to the asynchronous nature of replication, a Hazelcast member could die before successfully replicating a "write" operation to other members after sending the "write completed" response to its caller during the write process. In this scenario, Hazelcast’s internal partition system promotes one of the replicas of the partition as the primary one. The new primary partition does not have the latest "write" since the dead member could not successfully replicate the update.

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

_{How can I configure this property?}

Connection timeout in seconds for the TCP/IP config and members joining the cluster.

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

_{How can I configure this property?}

Whether discovery should be enabled via the configured strategies below.

org.apereo.cas.configuration.model.support.hazelcast.discovery.HazelcastDiscoveryProperties.

_{How can I configure this property?}

Enables a multicast configuration using a group address and port. Contains the configuration for the multicast discovery mechanism. With the multicast discovery mechanism Hazelcast allows Hazelcast members to find each other using multicast. So Hazelcast members do not need to know concrete addresses of members, they just multicast to everyone listening. It depends on your environment if multicast is possible or allowed; otherwise you need to have a look at the tcp/ip cluster

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

_{How can I configure this property?}

The multicast group address used for discovery. With the multicast auto-discovery mechanism, Hazelcast allows cluster members to find each other using multicast communication. The cluster members do not need to know the concrete addresses of the other members, as they just multicast to all the other members for listening. Whether multicast is possible or allowed depends on your environment.

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

_{How can I configure this property?}

The multicast port used for discovery.

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

_{How can I configure this property?}

Gets the time to live for the multicast package in seconds. This is the default time-to-live for multicast packets sent out on the socket

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

_{How can I configure this property?}

specifies the time in seconds that a member should wait for a valid multicast response from another member running in the network before declaring itself the leader member (the first member joined to the cluster) and creating its own cluster. This only applies to the startup of members where no leader has been assigned yet. If you specify a high value, such as 60 seconds, it means that until a leader is selected, each member will wait 60 seconds before moving on. Be careful when providing a high value. Also, be careful not to set the value too low, or the members might give up too early and create their own cluster.

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

_{How can I configure this property?}

Multicast trusted interfaces for discovery. With the multicast auto-discovery mechanism, Hazelcast allows cluster members to find each other using multicast communication. The cluster members do not need to know the concrete addresses of the other members, as they just multicast to all the other members for listening. Whether multicast is possible or allowed depends on your environment.

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

_{How can I configure this property?}

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.

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

_{How can I configure this property?}

If this property is set, then this is the address where the server socket is bound to.

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

_{How can I configure this property?}

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.

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

_{How can I configure this property?}

The outbound ports for the Hazelcast configuration.

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

_{How can I configure this property?}

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

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

_{How can I configure this property?}

The default public address to be advertised to other cluster members and clients.

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

_{How can I configure this property?}

Comma-separated list of cipher suite names allowed to be used. Its default value are all supported suites in your Java runtime.

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

_{How can I configure this property?}

Name of the algorithm based on which the authentication keys are provided.

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

_{How can I configure this property?}

Type of the keystore. Its default value is JKS. Another commonly used type is the PKCS12. Available keystore/truststore types depend on your Operating system and the Java runtime. Only needed when the mutual authentication is used.

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

_{How can I configure this property?}