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

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:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ThrottleFailureProperties()

Method Summary

Modifier and Type	Method	Description
String	getCode()	Failure code to record in the audit log.
int	getRangeSeconds()	Period of time in seconds for the threshold rate.
int	getThreshold()	Number of failed login attempts for the threshold rate.
String	getThrottleWindowSeconds()	Indicate the number of seconds the account should remain in a locked/throttled state before it can be released to continue again.
ThrottleFailureProperties	setCode(String code)	Failure code to record in the audit log.
ThrottleFailureProperties	setRangeSeconds(int rangeSeconds)	Period of time in seconds for the threshold rate.
ThrottleFailureProperties	setThreshold(int threshold)	Number of failed login attempts for the threshold rate.
ThrottleFailureProperties	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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ThrottleFailureProperties

public ThrottleFailureProperties()

Method Details

getCode

public String 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

public String 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

public ThrottleFailureProperties setCode(String code)

Failure code to record in the audit log. Generally this indicates an authentication failure event.

Returns:

this.

setThreshold

public ThrottleFailureProperties setThreshold(int threshold)

Number of failed login attempts for the threshold rate.

Returns:

this.

setRangeSeconds

public ThrottleFailureProperties setRangeSeconds(int rangeSeconds)

Period of time in seconds for the threshold rate.

Returns:

this.

setThrottleWindowSeconds

public ThrottleFailureProperties 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. If no value is specified, the failure threshold and rate that is calculated would hold.

Returns:

this.