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 java.util.Optional<Entity>	getRequestEntity()	Access request message entity.
java.util.Map<java.lang.String,java.util.function.Supplier<java.lang.Object>>	getResources()	Return a map of keys to resource instances.
default java.util.Optional<Entity>	getResponseEntity()	Access response message entity.
io.opentracing.Span	getTracingSpan()	Get the span to trace subsequent requests.
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.

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

getRequestEntity

default java.util.Optional<Entity> getRequestEntity()

Access request message entity.

Returns:

Entity of the request, if current request has entity

getResponseEntity

default java.util.Optional<Entity> getResponseEntity()

Access response message entity.

Returns:

Entity of the response, if current response can have entity

getTracingSpan

io.opentracing.Span getTracingSpan()

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)

getResources

java.util.Map<java.lang.String,java.util.function.Supplier<java.lang.Object>> getResources()

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

Returns:

a map of object keys to object instances