Interface JwtAdditionalClaim.Builder

  • Method Details

    • claimName

      JwtAdditionalClaim.Builder claimName(String claimName)

      The name of the claim to check. The value cannot be empty and cannot be iss, aud, exp, nbf, iat, scope, or scp.

      Parameters:
      claimName - The name of the claim to check. The value cannot be empty and cannot be iss, aud, exp, nbf, iat, scope, or scp.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • format

      The format of the claim value. The only valid value is SINGLE_STRING.

      Parameters:
      format - The format of the claim value. The only valid value is SINGLE_STRING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • format

      The format of the claim value. The only valid value is SINGLE_STRING.

      Parameters:
      format - The format of the claim value. The only valid value is SINGLE_STRING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • required

      JwtAdditionalClaim.Builder required(Boolean required)

      Specifies whether the claim must be present in the token. Defaults to false. When true, the token must contain the claim.

      Parameters:
      required - Specifies whether the claim must be present in the token. Defaults to false. When true, the token must contain the claim.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • expectedValues

      JwtAdditionalClaim.Builder expectedValues(Collection<String> expectedValues)

      The accepted value for the claim. The value cannot be empty. When a value is specified, the claim must match it exactly, and the match is case-sensitive. When no value is specified, the claim only has to be present.

      Parameters:
      expectedValues - The accepted value for the claim. The value cannot be empty. When a value is specified, the claim must match it exactly, and the match is case-sensitive. When no value is specified, the claim only has to be present.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • expectedValues

      JwtAdditionalClaim.Builder expectedValues(String... expectedValues)

      The accepted value for the claim. The value cannot be empty. When a value is specified, the claim must match it exactly, and the match is case-sensitive. When no value is specified, the claim only has to be present.

      Parameters:
      expectedValues - The accepted value for the claim. The value cannot be empty. When a value is specified, the claim must match it exactly, and the match is case-sensitive. When no value is specified, the claim only has to be present.
      Returns:
      Returns a reference to this object so that method calls can be chained together.