Class RequiredFactor

java.lang.Object

org.springframework.security.authorization.RequiredFactor

All Implemented Interfaces:

Serializable

public final class RequiredFactor
extends Object
implements Serializable

The requirements for an GrantedAuthority to be considered a valid factor.

• If the getAuthority() is specified, then it must match GrantedAuthority.getAuthority()
• If getValidDuration() is specified, the matching GrantedAuthority must be of type FactorGrantedAuthority and FactorGrantedAuthority.getIssuedAt() must be such that it is not considered expired when compared to getValidDuration().

Since:

7.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RequiredFactor.Builder	A builder for RequiredFactor.

Method Summary

Modifier and Type	Method	Description
static RequiredFactor.Builder	builder()	Creates a new RequiredFactor.Builder.
boolean	equals(@Nullable Object o)
String	getAuthority()	The expected GrantedAuthority.getAuthority().
@Nullable Duration	getValidDuration()	How long the FactorGrantedAuthority is valid for.
int	hashCode()
String	toString()
static RequiredFactor.Builder	withAuthority(String authority)	Creates a RequiredFactor.Builder with the specified authority.

Methods inherited from class Object

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

Method Details

getAuthority

public String getAuthority()

The expected GrantedAuthority.getAuthority().

Returns:

the authority.

getValidDuration

public @Nullable Duration getValidDuration()

How long the FactorGrantedAuthority is valid for.

Returns:

equals

public boolean equals(@Nullable 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

withAuthority

public static RequiredFactor.Builder withAuthority(String authority)

Creates a RequiredFactor.Builder with the specified authority.

Parameters:

authority - the authority.

Returns:

the builder.

builder

public static RequiredFactor.Builder builder()

Creates a new RequiredFactor.Builder.

Returns: