Package com.nimbusds.openid.connect.sdk

Class ClaimsRequest.Entry

  • Enclosing class:
    ClaimsRequest
    @Immutable
public static class ClaimsRequest.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.

      • Entry

        @Deprecated
public Entry​(String claimName,
             com.nimbusds.langtag.LangTag langTag)
        Deprecated.
        Creates a new individual claim request. The claim requirement is set to voluntary (the default) and no expected value(s) are specified.
        Parameters:
        claimName - The claim name. Must not be null.
        langTag - Optional language tag for the claim.

      • Entry

        @Deprecated
public Entry​(String claimName,
             ClaimRequirement requirement)
        Deprecated.
        Creates a new individual claim request.
        Parameters:
        claimName - The claim name. Must not be null.
        requirement - The claim requirement. Must not be null.

      • Entry

        @Deprecated
public Entry​(String claimName,
             ClaimRequirement requirement,
             com.nimbusds.langtag.LangTag langTag,
             String value)
        Deprecated.
        Creates a new individual claim request.
        Parameters:
        claimName - The claim name. Must not be null.
        requirement - The claim requirement. Must not be null.
        langTag - Optional language tag for the claim.
        value - Optional expected value for the claim.

      • Entry

        @Deprecated
public Entry​(String claimName,
             ClaimRequirement requirement,
             com.nimbusds.langtag.LangTag langTag,
             List<String> values)
        Deprecated.
        Creates a new individual claim request.
        Parameters:
        claimName - The claim name. Must not be null.
        requirement - The claim requirement. Must not be null.
        langTag - Optional language tag for the claim.
        values - Optional expected 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 - 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 ClaimsRequest.Entry withLangTag​(com.nimbusds.langtag.LangTag langTag)
        Returns a new claim entry with the specified language tag for the claim.
        Parameters:
        langTag - The language tag, null if not specified.
        Returns:
        The new 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 ClaimsRequest.Entry withValue​(String value)
        Returns a new claim entry with the specified requested value for the claim.
        Parameters:
        value - The value, null if not specified.
        Returns:
        The new entry.

      • getValue

        public String getValue()
        Returns the requested value for the claim.
        Returns:
        The value, null if not specified.

      • withValues

        public ClaimsRequest.Entry withValues​(List<String> values)
        Returns a new claim entry with the specified requested values for the claim.
        Parameters:
        values - The values, null if not specified.
        Returns:
        The new entry.

      • getValues

        public List<String> getValues()
        Returns the optional values for the claim.
        Returns:
        The values, null if not specified.

      • withPurpose

        public ClaimsRequest.Entry withPurpose​(String purpose)
        Returns a new claim entry with the specified purpose for the requested claim.
        Parameters:
        purpose - The purpose, null if not specified.
        Returns:
        The new entry.

      • getPurpose

        public String getPurpose()
        Returns the optional purpose for the requested claim.
        Returns:
        The purpose, null if not specified.

      • withAdditionalInformation

        public ClaimsRequest.Entry withAdditionalInformation​(Map<String,​Object> additionalInformation)
        Returns a new claim entry with the specified 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" } }
 }
        Parameters:
        additionalInformation - The additional information, null if not specified.
        Returns:
        The new 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.

      • toJSONObject

        public static net.minidev.json.JSONObject toJSONObject​(Collection<ClaimsRequest.Entry> entries)
        Returns the JSON object representation of the specified collection of individual claim requests.

        Example: 

         {
   "given_name": {"essential": true},
   "nickname": null,
   "email": {"essential": true},
   "email_verified": {"essential": true},
   "picture": null,
   "http://example.info/claims/groups": null
 }
        Parameters:
        entries - The entries to serialise. Must not be null.
        Returns:
        The corresponding JSON object, empty if no claims were found.

      • parseEntries

        public static Collection<ClaimsRequest.Entry> parseEntries​(net.minidev.json.JSONObject jsonObject)
        Parses a collection of individual claim requests from the specified JSON object. Request entries that are not understood are silently ignored.
        Parameters:
        jsonObject - The JSON object to parse. Must not be null.
        Returns:
        The collection of claim requests.