Package io.quarkus.oidc.client
Class OidcClientConfig
- java.lang.Object
-
- io.quarkus.oidc.common.runtime.OidcCommonConfig
-
- io.quarkus.oidc.client.OidcClientConfig
-
public class OidcClientConfig extends OidcCommonConfig
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
OidcClientConfig.Grant
-
Nested classes/interfaces inherited from class io.quarkus.oidc.common.runtime.OidcCommonConfig
OidcCommonConfig.Credentials, OidcCommonConfig.Proxy, OidcCommonConfig.Tls
-
-
Field Summary
Fields Modifier and Type Field Description boolean
absoluteExpiresIn
If the access token 'expires_in' property should be checked as an absolute time value as opposed to a duration relative to the current time.boolean
clientEnabled
If this client configuration is enabled.boolean
earlyTokensAcquisition
Requires that all filters which use 'OidcClient' acquire the tokens at the post-construct initialization time, possibly long before these tokens are used.OidcClientConfig.Grant
grant
Map<String,Map<String,String>>
grantOptions
Grant optionsMap<String,String>
headers
Custom HTTP headers which have to be sent to the token endpointOptional<String>
id
A unique OIDC client identifier.Optional<Duration>
refreshTokenTimeSkew
Refresh token time skew in seconds.Optional<List<String>>
scopes
List of access token scopes-
Fields inherited from class io.quarkus.oidc.common.runtime.OidcCommonConfig
authServerUrl, clientId, connectionDelay, connectionRetryCount, connectionTimeout, credentials, discoveryEnabled, maxPoolSize, proxy, revokePath, tls, tokenPath
-
-
Constructor Summary
Constructors Constructor Description OidcClientConfig()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OidcClientConfig.Grant
getGrant()
Map<String,Map<String,String>>
getGrantOptions()
Map<String,String>
getHeaders()
Optional<String>
getId()
Optional<Duration>
getRefreshTokenTimeSkew()
Optional<List<String>>
getScopes()
boolean
isAbsoluteExpiresIn()
boolean
isClientEnabled()
void
setAbsoluteExpiresIn(boolean absoluteExpiresIn)
void
setClientEnabled(boolean clientEnabled)
void
setGrant(OidcClientConfig.Grant grant)
void
setGrantOptions(Map<String,Map<String,String>> grantOptions)
void
setHeaders(Map<String,String> headers)
void
setId(String id)
void
setRefreshTokenTimeSkew(Duration refreshTokenTimeSkew)
void
setScopes(List<String> scopes)
-
Methods inherited from class io.quarkus.oidc.common.runtime.OidcCommonConfig
getAuthServerUrl, getClientId, getConnectionDelay, getConnectionTimeout, getCredentials, getMaxPoolSize, getProxy, getRevokePath, getTokenPath, isDiscoveryEnabled, setAuthServerUrl, setClientId, setConnectionDelay, setConnectionTimeout, setCredentials, setDiscoveryEnabled, setMaxPoolSize, setProxy, setRevokePath, setTokenPath
-
-
-
-
Field Detail
-
id
@ConfigItem public Optional<String> id
A unique OIDC client identifier. It must be set when OIDC clients are created dynamically and is optional in all other cases.
-
clientEnabled
@ConfigItem(defaultValue="true") public boolean clientEnabled
If this client configuration is enabled.
-
scopes
@ConfigItem public Optional<List<String>> scopes
List of access token scopes
-
refreshTokenTimeSkew
@ConfigItem public Optional<Duration> refreshTokenTimeSkew
Refresh token time skew in seconds. If this property is enabled then the configured number of seconds is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token's expiration time then a refresh is going to happen.
-
absoluteExpiresIn
@ConfigItem(defaultValue="false") public boolean absoluteExpiresIn
If the access token 'expires_in' property should be checked as an absolute time value as opposed to a duration relative to the current time.
-
grant
public OidcClientConfig.Grant grant
-
earlyTokensAcquisition
@ConfigItem(defaultValue="true") public boolean earlyTokensAcquisition
Requires that all filters which use 'OidcClient' acquire the tokens at the post-construct initialization time, possibly long before these tokens are used. This property should be disabled if the access token may expire before it is used for the first time and no refresh token is available.
-
headers
@ConfigItem public Map<String,String> headers
Custom HTTP headers which have to be sent to the token endpoint
-
-
Method Detail
-
setId
public void setId(String id)
-
isClientEnabled
public boolean isClientEnabled()
-
setClientEnabled
public void setClientEnabled(boolean clientEnabled)
-
setRefreshTokenTimeSkew
public void setRefreshTokenTimeSkew(Duration refreshTokenTimeSkew)
-
isAbsoluteExpiresIn
public boolean isAbsoluteExpiresIn()
-
setAbsoluteExpiresIn
public void setAbsoluteExpiresIn(boolean absoluteExpiresIn)
-
setGrant
public void setGrant(OidcClientConfig.Grant grant)
-
getGrant
public OidcClientConfig.Grant getGrant()
-
-