org.forgerock.openidconnect

Class Claim

java.lang.Object

org.forgerock.openidconnect.Claim

public class Claim
extends Object

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Claim(String name) Creates a new Claim.
Claim(String name, List<Object> values, boolean essential) Creates a new claim with multiple requested values.
Claim(String name, Object value) Creates a new claim with single requested value.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap()
String	getLocale() Get the locale of this claim.
String	getName() Gets the name of this claim.
List<Object>	getValues() Get the value(s) of this claim.
boolean	isEssential() Get whether the claim is essential.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Claim

public Claim(String name)

Creates a new Claim.

Parameters:

name - The name of the claim.

Claim

public Claim(String name,
             Object value)

Creates a new claim with single requested value.

Parameters:

name - The name of the claim.

value - The requested value.

Claim

public Claim(String name,
             List<Object> values,
             boolean essential)

Creates a new claim with multiple requested values.

Parameters:

name - The name of the claim.

values - The requested values.

essential - Whether this claim is deemed essential.

Method Detail

getName

public String getName()

Gets the name of this claim.

Returns:

Claim name.

getLocale

public String getLocale()

Get the locale of this claim.

Returns:

Claim's locale.

getValues

public List<Object> getValues()

Get the value(s) of this claim.

Returns:

Claim's value(s)

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

asMap

public Map<String,Object> asMap()