Package com.nimbusds.openid.connect.sdk.claims

Class 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.

    • Constructor Detail

      • Entry

        public Entry​(String claimName)
        Creates a new individual claim request. The claim requirement is set to voluntary (the default) and no expected value(s) or other parameters are specified.
        Parameters:
        claimName - The claim name. Must not be null.

    • 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 - If true the language tag will be appended to the name (if any), else not.
        Returns:
        The claim name, with optionally appended language tag.

      • 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.

      • 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 be null.
        Returns:
        The individual claim request.
        Throws:
        ParseException - If parsing failed.