Module io.helidon.security

Package io.helidon.security.spi

Interface OutboundSecurityProvider

All Superinterfaces:

SecurityProvider

All Known Implementing Classes:

GoogleTokenProvider, HeaderAtnProvider, HttpBasicAuthProvider, HttpSignProvider, JwtAuthProvider, JwtProvider, OidcProvider

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface OutboundSecurityProvider
extends SecurityProvider

Security provider for securing client requests (outbound).

The most common use cases:

• Propagate current user's identity
• Call other service with correct service identity

See Also:

SecurityProvider.supportedCustomObjects(), SecurityProvider.supportedConfigKeys()

Method Summary

Modifier and Type	Method	Description
default boolean	isOutboundSupported(ProviderRequest providerRequest, SecurityEnvironment outboundEnv, EndpointConfig outboundConfig)	Check if the path to be executed is supported by this security provider.
CompletionStage<OutboundSecurityResponse>	outboundSecurity(ProviderRequest providerRequest, SecurityEnvironment outboundEnv, EndpointConfig outboundConfig)	Creates necessary updates to headers and entity needed for outbound security (e.g.

Methods inherited from interface io.helidon.security.spi.SecurityProvider

supportedAnnotations, supportedAttributes, supportedConfigKeys, supportedCustomObjects

Method Detail

isOutboundSupported

default boolean isOutboundSupported(ProviderRequest providerRequest,
                                    SecurityEnvironment outboundEnv,
                                    EndpointConfig outboundConfig)

Check if the path to be executed is supported by this security provider. Defaults to true.

Parameters:

providerRequest - context with environment, subject(s) etc. that was received

outboundEnv - environment for outbound call

outboundConfig - outbound endpoint configuration

Returns:

true if this identity propagator can generate required headers for the path defined

outboundSecurity

CompletionStage<OutboundSecurityResponse> outboundSecurity(ProviderRequest providerRequest,
                                                           SecurityEnvironment outboundEnv,
                                                           EndpointConfig outboundConfig)

Creates necessary updates to headers and entity needed for outbound security (e.g. identity propagation, s2s security etc.). This method will be invoked for outbound requests ONLY.

Parameters:

providerRequest - context with environment, subject(s) etc. that was received

outboundEnv - environment for outbound call

outboundConfig - outbound endpoint configuration

Returns:

response with generated headers and other possible configuration

See Also:

OutboundSecurityResponse.builder()