Class SecuredAnnotationRule

java.lang.Object

io.micronaut.security.rules.AbstractSecurityRule<io.micronaut.http.HttpRequest<?>>

io.micronaut.security.rules.SecuredAnnotationRule

All Implemented Interfaces:

io.micronaut.core.order.Ordered, SecurityRule<io.micronaut.http.HttpRequest<?>>

@Requires(classes=io.micronaut.http.HttpRequest.class)
@Singleton
public class SecuredAnnotationRule
extends AbstractSecurityRule<io.micronaut.http.HttpRequest<?>>

Security rule implementation for the Secured annotation.

Since:

1.0

Author:

James Kleeh

Field Summary

Fields

Modifier and Type	Field	Description
static final Integer	ORDER	The order of the rule.

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Fields inherited from interface SecurityRule

DENY_ALL, IS_ANONYMOUS, IS_AUTHENTICATED

Constructor Summary

Constructors

Constructor	Description
SecuredAnnotationRule(RolesFinder rolesFinder)

Method Summary

Modifier and Type	Method	Description
org.reactivestreams.Publisher<SecurityRuleResult>	check(io.micronaut.http.HttpRequest<?> request, @Nullable Authentication authentication)	Returns SecurityRuleResult.UNKNOWN if the Secured annotation is not found on the method or class, or if the route match is not method based.
int	getOrder()

Methods inherited from class AbstractSecurityRule

compareRoles, getRoles

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ORDER

public static final Integer ORDER

The order of the rule.

Constructor Details

SecuredAnnotationRule

public SecuredAnnotationRule(RolesFinder rolesFinder)

Parameters:

rolesFinder - Roles Parser

Method Details

check

public org.reactivestreams.Publisher<SecurityRuleResult> check(io.micronaut.http.HttpRequest<?> request,
 @Nullable Authentication authentication)

Returns SecurityRuleResult.UNKNOWN if the Secured annotation is not found on the method or class, or if the route match is not method based.

If the Secured value is an expression, the request is allowed only when the expression evaluates to true. An expression that evaluates to null, for example one that navigates the user with user?. for an anonymous request, rejects the request instead of deferring to later rules.

Parameters:

request - The current request

authentication - The authentication, or null if none found

Returns:

The result

See Also:

• SecurityRuleResult

getOrder

public int getOrder()