io.micronaut.security.oauth2.configuration

Class OauthClientConfigurationProperties.ClientCredentialsConfigurationProperties

java.lang.Object

io.micronaut.security.oauth2.configuration.OauthClientConfigurationProperties.ClientCredentialsConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, io.micronaut.http.util.OutgointRequestProcessorMatcher, ClientCredentialsConfiguration

Enclosing class:

OauthClientConfigurationProperties

@ConfigurationProperties(value="client-credentials")
public static class OauthClientConfigurationProperties.ClientCredentialsConfigurationProperties
extends java.lang.Object
implements ClientCredentialsConfiguration

Client credentials configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OauthClientConfigurationProperties.ClientCredentialsConfigurationProperties.HeaderTokenPropagatorConfigurationProperties Client credentials http header token propagation configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED The default enable value.

Constructor Summary

Constructors

Constructor and Description
ClientCredentialsConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
java.time.Duration	getAdvancedExpiration()
java.util.Optional<ClientCredentialsHeaderTokenPropagatorConfiguration>	getHeaderPropagation()
java.util.Optional<java.lang.String>	getScope()
java.util.regex.Pattern	getServiceIdPattern()
java.lang.String	getServiceIdRegex()
java.util.regex.Pattern	getUriPattern()
java.lang.String	getUriRegex()
boolean	isEnabled()
void	setAdvancedExpiration(java.time.Duration advancedExpiration)
void	setEnabled(boolean enabled) Enables ClientCredentialsClient.
void	setHeaderPropagation(OauthClientConfigurationProperties.ClientCredentialsConfigurationProperties.HeaderTokenPropagatorConfigurationProperties headerPropagation) Sets the Http Header Client Credentials Token Propagator configuration.
void	setScope(java.lang.String scope) Scope to be requested in the client credentials request.
void	setServiceIdRegex(java.lang.String serviceIdRegex)
void	setUriRegex(java.lang.String uriRegex)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

Constant Field Values

Constructor Detail

ClientCredentialsConfigurationProperties

public ClientCredentialsConfigurationProperties()

Method Detail

getAdvancedExpiration

@NonNull
public java.time.Duration getAdvancedExpiration()

Specified by:

getAdvancedExpiration in interface ClientCredentialsConfiguration

Returns:

The amount of time for a token obtained via client credentials grant to be considered expired prior to its expiration date.

getHeaderPropagation

@NonNull
public java.util.Optional<ClientCredentialsHeaderTokenPropagatorConfiguration> getHeaderPropagation()

Specified by:

getHeaderPropagation in interface ClientCredentialsConfiguration

setHeaderPropagation

public void setHeaderPropagation(@NonNull
                                 OauthClientConfigurationProperties.ClientCredentialsConfigurationProperties.HeaderTokenPropagatorConfigurationProperties headerPropagation)

Sets the Http Header Client Credentials Token Propagator configuration.

Parameters:

headerPropagation - client credentials header propagation.

setAdvancedExpiration

public void setAdvancedExpiration(@NonNull
                                  java.time.Duration advancedExpiration)

Parameters:

advancedExpiration - Number of seconds for a token obtained via client credentials grant to be considered expired prior to its expiration date. Default value (30 seconds).

getServiceIdRegex

public java.lang.String getServiceIdRegex()

Returns:

a regular expression to match the service.

setServiceIdRegex

public void setServiceIdRegex(java.lang.String serviceIdRegex)

Parameters:

serviceIdRegex - A regular expression to match the service id.

getUriRegex

public java.lang.String getUriRegex()

Returns:

a regular expression to match the uri.

setUriRegex

public void setUriRegex(java.lang.String uriRegex)

Parameters:

uriRegex - A regular expression to match the URI.

getServiceIdPattern

public java.util.regex.Pattern getServiceIdPattern()

Specified by:

getServiceIdPattern in interface io.micronaut.http.util.OutgointRequestProcessorMatcher

getUriPattern

public java.util.regex.Pattern getUriPattern()

Specified by:

getUriPattern in interface io.micronaut.http.util.OutgointRequestProcessorMatcher

getScope

@NonNull
public java.util.Optional<java.lang.String> getScope()

Specified by:

getScope in interface ClientCredentialsConfiguration

Returns:

Scope to be requested in the client credentials request.

setScope

public void setScope(java.lang.String scope)

Scope to be requested in the client credentials request. Defaults to none.

Parameters:

scope - Scope to be requested in the client credentials request

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface io.micronaut.core.util.Toggleable

setEnabled

public void setEnabled(boolean enabled)

Enables ClientCredentialsClient. Default value true

Parameters:

enabled - enabled flag