EE4J 10.0.0 · jakarta.security.enterprise.identitystore.openid.Claims

Method Summary

Modifier and Type	Method and Description
public List<String>	Returns: a list with values of the claim, or empty list if value is not present. getArrayStringClaim(String name) Get String List claim of given name
public OptionalDouble	Returns: value, or empty optional if not present getDoubleClaim(String name) Get double claim of given name
public OptionalInt	Returns: value, or empty optional if not present getIntClaim(String name) Get integer claim of given name
public OptionalLong	Returns: value, or empty optional if not present getLongClaim(String name) Get long claim of given name
public Optional<Claims>	Returns: Claims instance represented nested values within that claim, or empty optional if not present getNested(String name) Get nested claims of given name.
public Optional<Instant>	Returns: value, or empty optional if not present getNumericDateClaim(String name) Get Numeric Date claim of given name
public Optional<String>	Returns: value, or empty optional if not present getStringClaim(String name) Get String claim of given name

Method Detail

getArrayStringClaim	back to summary
public List<String> getArrayStringClaim(String name) Get String List claim of given name Returns:List<String> a list with values of the claim, or empty list if value is not present. Exceptions IllegalArgumentException: when value of claim is neither string or array of strings

getArrayStringClaim

back to summary

public List<String> getArrayStringClaim(String name)

Get String List claim of given name

Returns:List<String>

a list with values of the claim, or empty list if value is not present.

Exceptions

IllegalArgumentException:: when value of claim is neither string or array of strings

getDoubleClaim	back to summary
public OptionalDouble getDoubleClaim(String name) Get double claim of given name Returns:OptionalDouble value, or empty optional if not present Exceptions IllegalArgumentException: when value of claim is not a number

getDoubleClaim

back to summary

public OptionalDouble getDoubleClaim(String name)

Get double claim of given name

Returns:OptionalDouble

value, or empty optional if not present

Exceptions

IllegalArgumentException:: when value of claim is not a number

getIntClaim	back to summary
public OptionalInt getIntClaim(String name) Get integer claim of given name Returns:OptionalInt value, or empty optional if not present Exceptions IllegalArgumentException: when value of claim is not a number

getIntClaim

back to summary

public OptionalInt getIntClaim(String name)

Get integer claim of given name

Returns:OptionalInt

value, or empty optional if not present

Exceptions

IllegalArgumentException:: when value of claim is not a number

getLongClaim	back to summary
public OptionalLong getLongClaim(String name) Get long claim of given name Returns:OptionalLong value, or empty optional if not present Exceptions IllegalArgumentException: when value of claim is not a number

getLongClaim

back to summary

public OptionalLong getLongClaim(String name)

Get long claim of given name

Returns:OptionalLong

value, or empty optional if not present

Exceptions

IllegalArgumentException:: when value of claim is not a number

getNested	back to summary
public Optional<Claims> getNested(String name) Get nested claims of given name. Returns:Optional<Claims> Claims instance represented nested values within that claim, or empty optional if not present Exceptions IllegalArgumentException: when value is not a nested object

getNested

back to summary

public Optional<Claims> getNested(String name)

Get nested claims of given name.

Returns:Optional<Claims>

Claims instance represented nested values within that claim, or empty optional if not present

Exceptions

IllegalArgumentException:: when value is not a nested object

getNumericDateClaim	back to summary
public Optional<Instant> getNumericDateClaim(String name) Get Numeric Date claim of given name Returns:Optional<Instant> value, or empty optional if not present Exceptions IllegalArgumentException: when value of claim is not a number that represents an epoch seconds

getNumericDateClaim

back to summary

public Optional<Instant> getNumericDateClaim(String name)

Get Numeric Date claim of given name

Returns:Optional<Instant>

value, or empty optional if not present

Exceptions

IllegalArgumentException:: when value of claim is not a number that represents an epoch seconds

getStringClaim	back to summary
public Optional<String> getStringClaim(String name) Get String claim of given name Returns:Optional<String> value, or empty optional if not present Exceptions IllegalArgumentException: when value of claim is not a string

getStringClaim

back to summary

public Optional<String> getStringClaim(String name)

Get String claim of given name

Returns:Optional<String>

value, or empty optional if not present

Exceptions

IllegalArgumentException:: when value of claim is not a string

public Interface Claims

Method Summary

Method Detail