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 java.lang.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.

Method Summary

Modifier and Type	Method	Description
java.util.Optional<AuthorizationEndpointConfiguration>	getAuthorization()	https://tools.ietf.org/html/rfc6749#section-3.1 https://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint
java.lang.String	getConfigurationPath()
EndSessionEndpointConfiguration	getEndSession()	https://openid.net/specs/openid-connect-session-1_0.html
java.util.Optional<java.net.URL>	getIssuer()
java.util.Optional<java.lang.String>	getJwksUri()
java.lang.String	getName()
java.util.Optional<EndpointConfiguration>	getRegistration()	https://tools.ietf.org/html/rfc7591#section-3.1 https://openid.net/specs/openid-connect-registration-1_0.html#ClientRegistration
java.util.Optional<TokenEndpointConfiguration>	getToken()	https://tools.ietf.org/html/rfc6749#section-4.1.3 https://openid.net/specs/openid-connect-core-1_0.html#TokenEndpoint
java.util.Optional<EndpointConfiguration>	getUserInfo()	https://openid.net/specs/openid-connect-core-1_0.html#UserInfo
void	setAuthorization(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.AuthorizationEndpointConfigurationProperties authorization)	Sets the authorization endpoint configuration.
void	setConfigurationPath(java.lang.String configurationPath)	The configuration path to discover openid configuration.
void	setEndSession(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.EndSessionConfigurationProperties endSession)	Sets the end session endpoint configuration.
void	setIssuer(java.net.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(java.lang.String jwksUri)	The JWKS signature URI.
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 Detail

getName

@Nonnull
public java.lang.String getName()

Specified by:

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

getIssuer

public java.util.Optional<java.net.URL> getIssuer()

Specified by:

getIssuer in interface OpenIdClientConfiguration

Returns:

URL that the OpenID provider asserts as its issuer identifier.

setIssuer

public void setIssuer(@Nullable
                      java.net.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 java.lang.String getConfigurationPath()

Specified by:

getConfigurationPath in interface OpenIdClientConfiguration

Returns:

The OpenID configuration path

setConfigurationPath

public void setConfigurationPath(@Nonnull
                                 java.lang.String configurationPath)

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

Parameters:

configurationPath - The configuration path

getJwksUri

public java.util.Optional<java.lang.String> getJwksUri()

Specified by:

getJwksUri in interface OpenIdClientConfiguration

Returns:

The JWKS configuration

setJwksUri

public void setJwksUri(java.lang.String jwksUri)

The JWKS signature URI.

Parameters:

jwksUri - The signature uri

getRegistration

public java.util.Optional<EndpointConfiguration> getRegistration()

Description copied from interface: OpenIdClientConfiguration

https://tools.ietf.org/html/rfc7591#section-3.1 https://openid.net/specs/openid-connect-registration-1_0.html#ClientRegistration

Specified by:

getRegistration in interface OpenIdClientConfiguration

Returns:

The registration endpoint configuration

setRegistration

public void setRegistration(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.RegistrationEndpointConfigurationProperties registration)

Sets the registration endpoint configuration.

Parameters:

registration - The registration endpoint configuration

getUserInfo

public java.util.Optional<EndpointConfiguration> getUserInfo()

Description copied from interface: OpenIdClientConfiguration

https://openid.net/specs/openid-connect-core-1_0.html#UserInfo

Specified by:

getUserInfo in interface OpenIdClientConfiguration

Returns:

The user info endpoint configuration

setUserInfo

public void setUserInfo(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.UserInfoEndpointConfigurationProperties userInfo)

Sets the user info endpoint configuration.

Parameters:

userInfo - The user info endpoint configuration

getAuthorization

public java.util.Optional<AuthorizationEndpointConfiguration> getAuthorization()

Description copied from interface: OpenIdClientConfiguration

https://tools.ietf.org/html/rfc6749#section-3.1 https://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint

Specified by:

getAuthorization in interface OpenIdClientConfiguration

Returns:

The authorization endpoint configuration

setAuthorization

public void setAuthorization(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.AuthorizationEndpointConfigurationProperties authorization)

Sets the authorization endpoint configuration.

Parameters:

authorization - The authorization endpoint configuration

getToken

public java.util.Optional<TokenEndpointConfiguration> getToken()

Description copied from interface: OpenIdClientConfiguration

https://tools.ietf.org/html/rfc6749#section-4.1.3 https://openid.net/specs/openid-connect-core-1_0.html#TokenEndpoint

Specified by:

getToken in interface OpenIdClientConfiguration

Returns:

The token endpoint configuration

setToken

public void setToken(OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.TokenEndpointConfigurationProperties token)

Sets the token endpoint configuration.

Parameters:

token - The token endpoint configuration

getEndSession

@Nonnull
public EndSessionEndpointConfiguration getEndSession()

Description copied from interface: OpenIdClientConfiguration

https://openid.net/specs/openid-connect-session-1_0.html

Specified by:

getEndSession in interface OpenIdClientConfiguration

Returns:

The end session configuration

setEndSession

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

Sets the end session endpoint configuration.

Parameters:

endSession - End session endpoint configuration