Module io.helidon.security.providers.common

Package io.helidon.security.providers.common.spi

Interface AnnotationAnalyzer

All Known Implementing Classes:

JwtAuthAnnotationAnalyzer, RoleAnnotationAnalyzer

public interface AnnotationAnalyzer

Provides capability to extensions to enforce authentication and authorization even when the resource is not annotated with io.helidon.security.annotations.Authenticated or io.helidon.security.annotations.Authorized. This is loaded using a ServiceLoader - integration with Security is done automatically as long as the implementation is discovered as a java service.

Note: This type is no longer a FunctionalInterface, as we need to support both SE and MP types. We are refactoring our approach so we do not use reflection.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AnnotationAnalyzer.AnalyzerResponse	Response of an analysis run.
static enum	AnnotationAnalyzer.Flag	Flag for security type.

Method Summary

Modifier and Type	Method	Description
default AnnotationAnalyzer.AnalyzerResponse	analyze(TypeName typeName, TypedElementInfo method, AnnotationAnalyzer.AnalyzerResponse previousResponse)	Analyze a resource method.
default AnnotationAnalyzer.AnalyzerResponse	analyze(TypeName applicationType, List<Annotation> annotations)	Analyze application annotations.
default AnnotationAnalyzer.AnalyzerResponse	analyze(TypeName endpointType, List<Annotation> annotations, AnnotationAnalyzer.AnalyzerResponse previousResponse)	Analyze an endpoint class.
AnnotationAnalyzer.AnalyzerResponse	analyze(Class<?> maybeAnnotated)	Deprecated. this method will be made default in a future version, and marked for removal; it will be removed in two major versions from now (most likely version 6).
default AnnotationAnalyzer.AnalyzerResponse	analyze(Class<?> maybeAnnotated, AnnotationAnalyzer.AnalyzerResponse previousResponse)	Deprecated, for removal: This API element is subject to removal in a future version. going away from reflection, use analyze(io.helidon.common.types.TypeName, java.util.List, io.helidon.security.providers.common.spi.AnnotationAnalyzer.AnalyzerResponse) instead
default AnnotationAnalyzer.AnalyzerResponse	analyze(Method maybeAnnotated, AnnotationAnalyzer.AnalyzerResponse previousResponse)	Deprecated, for removal: This API element is subject to removal in a future version. going away from reflection, use analyze(io.helidon.common.types.TypeName, io.helidon.common.types.TypedElementInfo, io.helidon.security.providers.common.spi.AnnotationAnalyzer.AnalyzerResponse) instead
default void	init(Config config)	Deprecated, for removal: This API element is subject to removal in a future version. use init(io.helidon.config.Config) instead
default void	init(Config config)	Provides configuration on node "security.jersey.analyzers".

Method Details

init

@Deprecated(since="4.4.0",
            forRemoval=true)
default void init(Config config)

Deprecated, for removal: This API element is subject to removal in a future version.

use init(io.helidon.config.Config) instead

Provides configuration on node "security.jersey.analyzers".

Parameters:

config - config to use to configure an analyzer, may be empty (e.g. have reasonable defaults if possible)

init

default void init(Config config)

Provides configuration on node "security.jersey.analyzers".

API Note: the default method implementation is provided for backward compatibility and will be removed in the next major version

Parameters:

config - config to use to configure an analyzer, may be empty (e.g. have reasonable defaults if possible)

Since:

4.4.0

analyze

@Deprecated(since="4.2.0")
AnnotationAnalyzer.AnalyzerResponse analyze(Class<?> maybeAnnotated)

Deprecated.

this method will be made default in a future version, and marked for removal; it will be removed in two major versions from now (most likely version 6). Use analyze(io.helidon.common.types.TypeName, java.util.List) instead.

Analyze an application class.

Parameters:

maybeAnnotated - class of the JAX-RS application

Returns:

response with information whether to (and how) authenticate and authorize

analyze

default AnnotationAnalyzer.AnalyzerResponse analyze(TypeName applicationType,
 List<Annotation> annotations)

Analyze application annotations.

Parameters:

applicationType - type to analyze

annotations - annotations on the type

Returns:

response on how to authenticate and authorize

analyze

@Deprecated(forRemoval=true,
            since="4.2.0")
default AnnotationAnalyzer.AnalyzerResponse analyze(Class<?> maybeAnnotated,
 AnnotationAnalyzer.AnalyzerResponse previousResponse)

Deprecated, for removal: This API element is subject to removal in a future version.

going away from reflection, use analyze(io.helidon.common.types.TypeName, java.util.List, io.helidon.security.providers.common.spi.AnnotationAnalyzer.AnalyzerResponse) instead

Analyze a resource class. By default returns an abstain response.

Parameters:

maybeAnnotated - class of the JAX-RS resource

previousResponse - response from parent of this class (e.g. from application analysis)

Returns:

response with information whether to (and how) authenticate and authorize

analyze

default AnnotationAnalyzer.AnalyzerResponse analyze(TypeName endpointType,
 List<Annotation> annotations,
 AnnotationAnalyzer.AnalyzerResponse previousResponse)

Analyze an endpoint class.

Parameters:

endpointType - type of the endpoint (such as JAX-RS resource)

annotations - annotations on the type

previousResponse - response from parent of this class (e.g. from application analysis)

Returns:

response with information whether to (and how) authenticate and authorize

analyze

@Deprecated(forRemoval=true,
            since="4.2.0")
default AnnotationAnalyzer.AnalyzerResponse analyze(Method maybeAnnotated,
 AnnotationAnalyzer.AnalyzerResponse previousResponse)

Deprecated, for removal: This API element is subject to removal in a future version.

going away from reflection, use analyze(io.helidon.common.types.TypeName, io.helidon.common.types.TypedElementInfo, io.helidon.security.providers.common.spi.AnnotationAnalyzer.AnalyzerResponse) instead

Analyze a resource method. By default returns an abstain response.

Parameters:

maybeAnnotated - JAX-RS resource method

previousResponse - response from parent of this class (e.g. from resource class analysis)

Returns:

response with information whether to (and how) authenticate and authorize

analyze

default AnnotationAnalyzer.AnalyzerResponse analyze(TypeName typeName,
 TypedElementInfo method,
 AnnotationAnalyzer.AnalyzerResponse previousResponse)

Analyze a resource method. By default returns an abstain response.

Parameters:

typeName - type that contains the method

method - endpoint method (such as JAX-RS method)

previousResponse - response from parent of this class (e.g. from resource class analysis)

Returns:

response with information whether to (and how) authenticate and authorize