Package org.forgerock.oauth.clients.oidc

Class Claims

java.lang.Object

org.forgerock.oauth.clients.oidc.Claims

public final class Claims
extends Object

Models OpenID Connect claims that are requested in an authorize request.

See Claims Parameter in the OIDC specification.

Instances of this class are immutable.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID_TOKEN	The name of the id_token claims object.
static final String	USERINFO	The name of the userinfo claims object.

Constructor Summary

Constructors

Constructor	Description
Claims(Map<String,Claim> userInfoClaims, Map<String,Claim> idTokenClaims)	Creates a Claims object.
Claims(Map<String,Claim> userInfoClaims, Map<String,Claim> idTokenClaims, Map<String,Claim> customClaims)	Creates a Claims object.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Map<String,Claim>	getAllClaims()	Gets all the claims for userinfo, id_token and custom claims, as an unmodifiable map.
Map<String,Claim>	getCustomClaims()	Gets the custom claims as an unmodifiable map.
Map<String,Claim>	getIdTokenClaims()	Gets the id_token claims as an unmodifiable map.
Map<String,Claim>	getUserInfoClaims()	Gets the userinfo claims as an unmodifiable map.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Details

ID_TOKEN

public static final String ID_TOKEN

The name of the id_token claims object.

See Also:

• Constant Field Values

USERINFO

public static final String USERINFO

The name of the userinfo claims object.

See Also:

• Constant Field Values

Constructor Details

Claims

public Claims(Map<String,Claim> userInfoClaims,
 Map<String,Claim> idTokenClaims)

Creates a Claims object.

Parameters:

userInfoClaims - the userinfo claims, must not be null

idTokenClaims - the id_token claims, must not be null

Claims

public Claims(Map<String,Claim> userInfoClaims,
 Map<String,Claim> idTokenClaims,
 Map<String,Claim> customClaims)

Creates a Claims object.

Parameters:

userInfoClaims - the userinfo claims, must not be null

idTokenClaims - the id_token claims, must not be null

customClaims - the custom claims, must not be null

Method Details

getUserInfoClaims

public Map<String,Claim> getUserInfoClaims()

Gets the userinfo claims as an unmodifiable map.

Returns:

the userinfo claims

getIdTokenClaims

public Map<String,Claim> getIdTokenClaims()

Gets the id_token claims as an unmodifiable map.

Returns:

the id_token claims

getCustomClaims

public Map<String,Claim> getCustomClaims()

Gets the custom claims as an unmodifiable map.

Returns:

the custom claims

getAllClaims

public Map<String,Claim> getAllClaims()

Gets all the claims for userinfo, id_token and custom claims, as an unmodifiable map.

Returns:

all claims

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object