Class ThrottleFailureProperties
java.lang.Object
org.apereo.cas.configuration.model.support.throttle.ThrottleFailureProperties
- All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-support-throttle")
public class ThrottleFailureProperties
extends Object
implements Serializable
Configuration properties class for cas.throttle.
- Since:
- 6.4.0
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetCode()
Failure code to record in the audit log.int
Period of time in seconds for the threshold rate.int
Number of failed login attempts for the threshold rate.Indicate the number of seconds the account should remain in a locked/throttled state before it can be released to continue again.Failure code to record in the audit log.setRangeSeconds
(int rangeSeconds) Period of time in seconds for the threshold rate.setThreshold
(int threshold) Number of failed login attempts for the threshold rate.setThrottleWindowSeconds
(String throttleWindowSeconds) Indicate the number of seconds the account should remain in a locked/throttled state before it can be released to continue again.
-
Constructor Details
-
ThrottleFailureProperties
public ThrottleFailureProperties()
-
-
Method Details
-
getCode
Failure code to record in the audit log. Generally this indicates an authentication failure event. -
getThreshold
public int getThreshold()Number of failed login attempts for the threshold rate. -
getRangeSeconds
public int getRangeSeconds()Period of time in seconds for the threshold rate. -
getThrottleWindowSeconds
Indicate the number of seconds the account should remain in a locked/throttled state before it can be released to continue again. If no value is specified, the failure threshold and rate that is calculated would hold. -
setCode
Failure code to record in the audit log. Generally this indicates an authentication failure event.- Returns:
this
.
-
setThreshold
Number of failed login attempts for the threshold rate.- Returns:
this
.
-
setRangeSeconds
Period of time in seconds for the threshold rate.- Returns:
this
.
-
setThrottleWindowSeconds
Indicate the number of seconds the account should remain in a locked/throttled state before it can be released to continue again. If no value is specified, the failure threshold and rate that is calculated would hold.- Returns:
this
.
-