Module jakarta.security
Package jakarta.security.enterprise.identitystore.openid

Interface Claims

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> getArrayStringClaim​(java.lang.String name)
      Get String List claim of given name
      java.util.OptionalDouble getDoubleClaim​(java.lang.String name)
      Get double claim of given name
      java.util.OptionalInt getIntClaim​(java.lang.String name)
      Get integer claim of given name
      java.util.OptionalLong getLongClaim​(java.lang.String name)
      Get long claim of given name
      java.util.Optional<Claims> getNested​(java.lang.String name)
      Get nested claims of given name.
      java.util.Optional<java.time.Instant> getNumericDateClaim​(java.lang.String name)
      Get Numeric Date claim of given name
      java.util.Optional<java.lang.String> getStringClaim​(java.lang.String name)
      Get String claim of given name

    • Method Detail

      • getStringClaim

        java.util.Optional<java.lang.String> getStringClaim​(java.lang.String name)
        Get String claim of given name
        Parameters:
        name -
        Returns:
        value, or empty optional if not present
        Throws:
        java.lang.IllegalArgumentException - when value of claim is not a string

      • getNumericDateClaim

        java.util.Optional<java.time.Instant> getNumericDateClaim​(java.lang.String name)
        Get Numeric Date claim of given name
        Parameters:
        name -
        Returns:
        value, or empty optional if not present
        Throws:
        java.lang.IllegalArgumentException - when value of claim is not a number that represents an epoch seconds

      • getArrayStringClaim

        java.util.List<java.lang.String> getArrayStringClaim​(java.lang.String name)
        Get String List claim of given name
        Parameters:
        name -
        Returns:
        a list with values of the claim, or empty list if value is not present.
        Throws:
        java.lang.IllegalArgumentException - when value of claim is neither string or array of strings

      • getIntClaim

        java.util.OptionalInt getIntClaim​(java.lang.String name)
        Get integer claim of given name
        Parameters:
        name -
        Returns:
        value, or empty optional if not present
        Throws:
        java.lang.IllegalArgumentException - when value of claim is not a number

      • getLongClaim

        java.util.OptionalLong getLongClaim​(java.lang.String name)
        Get long claim of given name
        Parameters:
        name -
        Returns:
        value, or empty optional if not present
        Throws:
        java.lang.IllegalArgumentException - when value of claim is not a number

      • getDoubleClaim

        java.util.OptionalDouble getDoubleClaim​(java.lang.String name)
        Get double claim of given name
        Parameters:
        name -
        Returns:
        value, or empty optional if not present
        Throws:
        java.lang.IllegalArgumentException - when value of claim is not a number

      • getNested

        java.util.Optional<Claims> getNested​(java.lang.String name)
        Get nested claims of given name.
        Parameters:
        name -
        Returns:
        Claims instance represented nested values within that claim, or empty optional if not present
        Throws:
        java.lang.IllegalArgumentException - when value is not a nested object