Package org.forgerock.oauth.clients.oidc

Class Claim

java.lang.Object

org.forgerock.oauth.clients.oidc.Claim

Direct Known Subclasses:

Claim

public class Claim
extends Object

Models an OpenID Connect claim that has been requested in an authorize request.

See Claims in the OIDC specification.

Instances of this class are immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Claim.ClaimBuilder	Builder to keep the Claim immutable.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Claim(String name, Locale locale, List<Object> values, boolean essential)	The constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Locale	getJavaLocale()	Gets the Locale of this claim.
String	getLocale()	Gets the locale of this claim.
String	getName()	Gets the name of this claim without the locale suffix.
String	getNameWithLocale()	Gets the name of this claim with the locale appended after a '#' character.
List<Object>	getValues()	Get the value(s) of this claim.
int	hashCode()
boolean	isEssential()	Get whether the claim is essential.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Claim

protected Claim(String name,
                Locale locale,
                List<Object> values,
                boolean essential)

The constructor.

Parameters:

name - the name of this Claim

locale - the locale for this Claim

values - the value(s) of this Claim

essential - whether this Claim is essential

Method Detail

getLocale

public String getLocale()

Gets the locale of this claim.

See Claims Languages and Scripts in the OIDC specification.

Returns:

the locale language tag of this claim, or null if none exists

getJavaLocale

public Locale getJavaLocale()

Gets the Locale of this claim.

See Claims Languages and Scripts in the OIDC specification.

Returns:

the locale of this claim, or null if none exists

getName

public String getName()

Gets the name of this claim without the locale suffix.

Returns:

the name of this claim

getNameWithLocale

public String getNameWithLocale()

Gets the name of this claim with the locale appended after a '#' character.

Returns:

the name and locale of this claim

getValues

public List<Object> getValues()

Get the value(s) of this claim.

Returns:

the value(s) of this claim

isEssential

public boolean isEssential()

Get whether the claim is essential.

Returns:

whether the claim is essential

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object