Class ClaimsSetRequest.Entry
- java.lang.Object
-
- com.nimbusds.openid.connect.sdk.claims.ClaimsSetRequest.Entry
-
- Enclosing class:
- ClaimsSetRequest
@Immutable public static class ClaimsSetRequest.Entry extends Object
Individual OpenID claim request.Related specifications:
- OpenID Connect Core 1.0, section 5.5.1.
- OpenID Connect for Identity Assurance 1.0.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,Object>
getAdditionalInformation()
Returns the additional information for the claim.String
getClaimName()
Returns the claim name.String
getClaimName(boolean withLangTag)
Returns the claim name, optionally with the language tag appended.ClaimRequirement
getClaimRequirement()
Returns the claim requirement.com.nimbusds.langtag.LangTag
getLangTag()
Returns the optional language tag for the claim.String
getPurpose()
Returns the optional purpose for which the claim is requested.String
getValue()
Returns the requested value for the claim.List<String>
getValues()
Returns the requested values for the claim.static ClaimsSetRequest.Entry
parse(Map.Entry<String,net.minidev.json.JSONObject> jsonObjectEntry)
Parses an individual claim request from the specified JSON object entry.Map.Entry<String,net.minidev.json.JSONObject>
toJSONObjectEntry()
Returns the JSON object entry for this individual claim request.ClaimsSetRequest.Entry
withAdditionalInformation(Map<String,Object> additionalInformation)
Sets additional information for the requested claim.ClaimsSetRequest.Entry
withClaimRequirement(ClaimRequirement requirement)
Sets the claim requirement.ClaimsSetRequest.Entry
withLangTag(com.nimbusds.langtag.LangTag langTag)
Sets the language tag for the claim.ClaimsSetRequest.Entry
withPurpose(String purpose)
Sets the purpose for which the claim is requested.ClaimsSetRequest.Entry
withValue(String value)
Sets the requested value for the claim.ClaimsSetRequest.Entry
withValues(List<String> values)
Sets the requested values for the claim.
-
-
-
Method Detail
-
getClaimName
public String getClaimName()
Returns the claim name.- Returns:
- The claim name.
-
getClaimName
public String getClaimName(boolean withLangTag)
Returns the claim name, optionally with the language tag appended.Example with language tag:
name#de-DE
- Parameters:
withLangTag
- Iftrue
the language tag will be appended to the name (if any), else not.- Returns:
- The claim name, with optionally appended language tag.
-
withClaimRequirement
public ClaimsSetRequest.Entry withClaimRequirement(ClaimRequirement requirement)
Sets the claim requirement.- Parameters:
requirement
- The claim requirement. Must not benull
,- Returns:
- The updated entry.
-
getClaimRequirement
public ClaimRequirement getClaimRequirement()
Returns the claim requirement.- Returns:
- The claim requirement.
-
withLangTag
public ClaimsSetRequest.Entry withLangTag(com.nimbusds.langtag.LangTag langTag)
Sets the language tag for the claim.- Parameters:
langTag
- The language tag,null
if not specified.- Returns:
- The updated entry.
-
getLangTag
public com.nimbusds.langtag.LangTag getLangTag()
Returns the optional language tag for the claim.- Returns:
- The language tag,
null
if not specified.
-
withValue
public ClaimsSetRequest.Entry withValue(String value)
Sets the requested value for the claim.- Parameters:
value
- The value,null
if not specified.- Returns:
- The updated entry.
-
getValue
public String getValue()
Returns the requested value for the claim.- Returns:
- The value,
null
if not specified.
-
withValues
public ClaimsSetRequest.Entry withValues(List<String> values)
Sets the requested values for the claim.- Parameters:
values
- The values,null
if not specified.- Returns:
- The updated entry.
-
getValues
public List<String> getValues()
Returns the requested values for the claim.- Returns:
- The values,
null
if not specified.
-
withPurpose
public ClaimsSetRequest.Entry withPurpose(String purpose)
Sets the purpose for which the claim is requested.- Parameters:
purpose
- The purpose,null
if not specified.- Returns:
- The updated entry.
-
getPurpose
public String getPurpose()
Returns the optional purpose for which the claim is requested.- Returns:
- The purpose,
null
if not specified.
-
withAdditionalInformation
public ClaimsSetRequest.Entry withAdditionalInformation(Map<String,Object> additionalInformation)
Sets additional information for the requested claim.Example additional information in the "info" member:
{ "userinfo" : { "email": null, "email_verified": null, "http://example.info/claims/groups" : { "info" : "custom information" } } }
- Parameters:
additionalInformation
- The additional information,null
if not specified.- Returns:
- The updated entry.
-
getAdditionalInformation
public Map<String,Object> getAdditionalInformation()
Returns the additional information for the claim.Example additional information in the "info" member:
{ "userinfo" : { "email": null, "email_verified": null, "http://example.info/claims/groups" : { "info" : "custom information" } } }
- Returns:
- The additional information,
null
if not specified.
-
toJSONObjectEntry
public Map.Entry<String,net.minidev.json.JSONObject> toJSONObjectEntry()
Returns the JSON object entry for this individual claim request.- Returns:
- The JSON object entry.
-
parse
public static ClaimsSetRequest.Entry parse(Map.Entry<String,net.minidev.json.JSONObject> jsonObjectEntry) throws ParseException
Parses an individual claim request from the specified JSON object entry.- Parameters:
jsonObjectEntry
- The JSON object entry to parse. Must not benull
.- Returns:
- The individual claim request.
- Throws:
ParseException
- If parsing failed.
-
-