com.holonplatform.auth.jwt

## Interface AuthenticationClaims

- All Known Implementing Classes:
    AuthenticationClaimsImpl

      public interface AuthenticationClaims

  `Authentication` JWT claims.
  Since:
    5.0.0

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `CLAIM_NAME_PERMISSIONS` Claim name for `Authentication.getPermissions()`.
    `static String` | `CLAIM_NAME_ROOT` Claim name for `Authentication.isRoot()` attribute.

  - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `<T> T` | `get(String claimName, Class<T> requiredType)` Get a claim value by name, if exists

- - ### Field Detail

    - #### CLAIM_NAME_ROOT

          static final String CLAIM_NAME_ROOT

      Claim name for `Authentication.isRoot()` attribute. Claim value will be a boolean.
      See Also:
        Constant Field Values

    - #### CLAIM_NAME_PERMISSIONS

          static final String CLAIM_NAME_PERMISSIONS

      Claim name for `Authentication.getPermissions()`. Claim value will be a String array.
      See Also:
        Constant Field Values

  - ### Method Detail

    - #### get

          <T> T get(String claimName,
                    Class<T> requiredType)

      Get a claim value by name, if exists
      Type Parameters:
        `T` - Claim value type
      Parameters:
        `claimName` - Claim name
        `requiredType` - Expected claim value type
      Returns:
        Claim value, or `null` if claim was not found or has no value

Copyright © 2019 The Holon Platform. All rights reserved.