Package org.springframework.security.authorization

Class RequiredFactorError

java.lang.Object

org.springframework.security.authorization.RequiredFactorError

All Implemented Interfaces:

Serializable

public class RequiredFactorError
extends Object
implements Serializable

An error when the requirements of RequiredFactor are not met.

Since:

7.0

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static RequiredFactorError	createExpired(RequiredFactor requiredFactor)
static RequiredFactorError	createMissing(RequiredFactor requiredFactor)
boolean	equals(Object o)
RequiredFactor	getRequiredFactor()
int	hashCode()
boolean	isExpired()	True if not isMissing() but was older than the RequiredFactor.getValidDuration().
boolean	isMissing()	True if no FactorGrantedAuthority.getAuthority() on the Authentication matched RequiredFactor.getAuthority().
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getRequiredFactor

public RequiredFactor getRequiredFactor()

isExpired

public boolean isExpired()

True if not isMissing() but was older than the RequiredFactor.getValidDuration().

Returns:

true if expired, else false

isMissing

public boolean isMissing()

True if no FactorGrantedAuthority.getAuthority() on the Authentication matched RequiredFactor.getAuthority().

Returns:

true if missing, else false.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

createMissing

public static RequiredFactorError createMissing(RequiredFactor requiredFactor)

createExpired

public static RequiredFactorError createExpired(RequiredFactor requiredFactor)