OauthClientConfigurationProperties.OpenIdClientConfigurationProperties (javadoc 2.3.0 API)

java.lang.Object
- io.micronaut.security.oauth2.configuration.OauthClientConfigurationProperties.OpenIdClientConfigurationProperties

All Implemented Interfaces:: io.micronaut.core.naming.Named, OpenIdClientConfiguration

Enclosing class:: OauthClientConfigurationProperties

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

OpenID client configuration.

Nested Class Summary

Nested Classes
Modifier and Type	Class and 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Optional<AuthorizationEndpointConfiguration>`	`getAuthorization()`
`java.lang.String`	`getConfigurationPath()`
`EndSessionEndpointConfiguration`	`getEndSession()`
`java.util.Optional<java.net.URL>`	`getIssuer()`
`java.util.Optional<java.lang.String>`	`getJwksUri()`
`java.lang.String`	`getName()`
`java.util.Optional<EndpointConfiguration>`	`getRegistration()`
`java.util.Optional<TokenEndpointConfiguration>`	`getToken()`
`java.util.Optional<EndpointConfiguration>`	`getUserInfo()`
`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 ().
    
    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()
```
    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 java.util.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 java.util.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 java.util.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 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
                          OauthClientConfigurationProperties.OpenIdClientConfigurationProperties.EndSessionConfigurationProperties endSession)
```
    Sets the end session endpoint configuration.
    
    Parameters:
    
    endSession - End session endpoint configuration

Class OauthClientConfigurationProperties.OpenIdClientConfigurationProperties

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getIssuer

setIssuer

getConfigurationPath

setConfigurationPath

getJwksUri

setJwksUri

getRegistration

setRegistration

getUserInfo

setUserInfo

getAuthorization

setAuthorization

getToken

setToken

getEndSession

setEndSession