Class JSentinelAnnotationScanner

java.lang.Object

com.svenruppert.jsentinel.authorization.impl.JSentinelAnnotationScanner

public final class JSentinelAnnotationScanner
extends Object

Scans annotated elements for JSentinelAnnotation-meta-annotated restriction annotations and resolves the corresponding evaluator class.

Results are cached per class. This class is Vaadin-free and can be unit-tested independently.

Constructor Summary

Constructors

Constructor	Description
JSentinelAnnotationScanner()	Creates a new scanner with an empty cache.

Method Summary

Modifier and Type	Method	Description
Optional<AnnotationAccessEvaluatorPair<Annotation>>	scan(Class<?> navigationTarget)	Scans the given class for a restriction annotation and returns the annotation together with the evaluator class declared via JSentinelAnnotation.
Optional<AnnotationAccessEvaluatorPair<Annotation>>	scan(AnnotatedElement element)	Scans the given annotated element for a restriction annotation and returns the annotation together with the evaluator class declared via JSentinelAnnotation.
Optional<AnnotationAccessEvaluatorPair<Annotation>>	scan(Method method)	Scans the given method for a restriction annotation and returns the annotation together with the evaluator class declared via JSentinelAnnotation.

Methods inherited from class Object

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

Constructor Details

JSentinelAnnotationScanner

public JSentinelAnnotationScanner()

Creates a new scanner with an empty cache.

Method Details

scan

public Optional<AnnotationAccessEvaluatorPair<Annotation>> scan(Class<?> navigationTarget)

Scans the given class for a restriction annotation and returns the annotation together with the evaluator class declared via JSentinelAnnotation.

Parameters:

navigationTarget - the class to scan

Returns:

the pair, or empty if no restriction annotation is present

Throws:

IllegalStateException - if more than one restriction annotation is found

scan

public Optional<AnnotationAccessEvaluatorPair<Annotation>> scan(Method method)

Scans the given method for a restriction annotation and returns the annotation together with the evaluator class declared via JSentinelAnnotation.

Parameters:

method - the method to scan

Returns:

the pair, or empty if no restriction annotation is present

Throws:

IllegalStateException - if more than one restriction annotation is found

scan

public Optional<AnnotationAccessEvaluatorPair<Annotation>> scan(AnnotatedElement element)

Scans the given annotated element for a restriction annotation and returns the annotation together with the evaluator class declared via JSentinelAnnotation.

Parameters:

element - the annotated element to scan

Returns:

the pair, or empty if no restriction annotation is present

Throws:

IllegalStateException - if more than one restriction annotation is found