Package io.micronaut.security.token

Interface RolesFinder

All Known Implementing Classes:

DefaultRolesFinder

@DefaultImplementation(DefaultRolesFinder.class)
public interface RolesFinder

Retrieves roles from token claims.

Since:

1.1.0

Method Summary

Modifier and Type	Method	Description
default java.util.List<java.lang.String>	findInClaims(Claims claims)	Deprecated. use resolveRoles(Map) instead.
default boolean	hasAnyRequiredRoles(java.util.List<java.lang.String> requiredRoles, Authentication authentication)	Deprecated. Use hasAnyRequiredRoles(List, Map) instead.
default boolean	hasAnyRequiredRoles(java.util.List<java.lang.String> requiredRoles, Claims claims)	Deprecated. Use hasAnyRequiredRoles(List, Map) instead.
default boolean	hasAnyRequiredRoles(java.util.List<java.lang.String> requiredRoles, java.util.Collection<java.lang.String> grantedRoles)
default boolean	hasAnyRequiredRoles(java.util.List<java.lang.String> requiredRoles, java.util.Map<java.lang.String,java.lang.Object> attributes)
java.util.List<java.lang.String>	resolveRoles(java.util.Map<java.lang.String,java.lang.Object> attributes)	Retrieves the list of roles from the User Attributes.

Method Detail

findInClaims

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

Deprecated.

use resolveRoles(Map) instead.

Retrieves the list of roles from the provided claims.

Parameters:

claims - The claims of the token.

Returns:

The granted roles.

hasAnyRequiredRoles

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

Deprecated.

Use hasAnyRequiredRoles(List, Map) instead.

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

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

Deprecated.

Use hasAnyRequiredRoles(List, Map) instead.

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,
                                    @Nullable
                                    java.util.Map<java.lang.String,java.lang.Object> attributes)

Parameters:

requiredRoles - The list of roles required to be authorized

attributes - User's attributes

Returns:

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

hasAnyRequiredRoles

default boolean hasAnyRequiredRoles(@NonNull
                                    java.util.List<java.lang.String> requiredRoles,
                                    @NonNull
                                    java.util.Collection<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.

resolveRoles

@NonNull
java.util.List<java.lang.String> resolveRoles(@Nullable
                                              java.util.Map<java.lang.String,java.lang.Object> attributes)

Retrieves the list of roles from the User Attributes.

Parameters:

attributes - User's attributes

Returns:

The granted roles.