ClientCredentialsConfiguration (security-parent 5.1.0-SNAPSHOT API)

All Superinterfaces:: io.micronaut.http.util.OutgoingRequestProcessorMatcher, io.micronaut.core.util.Toggleable

All Known Implementing Classes:: OauthClientConfigurationProperties.ClientCredentialsConfigurationProperties

public interface ClientCredentialsConfiguration extends io.micronaut.core.util.Toggleable, io.micronaut.http.util.OutgoingRequestProcessorMatcher

Client credentials configuration.

Since:: 2.2.0
Author:: Sergio del Amo

Method Summary

Modifier and Type

Method

Description

static @NonNull ClientCredentialsConfigurationBuilder

builder()

@NonNull Map<String,String>

getAdditionalRequestParams()

@NonNull Duration

getAdvancedExpiration()

@NonNull Optional<ClientCredentialsHeaderTokenPropagatorConfiguration>

getHeaderPropagation()

@NonNull Optional<String>

getScope()

Methods inherited from interface io.micronaut.http.util.OutgoingRequestProcessorMatcher
getServiceIdPattern, getUriPattern

Methods inherited from interface io.micronaut.core.util.Toggleable
isEnabled

Method Details
- getScope
  
  @NonNull Optional<String> getScope()
  
  Returns:
  
  Scope to be requested in the client credentials request.
- getAdvancedExpiration
  
  @NonNull Duration getAdvancedExpiration()
  
  Returns:
  
  The amount of time for a token obtained via client credentials grant to be considered expired prior to its expiration date.
- getHeaderPropagation
  
  @NonNull Optional<ClientCredentialsHeaderTokenPropagatorConfiguration> getHeaderPropagation()
- getAdditionalRequestParams
  
  @NonNull Map<String,String> getAdditionalRequestParams()
- builder
  
  static @NonNull ClientCredentialsConfigurationBuilder builder()
  
  Returns:
  
  A new client credentials configuration builder.
  
  Since:
  
  5.1.0