Package io.micronaut.security.oauth2.configuration

Class OauthClientConfigurationProperties

java.lang.Object

io.micronaut.security.oauth2.configuration.OauthClientConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, OauthClientConfiguration

@Context
@EachProperty("micronaut.security.oauth2.clients")
public class OauthClientConfigurationProperties
extends Object
implements OauthClientConfiguration

Stores configuration of each configured OAuth 2.0 client.

Since:

1.2.0

Author:

James Kleeh

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OauthClientConfigurationProperties.AuthorizationEndpointConfigurationProperties	OAuth 2.0 authorization endpoint configuration.
static class	OauthClientConfigurationProperties.ClientCredentialsConfigurationProperties	Client credentials configuration.
static class	OauthClientConfigurationProperties.IntrospectionEndpointConfigurationProperties	Introspection endpoint configuration.
static class	OauthClientConfigurationProperties.OpenIdClientConfigurationProperties	OpenID client configuration.
static class	OauthClientConfigurationProperties.RevocationEndpointConfigurationProperties	Revocation endpoint configuration.
static class	OauthClientConfigurationProperties.TokenEndpointConfigurationProperties	OAuth 2.0 token endpoint configuration.

Field Summary

Fields

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

Fields inherited from interface io.micronaut.security.oauth2.configuration.OauthClientConfiguration

DEFAULT_ADVANCED_EXPIRATION, DEFAULT_AUTH_METHOD, DEFAULT_AUTHENTICATION_METHOD

Constructor Summary

Constructors

Constructor	Description
OauthClientConfigurationProperties(String name)

Method Summary

Modifier and Type	Method	Description
Optional<OauthAuthorizationEndpointConfiguration>	getAuthorization()
@Nullable AuthorizationServer	getAuthorizationServer()
@NonNull Optional<ClientCredentialsConfiguration>	getClientCredentials()
@NonNull String	getClientId()
@Nullable String	getClientSecret()
@NonNull GrantType	getGrantType()
Optional<SecureEndpointConfiguration>	getIntrospection()
@NonNull String	getName()
Optional<OpenIdClientConfiguration>	getOpenid()
Optional<SecureEndpointConfiguration>	getRevocation()
@NonNull List<String>	getScopes()
Optional<SecureEndpointConfiguration>	getToken()
boolean	isEnabled()
boolean	isProxyWellKnownOauthAuthorizationServer()
boolean	isProxyWellKnownOpenidConfiguration()
void	setAuthorization(OauthClientConfigurationProperties.AuthorizationEndpointConfigurationProperties authorization)	The OAuth 2.0 authorization endpoint configuration.
void	setAuthorizationServer(@Nullable AuthorizationServer authorizationServer)	Micronaut attempts to infer the authorization server used by the client based on the issuer.
void	setClientCredentials(@NonNull OauthClientConfigurationProperties.ClientCredentialsConfigurationProperties clientCredentials)	Sets the Client Credentials configuration.
void	setClientId(@NonNull String clientId)	OAuth 2.0 client id.
void	setClientSecret(@Nullable String clientSecret)	OAuth 2.0 client secret.
void	setEnabled(boolean enabled)	Sets whether the client is enabled.
void	setGrantType(@NonNull GrantType grantType)	OAuth 2.0 grant type.
void	setIntrospection(OauthClientConfigurationProperties.IntrospectionEndpointConfigurationProperties introspection)	Sets the introspection endpoint configuration.
void	setOpenid(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties openid)	The open id configuration.
void	setProxyWellKnownOauthAuthorizationServer(boolean proxyWellKnownOauthAuthorizationServer)	Whether a request to /.well-known/oauth-authorization-server should be proxied to the authorization server.
void	setProxyWellKnownOpenidConfiguration(boolean proxyWellKnownOpenidConfiguration)	Whether a request to /.well-known/openid-configuration should be proxied to the authorization server.
void	setRevocation(OauthClientConfigurationProperties.RevocationEndpointConfigurationProperties revocation)	Sets the revocation endpoint configuration.
void	setScopes(List<String> scopes)	Requested scopes.
void	setToken(OauthClientConfigurationProperties.TokenEndpointConfigurationProperties token)	The OAuth 2.0 token endpoint configuration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.security.oauth2.configuration.OauthClientConfiguration

getTokenEndpoint

Field Details

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

• Constant Field Values

Constructor Details

OauthClientConfigurationProperties

public OauthClientConfigurationProperties(@Parameter
 String name)

Parameters:

name - The provider name

Method Details

isProxyWellKnownOauthAuthorizationServer

public boolean isProxyWellKnownOauthAuthorizationServer()

Specified by:

isProxyWellKnownOauthAuthorizationServer in interface OauthClientConfiguration

Returns:

Whether a request to /.well-known/oauth-authorization-server should be proxied to the authorization server.

setProxyWellKnownOauthAuthorizationServer

public void setProxyWellKnownOauthAuthorizationServer(boolean proxyWellKnownOauthAuthorizationServer)

Whether a request to /.well-known/oauth-authorization-server should be proxied to the authorization server. Default to false.

Parameters:

proxyWellKnownOauthAuthorizationServer - Whether a request to /.well-known/oauth-authorization-server should be proxied to the authorization server.

isProxyWellKnownOpenidConfiguration

public boolean isProxyWellKnownOpenidConfiguration()

Specified by:

isProxyWellKnownOpenidConfiguration in interface OauthClientConfiguration

Returns:

Whether a request to /.well-known/openid-configuration should be proxied to the authorization server.

setProxyWellKnownOpenidConfiguration

public void setProxyWellKnownOpenidConfiguration(boolean proxyWellKnownOpenidConfiguration)

Whether a request to /.well-known/openid-configuration should be proxied to the authorization server. Default to false.

Parameters:

proxyWellKnownOpenidConfiguration - Whether a request to /.well-known/openid-configuration should be proxied to the authorization server.

setAuthorizationServer

public void setAuthorizationServer(@Nullable
 @Nullable AuthorizationServer authorizationServer)

Micronaut attempts to infer the authorization server used by the client based on the issuer. However, if you are using a custom domain, it may be impossible to infer it. You can set it explicitly via this property.

Parameters:

authorizationServer - The authorization server

getAuthorizationServer

@Nullable
public @Nullable AuthorizationServer getAuthorizationServer()

Specified by:

getAuthorizationServer in interface OauthClientConfiguration

Returns:

The AuthorizationServer used by the OAuth Client.

getClientId

@NonNull
public @NonNull String getClientId()

Specified by:

getClientId in interface OauthClientConfiguration

Returns:

The client id

setClientId

public void setClientId(@NonNull
 @NonNull String clientId)

OAuth 2.0 client id.

Parameters:

clientId - The client id

getClientSecret

@Nullable
public @Nullable String getClientSecret()

Specified by:

getClientSecret in interface OauthClientConfiguration

Returns:

The client secret

setClientSecret

public void setClientSecret(@Nullable
 @Nullable String clientSecret)

OAuth 2.0 client secret.

Parameters:

clientSecret - The client secret

isEnabled

public boolean isEnabled()

Specified by:

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

setEnabled

public void setEnabled(boolean enabled)

Sets whether the client is enabled. Default value (true).

Parameters:

enabled - The enabled flag

getScopes

@NonNull
public @NonNull List<String> getScopes()

Specified by:

getScopes in interface OauthClientConfiguration

Returns:

The scopes requested

setScopes

public void setScopes(List<String> scopes)

Requested scopes. If not specified for OAuth 2.0 clients using OpenID Connect it defaults to `profile`, `email` and `idtoken`

Parameters:

scopes - The scopes

getName

@NonNull
public @NonNull String getName()

Specified by:

getName in interface OauthClientConfiguration

Returns:

The provider name

getGrantType

@NonNull
public @NonNull GrantType getGrantType()

Specified by:

getGrantType in interface OauthClientConfiguration

Returns:

The grant type

setGrantType

public void setGrantType(@NonNull
 @NonNull GrantType grantType)

OAuth 2.0 grant type. Default value (authorization_code).

Parameters:

grantType - The grant type

getToken

public Optional<SecureEndpointConfiguration> getToken()

Specified by:

getToken in interface OauthClientConfiguration

Returns:

The optional token endpoint configuration

See Also:

• RFC 6749 Section 4.1.3

setToken

public void setToken(OauthClientConfigurationProperties.TokenEndpointConfigurationProperties token)

The OAuth 2.0 token endpoint configuration.

Parameters:

token - The token endpoint configuration

getAuthorization

public Optional<OauthAuthorizationEndpointConfiguration> getAuthorization()

Specified by:

getAuthorization in interface OauthClientConfiguration

Returns:

The optional authorization endpoint configuration

See Also:

• RFC 6749 Section 3.1

getClientCredentials

@NonNull
public @NonNull Optional<ClientCredentialsConfiguration> getClientCredentials()

Specified by:

getClientCredentials in interface OauthClientConfiguration

Returns:

The Client Credentials Configuration

setClientCredentials

public void setClientCredentials(@NonNull
 @NonNull OauthClientConfigurationProperties.ClientCredentialsConfigurationProperties clientCredentials)

Sets the Client Credentials configuration.

Parameters:

clientCredentials - client credentials configuration

setAuthorization

public void setAuthorization(OauthClientConfigurationProperties.AuthorizationEndpointConfigurationProperties authorization)

The OAuth 2.0 authorization endpoint configuration.

Parameters:

authorization - The authorization endpoint configuration

getOpenid

public Optional<OpenIdClientConfiguration> getOpenid()

Specified by:

getOpenid in interface OauthClientConfiguration

Returns:

The open id configuration

setOpenid

public void setOpenid(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties openid)

The open id configuration.

Parameters:

openid - The open id configuration

getIntrospection

public Optional<SecureEndpointConfiguration> getIntrospection()

Specified by:

getIntrospection in interface OauthClientConfiguration

Returns:

The introspection endpoint configuration

See Also:

• RFC 7662

setIntrospection

public void setIntrospection(OauthClientConfigurationProperties.IntrospectionEndpointConfigurationProperties introspection)

Sets the introspection endpoint configuration.

Parameters:

introspection - The introspection endpoint configuration

getRevocation

public Optional<SecureEndpointConfiguration> getRevocation()

Specified by:

getRevocation in interface OauthClientConfiguration

Returns:

The revocation endpoint configuration

See Also:

• RFC 7009

setRevocation

public void setRevocation(OauthClientConfigurationProperties.RevocationEndpointConfigurationProperties revocation)

Sets the revocation endpoint configuration.

Parameters:

revocation - The revocation endpoint configuration