java.lang.Object
- org.wildfly.security.http.oidc.OidcClientConfiguration

Direct Known Subclasses:

OidcClientContext.OidcClientConfigurationDelegate
```
public class OidcClientConfiguration
extends Object
```
The OpenID Connect (OIDC) configuration for a client application. This class is based on org.keycloak.adapters.KeycloakDeployment.

Author:

Bill Burke, Brad Culley, John D. Ament, Farah Juma

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class OidcClientConfiguration.RelativeUrlsUsed

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`accountUrl`
`protected boolean`	`alwaysRefreshToken`
`protected String`	`authServerBaseUrl`
`protected String`	`authUrl`
`protected boolean`	`autodetectBearerOnly`
`protected boolean`	`bearerOnly`
`protected Callable<org.apache.http.client.HttpClient>`	`client`
`protected ClientCredentialsProvider`	`clientAuthenticator`
`protected String`	`clientId`
`protected int`	`confidentialPort`
`protected boolean`	`cors`
`protected String`	`corsAllowedHeaders`
`protected String`	`corsAllowedMethods`
`protected String`	`corsExposedHeaders`
`protected int`	`corsMaxAge`
`protected boolean`	`delegateBearerErrorResponseSending`
`protected boolean`	`enableBasicAuth`
`protected boolean`	`exposeToken`
`protected boolean`	`ignoreOAuthQueryParameter`
`protected String`	`issuerUrl`
`protected String`	`jwksUrl`
`protected String`	`logoutUrl`
`protected int`	`minTimeBetweenJwksRequests`
`protected int`	`notBefore`
`protected String`	`oidcStateCookiePath`
`protected boolean`	`pkce`
`protected String`	`principalAttribute`
`protected String`	`providerUrl`
`protected boolean`	`publicClient`
`protected int`	`publicKeyCacheTtl`
`protected PublicKeyLocator`	`publicKeyLocator`
`protected String`	`realm`
`protected Map<String,String>`	`redirectRewriteRules`
`protected boolean`	`registerNodeAtStartup`
`protected int`	`registerNodePeriod`
`protected String`	`registerNodeUrl`
`protected OidcClientConfiguration.RelativeUrlsUsed`	`relativeUrls`
`protected String`	`resource`
`protected Map<String,Object>`	`resourceCredentials`
`protected String`	`scope`
`protected Oidc.SSLRequired`	`sslRequired`
`protected String`	`stateCookieName`
`protected int`	`tokenMinimumTimeToLive`
`protected String`	`tokenSignatureAlgorithm`
`protected Oidc.TokenStore`	`tokenStore`
`protected String`	`tokenUrl`
`protected boolean`	`turnOffChangeSessionIdOnLogin`
`protected String`	`unregisterNodeUrl`
`protected boolean`	`useRealmRoleMappings`
`protected boolean`	`useResourceRoleMappings`
`protected boolean`	`verifyTokenAudience`

Constructor Summary

Constructors
Constructor Description

OidcClientConfiguration()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getAccountUrl()`
`String`	`getAuthServerBaseUrl()`
`String`	`getAuthUrl()`
`org.apache.http.client.HttpClient`	`getClient()`
`ClientCredentialsProvider`	`getClientAuthenticator()`
`String`	`getClientId()`
`int`	`getConfidentialPort()`
`String`	`getCorsAllowedHeaders()`
`String`	`getCorsAllowedMethods()`
`String`	`getCorsExposedHeaders()`
`int`	`getCorsMaxAge()`
`private String`	`getDiscoveryUrl()`
`String`	`getIssuerUrl()`
`String`	`getJwksUrl()`
`String`	`getLogoutUrl()`
`int`	`getMinTimeBetweenJwksRequests()`
`int`	`getNotBefore()`
`protected OidcProviderMetadata`	`getOidcProviderMetadata(String discoveryUrl)`
`String`	`getOidcStateCookiePath()`
`String`	`getPrincipalAttribute()`
`String`	`getProviderUrl()`
`int`	`getPublicKeyCacheTtl()`
`PublicKeyLocator`	`getPublicKeyLocator()`
`String`	`getRealm()`
`Map<String,String>`	`getRedirectRewriteRules()`
`int`	`getRegisterNodePeriod()`
`String`	`getRegisterNodeUrl()`
`OidcClientConfiguration.RelativeUrlsUsed`	`getRelativeUrls()`
`String`	`getResource()`
`Map<String,Object>`	`getResourceCredentials()`
`String`	`getResourceName()`
`String`	`getScope()`
`Oidc.SSLRequired`	`getSSLRequired()`
`String`	`getStateCookieName()`
`int`	`getTokenMinimumTimeToLive()`
`String`	`getTokenSignatureAlgorithm()`
`Oidc.TokenStore`	`getTokenStore()`
`String`	`getTokenUrl()`
`String`	`getUnregisterNodeUrl()`
`private static String`	`getUrl(String baseUrl, String... paths)`
`boolean`	`isAlwaysRefreshToken()`
`boolean`	`isAutodetectBearerOnly()`
`boolean`	`isBearerOnly()`
`boolean`	`isConfigured()`
`boolean`	`isCors()`
`boolean`	`isDelegateBearerErrorResponseSending()`
`boolean`	`isEnableBasicAuth()`
`boolean`	`isExposeToken()`
`boolean`	`isOAuthQueryParameterEnabled()`
`boolean`	`isPkce()`
`boolean`	`isPublicClient()`
`boolean`	`isRegisterNodeAtStartup()`
`boolean`	`isSSLEnabled()`
`boolean`	`isTurnOffChangeSessionIdOnLogin()`
`boolean`	`isUseRealmRoleMappings()`
`boolean`	`isUseResourceRoleMappings()`
`boolean`	`isVerifyTokenAudience()`
`protected void`	`resetUrls()`	Resets all calculated urls to null and sets the relativeUrls field depending the value of the current discovery URL in the configuration.
`protected void`	`resolveUrls()`	URLs are loaded lazily when used.
`void`	`setAlwaysRefreshToken(boolean alwaysRefreshToken)`
`void`	`setAuthServerBaseUrl(OidcJsonConfiguration config)`
`void`	`setAutodetectBearerOnly(boolean autodetectBearerOnly)`
`void`	`setBearerOnly(boolean bearerOnly)`
`void`	`setClient(Callable<org.apache.http.client.HttpClient> callable)`
`void`	`setClient(org.apache.http.client.HttpClient client)`
`void`	`setClientAuthenticator(ClientCredentialsProvider clientAuthenticator)`
`void`	`setClientId(String clientId)`
`void`	`setConfidentialPort(int confidentialPort)`
`void`	`setCors(boolean cors)`
`void`	`setCorsAllowedHeaders(String corsAllowedHeaders)`
`void`	`setCorsAllowedMethods(String corsAllowedMethods)`
`void`	`setCorsExposedHeaders(String corsExposedHeaders)`
`void`	`setCorsMaxAge(int corsMaxAge)`
`void`	`setDelegateBearerErrorResponseSending(boolean delegateBearerErrorResponseSending)`
`void`	`setEnableBasicAuth(boolean enableBasicAuth)`
`void`	`setExposeToken(boolean exposeToken)`
`void`	`setIgnoreOAuthQueryParameter(boolean ignoreOAuthQueryParameter)`
`void`	`setMinTimeBetweenJwksRequests(int minTimeBetweenJwksRequests)`
`void`	`setNotBefore(int notBefore)`
`void`	`setOidcStateCookiePath(String oidcStateCookiePath)`
`void`	`setPkce(boolean pkce)`
`void`	`setPrincipalAttribute(String principalAttribute)`
`void`	`setProviderUrl(String providerUrl)`
`void`	`setPublicClient(boolean publicClient)`
`void`	`setPublicKeyCacheTtl(int publicKeyCacheTtl)`
`void`	`setPublicKeyLocator(PublicKeyLocator publicKeyLocator)`
`void`	`setRealm(String realm)`
`void`	`setRegisterNodeAtStartup(boolean registerNodeAtStartup)`
`void`	`setRegisterNodePeriod(int registerNodePeriod)`
`void`	`setResource(String resource)`
`void`	`setResourceCredentials(Map<String,Object> resourceCredentials)`
`void`	`setRewriteRedirectRules(Map<String,String> redirectRewriteRules)`
`void`	`setScope(String scope)`
`void`	`setSSLRequired(Oidc.SSLRequired sslRequired)`
`void`	`setStateCookieName(String stateCookieName)`
`void`	`setTokenMinimumTimeToLive(int tokenMinimumTimeToLive)`
`void`	`setTokenSignatureAlgorithm(String tokenSignatureAlgorithm)`
`void`	`setTokenStore(Oidc.TokenStore tokenStore)`
`void`	`setTurnOffChangeSessionIdOnLogin(boolean turnOffChangeSessionIdOnLogin)`
`void`	`setUseRealmRoleMappings(boolean useRealmRoleMappings)`
`void`	`setUseResourceRoleMappings(boolean useResourceRoleMappings)`
`void`	`setVerifyTokenAudience(boolean verifyTokenAudience)`
`void`	`updateNotBefore(int notBefore)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

relativeUrls

protected OidcClientConfiguration.RelativeUrlsUsed relativeUrls

realm
```
protected String realm
```

publicKeyLocator

protected PublicKeyLocator publicKeyLocator

authServerBaseUrl
```
protected String authServerBaseUrl
```

providerUrl
```
protected String providerUrl
```

authUrl
```
protected String authUrl
```

tokenUrl
```
protected String tokenUrl
```

logoutUrl
```
protected String logoutUrl
```

accountUrl
```
protected String accountUrl
```

registerNodeUrl
```
protected String registerNodeUrl
```

unregisterNodeUrl
```
protected String unregisterNodeUrl
```

jwksUrl
```
protected String jwksUrl
```

issuerUrl
```
protected String issuerUrl
```

principalAttribute
```
protected String principalAttribute
```

resource
```
protected String resource
```

clientId
```
protected String clientId
```

bearerOnly
```
protected boolean bearerOnly
```

autodetectBearerOnly
```
protected boolean autodetectBearerOnly
```

enableBasicAuth
```
protected boolean enableBasicAuth
```

publicClient
```
protected boolean publicClient
```

resourceCredentials

protected Map<String,Object> resourceCredentials

clientAuthenticator

protected ClientCredentialsProvider clientAuthenticator

client

protected Callable<org.apache.http.client.HttpClient> client

scope
```
protected String scope
```

sslRequired
```
protected Oidc.SSLRequired sslRequired
```

confidentialPort
```
protected int confidentialPort
```

tokenStore
```
protected Oidc.TokenStore tokenStore
```

oidcStateCookiePath
```
protected String oidcStateCookiePath
```

stateCookieName
```
protected String stateCookieName
```

useResourceRoleMappings

protected boolean useResourceRoleMappings

useRealmRoleMappings
```
protected boolean useRealmRoleMappings
```

cors
```
protected boolean cors
```

corsMaxAge
```
protected int corsMaxAge
```

corsAllowedHeaders
```
protected String corsAllowedHeaders
```

corsAllowedMethods
```
protected String corsAllowedMethods
```

corsExposedHeaders
```
protected String corsExposedHeaders
```

exposeToken
```
protected boolean exposeToken
```

alwaysRefreshToken
```
protected boolean alwaysRefreshToken
```

registerNodeAtStartup

protected boolean registerNodeAtStartup

registerNodePeriod
```
protected int registerNodePeriod
```

turnOffChangeSessionIdOnLogin

protected boolean turnOffChangeSessionIdOnLogin

notBefore
```
protected volatile int notBefore
```

tokenMinimumTimeToLive
```
protected int tokenMinimumTimeToLive
```

minTimeBetweenJwksRequests

protected int minTimeBetweenJwksRequests

publicKeyCacheTtl
```
protected int publicKeyCacheTtl
```

pkce
```
protected boolean pkce
```

ignoreOAuthQueryParameter

protected boolean ignoreOAuthQueryParameter

redirectRewriteRules

protected Map<String,String> redirectRewriteRules

delegateBearerErrorResponseSending

protected boolean delegateBearerErrorResponseSending

verifyTokenAudience
```
protected boolean verifyTokenAudience
```

tokenSignatureAlgorithm

protected String tokenSignatureAlgorithm

Constructor Detail
- OidcClientConfiguration
```
public OidcClientConfiguration()
```

Method Detail

isConfigured
```
public boolean isConfigured()
```

getResourceName
```
public String getResourceName()
```

getResource
```
public String getResource()
```

getClientId
```
public String getClientId()
```

getRealm
```
public String getRealm()
```

setRealm

public void setRealm(String realm)

getPublicKeyLocator

public PublicKeyLocator getPublicKeyLocator()

setPublicKeyLocator

public void setPublicKeyLocator(PublicKeyLocator publicKeyLocator)

getAuthServerBaseUrl
```
public String getAuthServerBaseUrl()
```

setProviderUrl

public void setProviderUrl(String providerUrl)

setAuthServerBaseUrl

public void setAuthServerBaseUrl(OidcJsonConfiguration config)

resetUrls
```
protected void resetUrls()
```
Resets all calculated urls to null and sets the relativeUrls field depending the value of the current discovery URL in the configuration. If it is relative is set to ALWAYS and if absolute is set to NEVER.

resolveUrls
```
protected void resolveUrls()
```
URLs are loaded lazily when used.

getOidcProviderMetadata

protected OidcProviderMetadata getOidcProviderMetadata(String discoveryUrl)
                                                throws Exception

Throws:: Exception

getDiscoveryUrl
```
private String getDiscoveryUrl()
```

getUrl

private static String getUrl(String baseUrl,
                             String... paths)

getRelativeUrls

public OidcClientConfiguration.RelativeUrlsUsed getRelativeUrls()

getProviderUrl
```
public String getProviderUrl()
```

getAuthUrl
```
public String getAuthUrl()
```

getTokenUrl
```
public String getTokenUrl()
```

getLogoutUrl
```
public String getLogoutUrl()
```

getAccountUrl
```
public String getAccountUrl()
```

getRegisterNodeUrl
```
public String getRegisterNodeUrl()
```

getUnregisterNodeUrl
```
public String getUnregisterNodeUrl()
```

getJwksUrl
```
public String getJwksUrl()
```

getIssuerUrl
```
public String getIssuerUrl()
```

setResource

public void setResource(String resource)

setClientId

public void setClientId(String clientId)

isBearerOnly
```
public boolean isBearerOnly()
```

setBearerOnly

public void setBearerOnly(boolean bearerOnly)

isAutodetectBearerOnly

public boolean isAutodetectBearerOnly()

setAutodetectBearerOnly

public void setAutodetectBearerOnly(boolean autodetectBearerOnly)

isEnableBasicAuth
```
public boolean isEnableBasicAuth()
```

setEnableBasicAuth

public void setEnableBasicAuth(boolean enableBasicAuth)

isPublicClient
```
public boolean isPublicClient()
```

setPublicClient

public void setPublicClient(boolean publicClient)

getResourceCredentials

public Map<String,Object> getResourceCredentials()

setResourceCredentials

public void setResourceCredentials(Map<String,Object> resourceCredentials)

getClientAuthenticator

public ClientCredentialsProvider getClientAuthenticator()

setClientAuthenticator

public void setClientAuthenticator(ClientCredentialsProvider clientAuthenticator)

getClient

public org.apache.http.client.HttpClient getClient()

setClient

public void setClient(org.apache.http.client.HttpClient client)

getScope
```
public String getScope()
```

setScope

public void setScope(String scope)

getSSLRequired

public Oidc.SSLRequired getSSLRequired()

setSSLRequired

public void setSSLRequired(Oidc.SSLRequired sslRequired)

isSSLEnabled
```
public boolean isSSLEnabled()
```

getConfidentialPort
```
public int getConfidentialPort()
```

setConfidentialPort

public void setConfidentialPort(int confidentialPort)

getTokenStore

public Oidc.TokenStore getTokenStore()

setTokenStore

public void setTokenStore(Oidc.TokenStore tokenStore)

getOidcStateCookiePath

public String getOidcStateCookiePath()

setOidcStateCookiePath

public void setOidcStateCookiePath(String oidcStateCookiePath)

getStateCookieName
```
public String getStateCookieName()
```

setStateCookieName

public void setStateCookieName(String stateCookieName)

isUseResourceRoleMappings

public boolean isUseResourceRoleMappings()

setUseResourceRoleMappings

public void setUseResourceRoleMappings(boolean useResourceRoleMappings)

isUseRealmRoleMappings

public boolean isUseRealmRoleMappings()

setUseRealmRoleMappings

public void setUseRealmRoleMappings(boolean useRealmRoleMappings)

isCors
```
public boolean isCors()
```

setCors
```
public void setCors(boolean cors)
```

getCorsMaxAge
```
public int getCorsMaxAge()
```

setCorsMaxAge

public void setCorsMaxAge(int corsMaxAge)

getCorsAllowedHeaders
```
public String getCorsAllowedHeaders()
```

setCorsAllowedHeaders

public void setCorsAllowedHeaders(String corsAllowedHeaders)

getCorsAllowedMethods
```
public String getCorsAllowedMethods()
```

setCorsAllowedMethods

public void setCorsAllowedMethods(String corsAllowedMethods)

getCorsExposedHeaders
```
public String getCorsExposedHeaders()
```

setCorsExposedHeaders

public void setCorsExposedHeaders(String corsExposedHeaders)

isExposeToken
```
public boolean isExposeToken()
```

setExposeToken

public void setExposeToken(boolean exposeToken)

getNotBefore
```
public int getNotBefore()
```

setNotBefore

public void setNotBefore(int notBefore)

updateNotBefore

public void updateNotBefore(int notBefore)

isAlwaysRefreshToken
```
public boolean isAlwaysRefreshToken()
```

setAlwaysRefreshToken

public void setAlwaysRefreshToken(boolean alwaysRefreshToken)

isRegisterNodeAtStartup

public boolean isRegisterNodeAtStartup()

setRegisterNodeAtStartup

public void setRegisterNodeAtStartup(boolean registerNodeAtStartup)

getRegisterNodePeriod
```
public int getRegisterNodePeriod()
```

setRegisterNodePeriod

public void setRegisterNodePeriod(int registerNodePeriod)

getPrincipalAttribute
```
public String getPrincipalAttribute()
```

setPrincipalAttribute

public void setPrincipalAttribute(String principalAttribute)

isTurnOffChangeSessionIdOnLogin

public boolean isTurnOffChangeSessionIdOnLogin()

setTurnOffChangeSessionIdOnLogin

public void setTurnOffChangeSessionIdOnLogin(boolean turnOffChangeSessionIdOnLogin)

getTokenMinimumTimeToLive

public int getTokenMinimumTimeToLive()

setTokenMinimumTimeToLive

public void setTokenMinimumTimeToLive(int tokenMinimumTimeToLive)

getMinTimeBetweenJwksRequests

public int getMinTimeBetweenJwksRequests()

setMinTimeBetweenJwksRequests

public void setMinTimeBetweenJwksRequests(int minTimeBetweenJwksRequests)

getPublicKeyCacheTtl
```
public int getPublicKeyCacheTtl()
```

setPublicKeyCacheTtl

public void setPublicKeyCacheTtl(int publicKeyCacheTtl)

isPkce
```
public boolean isPkce()
```

setPkce
```
public void setPkce(boolean pkce)
```

setIgnoreOAuthQueryParameter

public void setIgnoreOAuthQueryParameter(boolean ignoreOAuthQueryParameter)

isOAuthQueryParameterEnabled

public boolean isOAuthQueryParameterEnabled()

getRedirectRewriteRules

public Map<String,String> getRedirectRewriteRules()

setRewriteRedirectRules

public void setRewriteRedirectRules(Map<String,String> redirectRewriteRules)

isDelegateBearerErrorResponseSending

public boolean isDelegateBearerErrorResponseSending()

setDelegateBearerErrorResponseSending

public void setDelegateBearerErrorResponseSending(boolean delegateBearerErrorResponseSending)

isVerifyTokenAudience

public boolean isVerifyTokenAudience()

setVerifyTokenAudience

public void setVerifyTokenAudience(boolean verifyTokenAudience)

setClient

public void setClient(Callable<org.apache.http.client.HttpClient> callable)

setTokenSignatureAlgorithm

public void setTokenSignatureAlgorithm(String tokenSignatureAlgorithm)

getTokenSignatureAlgorithm

public String getTokenSignatureAlgorithm()

Class OidcClientConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

relativeUrls

realm

publicKeyLocator

authServerBaseUrl

providerUrl

authUrl

tokenUrl

logoutUrl

accountUrl

registerNodeUrl

unregisterNodeUrl

jwksUrl

issuerUrl

principalAttribute

resource

clientId

bearerOnly

autodetectBearerOnly

enableBasicAuth

publicClient

resourceCredentials

clientAuthenticator

client

scope

sslRequired

confidentialPort

tokenStore

oidcStateCookiePath

stateCookieName

useResourceRoleMappings

useRealmRoleMappings

cors

corsMaxAge

corsAllowedHeaders

corsAllowedMethods

corsExposedHeaders

exposeToken

alwaysRefreshToken

registerNodeAtStartup

registerNodePeriod

turnOffChangeSessionIdOnLogin

notBefore

tokenMinimumTimeToLive

minTimeBetweenJwksRequests

publicKeyCacheTtl

pkce

ignoreOAuthQueryParameter

redirectRewriteRules

delegateBearerErrorResponseSending

verifyTokenAudience

tokenSignatureAlgorithm

Constructor Detail

OidcClientConfiguration

Method Detail

isConfigured

getResourceName

getResource

getClientId

getRealm

setRealm

getPublicKeyLocator

setPublicKeyLocator

getAuthServerBaseUrl

setProviderUrl

setAuthServerBaseUrl

resetUrls

resolveUrls

getOidcProviderMetadata

getDiscoveryUrl

getUrl

getRelativeUrls

getProviderUrl

getAuthUrl