Package org.springframework.security.core.authority

Class FactorGrantedAuthority

java.lang.Object

org.springframework.security.core.authority.FactorGrantedAuthority

All Implemented Interfaces:

Serializable, GrantedAuthority

public final class FactorGrantedAuthority
extends Object
implements GrantedAuthority

A GrantedAuthority specifically used for indicating the factor used at time of authentication.

Since:

7.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FactorGrantedAuthority.Builder	Builder for FactorGrantedAuthority.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHORIZATION_CODE_AUTHORITY	The standard GrantedAuthority.getAuthority() that indicates that OAuth2 Authorization Code was used to authenticate.
static final String	BEARER_AUTHORITY	The standard GrantedAuthority.getAuthority() that indicates that bearer authentication was used to authenticate.
static final String	CAS_AUTHORITY	The standard GrantedAuthority.getAuthority() that indicates that CAS was used to authenticate.
static final String	OTT_AUTHORITY	The standard GrantedAuthority.getAuthority() that indicates that one time token was used to authenticate.
static final String	PASSWORD_AUTHORITY	The standard GrantedAuthority.getAuthority() that indicates that a password was used to authenticate.
static final String	SAML_RESPONSE_AUTHORITY	The standard GrantedAuthority.getAuthority() that indicates that SAML was used to authenticate.
static final String	WEBAUTHN_AUTHORITY	The standard GrantedAuthority.getAuthority() that indicates that WebAuthn was used to authenticate.
static final String	X509_AUTHORITY	The standard GrantedAuthority.getAuthority() that indicates that X509 was used to authenticate.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static FactorGrantedAuthority	fromAuthority(String authority)	Shortcut for withAuthority(authority).build().
static FactorGrantedAuthority	fromFactor(String factor)	Shortcut for withFactor(factor).build().
String	getAuthority()	If the GrantedAuthority can be represented as a String and that String is sufficient in precision to be relied upon for an access control decision by an AuthorizationManager (or delegate), this method should return such a String.
Instant	getIssuedAt()	Returns the instant when this authority was issued.
int	hashCode()
String	toString()
static FactorGrantedAuthority.Builder	withAuthority(String authority)	Creates a new FactorGrantedAuthority.Builder with the specified authority.
static FactorGrantedAuthority.Builder	withFactor(String factor)	Creates a new FactorGrantedAuthority.Builder with the specified factor which is automatically prefixed with "FACTOR_".

Methods inherited from class java.lang.Object

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

Field Details

AUTHORIZATION_CODE_AUTHORITY

public static final String AUTHORIZATION_CODE_AUTHORITY

The standard GrantedAuthority.getAuthority() that indicates that OAuth2 Authorization Code was used to authenticate.

See Also:

• Constant Field Values

BEARER_AUTHORITY

public static final String BEARER_AUTHORITY

The standard GrantedAuthority.getAuthority() that indicates that bearer authentication was used to authenticate.

See Also:

• Constant Field Values

CAS_AUTHORITY

public static final String CAS_AUTHORITY

The standard GrantedAuthority.getAuthority() that indicates that CAS was used to authenticate.

See Also:

• Constant Field Values

OTT_AUTHORITY

public static final String OTT_AUTHORITY

The standard GrantedAuthority.getAuthority() that indicates that one time token was used to authenticate.

See Also:

• Constant Field Values

PASSWORD_AUTHORITY

public static final String PASSWORD_AUTHORITY

The standard GrantedAuthority.getAuthority() that indicates that a password was used to authenticate.

See Also:

• Constant Field Values

SAML_RESPONSE_AUTHORITY

public static final String SAML_RESPONSE_AUTHORITY

The standard GrantedAuthority.getAuthority() that indicates that SAML was used to authenticate.

See Also:

• Constant Field Values

WEBAUTHN_AUTHORITY

public static final String WEBAUTHN_AUTHORITY

The standard GrantedAuthority.getAuthority() that indicates that WebAuthn was used to authenticate.

See Also:

• Constant Field Values

X509_AUTHORITY

public static final String X509_AUTHORITY

The standard GrantedAuthority.getAuthority() that indicates that X509 was used to authenticate.

See Also:

• Constant Field Values

Method Details

withAuthority

public static FactorGrantedAuthority.Builder withAuthority(String authority)

Creates a new FactorGrantedAuthority.Builder with the specified authority.

Parameters:

authority - the authority value (must not be null or empty)

Returns:

a new FactorGrantedAuthority.Builder

withFactor

public static FactorGrantedAuthority.Builder withFactor(String factor)

Creates a new FactorGrantedAuthority.Builder with the specified factor which is automatically prefixed with "FACTOR_".

Parameters:

factor - the factor value which is automatically prefixed with "FACTOR_" (must not be null or empty)

Returns:

a new FactorGrantedAuthority.Builder

fromAuthority

public static FactorGrantedAuthority fromAuthority(String authority)

Shortcut for withAuthority(authority).build().

Parameters:

authority - the authority value (must not be null or empty)

Returns:

a new FactorGrantedAuthority

fromFactor

public static FactorGrantedAuthority fromFactor(String factor)

Shortcut for withFactor(factor).build().

Parameters:

factor - the factor value which is automatically prefixed with "FACTOR_" (must not be null or empty)

Returns:

a new FactorGrantedAuthority

getAuthority

public String getAuthority()

Description copied from interface: GrantedAuthority

If the GrantedAuthority can be represented as a String and that String is sufficient in precision to be relied upon for an access control decision by an AuthorizationManager (or delegate), this method should return such a String.

If the GrantedAuthority cannot be expressed with sufficient precision as a String, null should be returned. Returning null will require an AccessDecisionManager (or delegate) to specifically support the GrantedAuthority implementation, so returning null should be avoided unless actually required.

Specified by:

getAuthority in interface GrantedAuthority

Returns:

a representation of the granted authority (or null if the granted authority cannot be expressed as a String with sufficient precision).

getIssuedAt

public Instant getIssuedAt()

Returns the instant when this authority was issued.

Returns:

the issued-at instant

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object