io.micronaut.security.token

Interface RolesFinder

All Known Implementing Classes:

DefaultRolesFinder

@DefaultImplementation(value=DefaultRolesFinder.class)
public interface RolesFinder

Retrieves roles from token claims.

Since:

1.1.0

Author:

Sergio del Amo

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	findInClaims(Claims claims) Retrieves the list of roles from the provided claims.
default boolean	hasAnyRequiredRoles(java.util.List<java.lang.String> requiredRoles, Authentication authentication)
default boolean	hasAnyRequiredRoles(java.util.List<java.lang.String> requiredRoles, Claims claims)
default boolean	hasAnyRequiredRoles(java.util.List<java.lang.String> requiredRoles, java.util.List<java.lang.String> grantedRoles)

Method Detail

findInClaims

@NonNull
java.util.List<java.lang.String> findInClaims(@NonNull
                                                       Claims claims)

Retrieves the list of roles from the provided claims.

Parameters:

claims - The claims of the token.

Returns:

The granted roles.

hasAnyRequiredRoles

default boolean hasAnyRequiredRoles(@NonNull
                                    java.util.List<java.lang.String> requiredRoles,
                                    @NonNull
                                    Authentication authentication)

Parameters:

requiredRoles - The list of roles required to be authorized

authentication - The authentication

Returns:

true if any of the Authentication's roles is in the required roles list.

hasAnyRequiredRoles

default boolean hasAnyRequiredRoles(@NonNull
                                    java.util.List<java.lang.String> requiredRoles,
                                    @NonNull
                                    Claims claims)

Parameters:

requiredRoles - The list of roles required to be authorized

claims - The claims of the token.

Returns:

true if any the roles specified in the claims is in the required roles list.

hasAnyRequiredRoles

default boolean hasAnyRequiredRoles(@NonNull
                                    java.util.List<java.lang.String> requiredRoles,
                                    @NonNull
                                    java.util.List<java.lang.String> grantedRoles)

Parameters:

requiredRoles - The list of roles required to be authorized

grantedRoles - The list of roles granted to the user

Returns:

true if any of the granted roles is in the required roles list.