Package io.micronaut.security.oauth2.configuration

Class OauthClientConfigurationProperties.OpenIdClientConfigurationProperties

java.lang.Object

io.micronaut.security.oauth2.configuration.OauthClientConfigurationProperties.OpenIdClientConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.naming.Named, OpenIdClientConfiguration

Enclosing class:

OauthClientConfigurationProperties

@ConfigurationProperties("openid")
public static class OauthClientConfigurationProperties.OpenIdClientConfigurationProperties
extends Object
implements OpenIdClientConfiguration

OpenID client configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.AuthorizationEndpointConfigurationProperties	Authorization endpoint configuration.
static class	OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.EndSessionConfigurationProperties	End session endpoint configuration.
static class	OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.RegistrationEndpointConfigurationProperties	Registration endpoint configuration.
static class	OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.TokenEndpointConfigurationProperties	Token endpoint configuration.
static class	OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.UserInfoEndpointConfigurationProperties	User info endpoint configuration.

Field Summary

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

DEFAULT_PROTECTED_RESOURCE_METADATA

Method Summary

Modifier and Type	Method	Description
Optional<AuthorizationEndpointConfiguration>	getAuthorization()
@NonNull String	getConfigurationPath()
@NonNull EndSessionEndpointConfiguration	getEndSession()
Optional<URL>	getIssuer()
Optional<String>	getJwksUri()
@NonNull String	getName()
Optional<EndpointConfiguration>	getRegistration()
Optional<TokenEndpointConfiguration>	getToken()
Optional<EndpointConfiguration>	getUserInfo()
boolean	isProtectedResourceMetadata()
void	setAuthorization(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.AuthorizationEndpointConfigurationProperties authorization)	Sets the authorization endpoint configuration.
void	setConfigurationPath(@NonNull String configurationPath)	The configuration path to discover openid configuration.
void	setEndSession(@NonNull OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.EndSessionConfigurationProperties endSession)	Sets the end session endpoint configuration.
void	setIssuer(@Nullable URL issuer)	URL using the https scheme with no query or fragment component that the Open ID provider asserts as its issuer identifier.
void	setJwksUri(String jwksUri)	The JWKS signature URI.
void	setProtectedResourceMetadata(boolean protectedResourceMetadata)	Whether the protected resource metadata endpoint should expose the OpenID issuer as an authorization server.
void	setRegistration(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.RegistrationEndpointConfigurationProperties registration)	Sets the registration endpoint configuration.
void	setToken(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.TokenEndpointConfigurationProperties token)	Sets the token endpoint configuration.
void	setUserInfo(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.UserInfoEndpointConfigurationProperties userInfo)	Sets the user info endpoint configuration.

Methods inherited from class java.lang.Object

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

Method Details

getName

@NonNull
public @NonNull String getName()

Specified by:

getName in interface io.micronaut.core.naming.Named

isProtectedResourceMetadata

public boolean isProtectedResourceMetadata()

Specified by:

isProtectedResourceMetadata in interface OpenIdClientConfiguration

Returns:

whether the protected resource metadata endpoint should expose the OpenID issuer as an authorization server.

setProtectedResourceMetadata

public void setProtectedResourceMetadata(boolean protectedResourceMetadata)

Whether the protected resource metadata endpoint should expose the OpenID issuer as an authorization server. Default value: true.

Parameters:

protectedResourceMetadata - Whether the protected resource metadata endpoint should expose the OpenID issuer as an authorization server.

getIssuer

public Optional<URL> getIssuer()

Specified by:

getIssuer in interface OpenIdClientConfiguration

Returns:

URL that the OpenID provider asserts as its issuer identifier.

setIssuer

public void setIssuer(@Nullable
 @Nullable URL issuer)

URL using the https scheme with no query or fragment component that the Open ID provider asserts as its issuer identifier.

Parameters:

issuer - The issuer

getConfigurationPath

@NonNull
public @NonNull String getConfigurationPath()

Specified by:

getConfigurationPath in interface OpenIdClientConfiguration

Returns:

The OpenID configuration path

setConfigurationPath

public void setConfigurationPath(@NonNull
 @NonNull String configurationPath)

The configuration path to discover openid configuration. Default ("/.well-known/openid-configuration").

Parameters:

configurationPath - The configuration path

getJwksUri

public Optional<String> getJwksUri()

Specified by:

getJwksUri in interface OpenIdClientConfiguration

Returns:

The JWKS configuration

setJwksUri

public void setJwksUri(String jwksUri)

The JWKS signature URI.

Parameters:

jwksUri - The signature uri

getRegistration

public Optional<EndpointConfiguration> getRegistration()

Specified by:

getRegistration in interface OpenIdClientConfiguration

Returns:

The registration endpoint configuration

See Also:

• RFC 7591 - Section 3.1
• OpenID Connect Client Registration

setRegistration

public void setRegistration(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.RegistrationEndpointConfigurationProperties registration)

Sets the registration endpoint configuration.

Parameters:

registration - The registration endpoint configuration

getUserInfo

public Optional<EndpointConfiguration> getUserInfo()

Specified by:

getUserInfo in interface OpenIdClientConfiguration

Returns:

The user info endpoint configuration

See Also:

• OpenID Connect Core 1.0 - UserInfo

setUserInfo

public void setUserInfo(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.UserInfoEndpointConfigurationProperties userInfo)

Sets the user info endpoint configuration.

Parameters:

userInfo - The user info endpoint configuration

getAuthorization

public Optional<AuthorizationEndpointConfiguration> getAuthorization()

Specified by:

getAuthorization in interface OpenIdClientConfiguration

Returns:

The authorization endpoint configuration

See Also:

• RFC 6749 - Section 3.1
• OpenID Connect Core 1.0 - Authorization Endpoint

setAuthorization

public void setAuthorization(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.AuthorizationEndpointConfigurationProperties authorization)

Sets the authorization endpoint configuration.

Parameters:

authorization - The authorization endpoint configuration

getToken

public Optional<TokenEndpointConfiguration> getToken()

Specified by:

getToken in interface OpenIdClientConfiguration

Returns:

The token endpoint configuration

See Also:

• RFC 6749 - Section 4.1.3
• OpenID Connect Core 1.0

setToken

public void setToken(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.TokenEndpointConfigurationProperties token)

Sets the token endpoint configuration.

Parameters:

token - The token endpoint configuration

getEndSession

@NonNull
public @NonNull EndSessionEndpointConfiguration getEndSession()

Specified by:

getEndSession in interface OpenIdClientConfiguration

Returns:

The end session configuration

See Also:

• OpenID Connect Session 1.0

setEndSession

public void setEndSession(@NonNull
 @NonNull OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.EndSessionConfigurationProperties endSession)

Sets the end session endpoint configuration.

Parameters:

endSession - End session endpoint configuration