Package io.helidon.security

Interface SecurityRequest

public interface SecurityRequest

Common methods for all security requests (authentication, authorization, and identity propagation).

Method Summary

Modifier and Type	Method	Description
default boolean	isOptional()	If true and security provider does not find required information in request/response/message, or headers, it should return SecurityResponse.SecurityStatus.FAILURE without doing any side effects (e.g.
default Optional<Entity>	requestEntity()	Deprecated. Access to entity is to be removed from security
Map<String,Supplier<Object>>	resources()	Return a map of keys to resource instances.
default Optional<Entity>	responseEntity()	Deprecated. Access to entity is to be removed from security
Span	tracingSpan()	Deprecated. use tracingSpanContext() instead
Optional<SpanContext>	tracingSpanContext()	Parent span for tracing.

Method Detail

isOptional

default boolean isOptional()

If true and security provider does not find required information in request/response/message, or headers, it should return SecurityResponse.SecurityStatus.FAILURE without doing any side effects (e.g. should not redirect, call third parties etc.).

Returns:

true if security is optional

requestEntity

@Deprecated
default Optional<Entity> requestEntity()

Deprecated.

Access to entity is to be removed from security

Access request message entity.

Returns:

Entity of the request, if current request has entity

responseEntity

@Deprecated
default Optional<Entity> responseEntity()

Deprecated.

Access to entity is to be removed from security

Access response message entity.

Returns:

Entity of the response, if current response can have entity

tracingSpan

@Deprecated
Span tracingSpan()

Deprecated.

use tracingSpanContext() instead

Get the span to trace subsequent requests.

Returns:

Open tracing Span instance (started) of the parent of the current request, never null.

See Also:

GlobalTracer.get(), Tracer.buildSpan(String)

tracingSpanContext

Optional<SpanContext> tracingSpanContext()

Parent span for tracing. There may be no parent defined (such as when tracing is disabled).

Returns:

tracing span context if available

resources

Map<String,Supplier<Object>> resources()

Return a map of keys to resource instances. By default the mapping is under "object".

Returns:

a map of object keys to object instances