Package org.apereo.cas.configuration.model.core.events

Class CoreEventsProperties

java.lang.Object
org.apereo.cas.configuration.model.core.events.CoreEventsProperties
All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-core-events", automated=true) public class CoreEventsProperties extends Object implements Serializable
Configuration properties class for events.
Since:
5.0.0
See Also:

  • Constructor Details

    • CoreEventsProperties

      public CoreEventsProperties()

  • Method Details

    • isEnabled

      public boolean isEnabled()
      Whether event tracking and recording functionality should be enabled.

    • isTrackGeolocation

      public boolean isTrackGeolocation()
      Whether geolocation should be tracked as part of collected authentication events. This of course requires consent from the user's browser to collect stats on location. Turning on this setting would prompt the browser to ask for user's consent to collect geo location directly. If geo location information is not available using this strategy, it may still be extracted and determined based on the client IP address at the time the event is being recorded and captured by CAS.

    • isTrackConfigurationModifications

      public boolean isTrackConfigurationModifications()
      Whether CAS should track the underlying configuration store for changes. This depends on whether the store provides that sort of functionality. When running in standalone mode, this typically translates to CAS monitoring configuration files and reloading context conditionally if there are any changes.

    • setEnabled

      public CoreEventsProperties setEnabled(boolean enabled)
      Whether event tracking and recording functionality should be enabled.
      Returns:
      this.

    • setTrackGeolocation

      public CoreEventsProperties setTrackGeolocation(boolean trackGeolocation)
      Whether geolocation should be tracked as part of collected authentication events. This of course requires consent from the user's browser to collect stats on location. Turning on this setting would prompt the browser to ask for user's consent to collect geo location directly. If geo location information is not available using this strategy, it may still be extracted and determined based on the client IP address at the time the event is being recorded and captured by CAS.
      Returns:
      this.

    • setTrackConfigurationModifications

      public CoreEventsProperties setTrackConfigurationModifications(boolean trackConfigurationModifications)
      Whether CAS should track the underlying configuration store for changes. This depends on whether the store provides that sort of functionality. When running in standalone mode, this typically translates to CAS monitoring configuration files and reloading context conditionally if there are any changes.
      Returns:
      this.