OauthClientConfigurationProperties (security-parent 3.8.1 API)

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

All Implemented Interfaces:: io.micronaut.core.util.Toggleable, OauthClientConfiguration

@Context
 @EachProperty(value="micronaut.security.oauth2.clients")
public class OauthClientConfigurationProperties
extends java.lang.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 and 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 and Description

static boolean DEFAULT_ENABLED
The default enable value.
- Fields inherited from interface io.micronaut.security.oauth2.configuration.OauthClientConfiguration
  DEFAULT_ADVANCED_EXPIRATION, DEFAULT_AUTHENTICATION_METHOD

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

Constructor Summary

Constructors
Constructor and Description

OauthClientConfigurationProperties(java.lang.String name)

Constructors
Constructor and Description
`OauthClientConfigurationProperties(java.lang.String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Optional<EndpointConfiguration>`	`getAuthorization()`
`java.util.Optional<ClientCredentialsConfiguration>`	`getClientCredentials()`
`java.lang.String`	`getClientId()`
`java.lang.String`	`getClientSecret()`
`GrantType`	`getGrantType()`
`java.util.Optional<SecureEndpointConfiguration>`	`getIntrospection()`
`java.lang.String`	`getName()`
`java.util.Optional<OpenIdClientConfiguration>`	`getOpenid()`
`java.util.Optional<SecureEndpointConfiguration>`	`getRevocation()`
`java.util.List<java.lang.String>`	`getScopes()`
`java.util.Optional<SecureEndpointConfiguration>`	`getToken()`
`boolean`	`isEnabled()`
`void`	`setAuthorization(OauthClientConfigurationProperties.AuthorizationEndpointConfigurationProperties authorization)` The OAuth 2.0 authorization endpoint configuration.
`void`	`setClientCredentials(OauthClientConfigurationProperties.ClientCredentialsConfigurationProperties clientCredentials)` Sets the Client Credentials configuration.
`void`	`setClientId(java.lang.String clientId)` OAuth 2.0 client id.
`void`	`setClientSecret(java.lang.String clientSecret)` OAuth 2.0 client secret.
`void`	`setEnabled(boolean enabled)` Sets whether the client is enabled.
`void`	`setGrantType(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`	`setRevocation(OauthClientConfigurationProperties.RevocationEndpointConfigurationProperties revocation)` Sets the revocation endpoint configuration.
`void`	`setScopes(java.util.List<java.lang.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 Detail
  - DEFAULT_ENABLED
```
public static final boolean DEFAULT_ENABLED
```
    The default enable value.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OauthClientConfigurationProperties
```
public OauthClientConfigurationProperties(@Parameter
                                          java.lang.String name)
```
    Parameters:
    
    name - The provider name
- Method Detail
  - getClientId
```
@NonNull
public java.lang.String getClientId()
```
    Specified by:
    
    getClientId in interface OauthClientConfiguration
    
    Returns:
    
    The client id
  - setClientId
```
public void setClientId(@NonNull
                        java.lang.String clientId)
```
    OAuth 2.0 client id.
    
    Parameters:
    
    clientId - The client id
  - getClientSecret
```
@Nullable
public java.lang.String getClientSecret()
```
    Specified by:
    
    getClientSecret in interface OauthClientConfiguration
    
    Returns:
    
    The client secret
  - setClientSecret
```
public void setClientSecret(@Nullable
                            java.lang.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 java.util.List<java.lang.String> getScopes()
```
    Specified by:
    
    getScopes in interface OauthClientConfiguration
    
    Returns:
    
    The scopes requested
  - setScopes
```
public void setScopes(java.util.List<java.lang.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 java.lang.String getName()
```
    Specified by:
    
    getName in interface OauthClientConfiguration
    
    Returns:
    
    The provider name
  - getGrantType
```
@NonNull
public GrantType getGrantType()
```
    Specified by:
    
    getGrantType in interface OauthClientConfiguration
    
    Returns:
    
    The grant type
  - setGrantType
```
public void setGrantType(@NonNull
                         GrantType grantType)
```
    OAuth 2.0 grant type. Default value (authorization_code).
    
    Parameters:
    
    grantType - The grant type
  - getToken
```
public java.util.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 java.util.Optional<EndpointConfiguration> getAuthorization()
```
    Specified by:
    
    getAuthorization in interface OauthClientConfiguration
    
    Returns:
    
    The optional authorization endpoint configuration
    
    See Also:
    
    RFC 6749 Section 3.1
  - getClientCredentials
```
@NonNull
public java.util.Optional<ClientCredentialsConfiguration> getClientCredentials()
```
    Specified by:
    
    getClientCredentials in interface OauthClientConfiguration
    
    Returns:
    
    The Client Credentials Configuration
  - setClientCredentials
```
public void setClientCredentials(@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 java.util.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 java.util.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 java.util.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

Class OauthClientConfigurationProperties

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENABLED

Constructor Detail

OauthClientConfigurationProperties

Method Detail

getClientId

setClientId

getClientSecret

setClientSecret

isEnabled

setEnabled

getScopes

setScopes

getName

getGrantType

setGrantType

getToken

setToken

getAuthorization

getClientCredentials

setClientCredentials

setAuthorization

getOpenid

setOpenid

getIntrospection

setIntrospection

getRevocation

setRevocation