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

Class AnnotationAnalyzer.AnalyzerResponse

java.lang.Object

io.helidon.security.providers.common.spi.AnnotationAnalyzer.AnalyzerResponse

Enclosing interface:

AnnotationAnalyzer

public static final class AnnotationAnalyzer.AnalyzerResponse
extends Object

Response of an analysis run.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotationAnalyzer.AnalyzerResponse.Builder Fluent API builder for AnnotationAnalyzer.AnalyzerResponse.

Method Summary

Modifier and Type	Method and Description
static AnnotationAnalyzer.AnalyzerResponse	abstain() Create an abstain response (e.g.
static AnnotationAnalyzer.AnalyzerResponse	abstain(AnnotationAnalyzer.AnalyzerResponse previousResponse) Create an abstain response (e.g.
AnnotationAnalyzer.Flag	authenticationResponse() Authentication response of this analysis.
Optional<String>	authenticator() Explicit authentication provider name.
AnnotationAnalyzer.Flag	authorizationResponse() Authorization response of this analysis.
Optional<String>	authorizer() Explicit authorization provider name.
static AnnotationAnalyzer.AnalyzerResponse.Builder	builder() Create a fluent API builder.
static AnnotationAnalyzer.AnalyzerResponse.Builder	builder(AnnotationAnalyzer.AnalyzerResponse parent) Create a fluent API builder with a parent response.
Optional<AnnotationAnalyzer.AnalyzerResponse>	parent() Parent of this analysis.
ClassToInstanceStore<Object>	registry() A registry that allows transferring information between analysis of different scopes (application, resource class, method).

Methods inherited from class java.lang.Object

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

Method Detail

abstain

public static AnnotationAnalyzer.AnalyzerResponse abstain()

Create an abstain response (e.g. the analyzer has no information to provide a valid response, such as the annotation this analyzer supports is missing).

Returns:

an abstain response

abstain

public static AnnotationAnalyzer.AnalyzerResponse abstain(AnnotationAnalyzer.AnalyzerResponse previousResponse)

Create an abstain response (e.g. the analyzer has no information to provide a valid response, such as the annotation this analyzer supports is missing).

Parameters:

previousResponse - response from previous analysis (to allow parent/child structure, e.g. when some information is needed by further analysis)

Returns:

an abstain response

builder

public static AnnotationAnalyzer.AnalyzerResponse.Builder builder()

Create a fluent API builder.

Returns:

a builder

builder

public static AnnotationAnalyzer.AnalyzerResponse.Builder builder(AnnotationAnalyzer.AnalyzerResponse parent)

Create a fluent API builder with a parent response.

Parameters:

parent - response from previous run

Returns:

a builder

parent

public Optional<AnnotationAnalyzer.AnalyzerResponse> parent()

Parent of this analysis. For application class analysis, the parent is empty. For resource class analysis, the parent is application class analysis result. For resource method analysis, the parent is resource class analysis result.

Returns:

parent if exists, or empty

authenticationResponse

public AnnotationAnalyzer.Flag authenticationResponse()

Authentication response of this analysis.

Returns:

authentication response

authorizationResponse

public AnnotationAnalyzer.Flag authorizationResponse()

Authorization response of this analysis.

Returns:

authorization response

authenticator

public Optional<String> authenticator()

Explicit authentication provider name. If none provided, the default authenticator would be used.

Returns:

authenticator name or empty

authorizer

public Optional<String> authorizer()

Explicit authorization provider name. If none provided, the default authorizer would be used.

Returns:

authorization name or empty

registry

public ClassToInstanceStore<Object> registry()

A registry that allows transferring information between analysis of different scopes (application, resource class, method).

Returns:

registry to use