Keycloak Core 24.0.0 · org.keycloak.representations.adapters.config.AdapterConfig

Modifier and Type	Field and Description
protected boolean	allowAnyHostname
protected boolean	alwaysRefreshToken
protected String	clientKeyPassword
protected String	clientKeystore
protected String	clientKeystorePassword
protected int	connectionPoolSize
protected long	connectionTimeout
protected long	connectionTTL
protected boolean	disableTrustManager
protected boolean	ignoreOAuthQueryParameter
protected int	minTimeBetweenJwksRequests
protected boolean	pkce
protected PolicyEnforcerConfig	policyEnforcerConfig
protected String	principalAttribute
protected String	proxyUrl The Proxy url to use for requests to the auth-server, configurable via the adapter config property `proxy-url`.
protected int	publicKeyCacheTtl
protected boolean	registerNodeAtStartup
protected int	registerNodePeriod
protected long	socketTimeout
protected String	tokenCookiePath
protected int	tokenMinimumTimeToLive
protected String	tokenStore
protected String	truststore
protected String	truststorePassword
protected Boolean	turnOffChangeSessionIdOnLogin
protected boolean	verifyTokenAudience

Constructor Summary

Access	Constructor and Description
public	AdapterConfig()

Method Summary

Modifier and Type	Method and Description
public String	getClientKeyPassword()
public String	getClientKeystore() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getClientKeystore. Returns keystore with client keys.
public String	getClientKeystorePassword() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getClientKeystorePassword. Returns keystore password.
public int	getConnectionPoolSize() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getConnectionPoolSize. Returns size of connection pool.
public long	getConnectionTimeout() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getConnectionTimeout. Returns timeout for establishing the connection with the remote host in milliseconds.
public long	getConnectionTTL() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getConnectionTTL. Returns the connection time-to-live
public int	getMinTimeBetweenJwksRequests()
public PolicyEnforcerConfig	getPolicyEnforcerConfig()
public String	getPrincipalAttribute()
public String	getProxyUrl() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getProxyUrl. Returns URL of HTTP proxy.
public int	getPublicKeyCacheTtl()
public String	getRealmInfoUrl()
public int	getRegisterNodePeriod()
public long	getSocketTimeout() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getSocketTimeout. Returns timeout for socket waiting for data in milliseconds.
public String	getTokenCookiePath()
public int	getTokenMinimumTimeToLive()
public String	getTokenStore()
public String	getTruststore() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getTruststore. Returns truststore filename.
public String	getTruststorePassword() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getTruststorePassword. Returns truststore password.
public Boolean	getTurnOffChangeSessionIdOnLogin()
public boolean	isAllowAnyHostname() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.isAllowAnyHostname. Returns boolean flag whether any hostname verification is done on the server's certificate, `true` means that verification is not done.
public boolean	isAlwaysRefreshToken()
public boolean	isDisableTrustManager() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.isDisableTrustManager. Returns boolean flag whether any trust management and hostname verification is done.
public boolean	isIgnoreOAuthQueryParameter()
public boolean	isPkce()
public boolean	isRegisterNodeAtStartup()
public boolean	isVerifyTokenAudience()
public void	setAllowAnyHostname(boolean allowAnyHostname)
public void	setAlwaysRefreshToken(boolean alwaysRefreshToken)
public void	setClientKeyPassword(String clientKeyPassword)
public void	setClientKeystore(String clientKeystore)
public void	setClientKeystorePassword(String clientKeystorePassword)
public void	setConnectionPoolSize(int connectionPoolSize)
public void	setConnectionTimeout(long connectionTimeout)
public void	setConnectionTTL(long connectionTTL)
public void	setDisableTrustManager(boolean disableTrustManager)
public void	setIgnoreOAuthQueryParameter(boolean ignoreOAuthQueryParameter)
public void	setMinTimeBetweenJwksRequests(int minTimeBetweenJwksRequests)
public void	setPkce(boolean pkce)
public void	setPolicyEnforcerConfig(PolicyEnforcerConfig policyEnforcerConfig)
public void	setPrincipalAttribute(String principalAttribute)
public void	setProxyUrl(String proxyUrl)
public void	setPublicKeyCacheTtl(int publicKeyCacheTtl)
public void	setRegisterNodeAtStartup(boolean registerNodeAtStartup)
public void	setRegisterNodePeriod(int registerNodePeriod)
public void	setSocketTimeout(long socketTimeout)
public void	setTokenCookiePath(String tokenCookiePath)
public void	setTokenMinimumTimeToLive(final int tokenMinimumTimeToLive)
public void	setTokenStore(String tokenStore)
public void	setTruststore(String truststore)
public void	setTruststorePassword(String truststorePassword)
public void	setTurnOffChangeSessionIdOnLogin(Boolean turnOffChangeSessionIdOnLogin)
public void	setVerifyTokenAudience(boolean verifyTokenAudience)

Field Detail

allowAnyHostname	back to summary
protected boolean allowAnyHostname Annotations @JsonProperty:allow-any-hostname

alwaysRefreshToken	back to summary
protected boolean alwaysRefreshToken Annotations @JsonProperty:always-refresh-token

clientKeyPassword	back to summary
protected String clientKeyPassword Annotations @JsonProperty:client-key-password

clientKeystore	back to summary
protected String clientKeystore Annotations @JsonProperty:client-keystore

clientKeystorePassword	back to summary
protected String clientKeystorePassword Annotations @JsonProperty:client-keystore-password

connectionPoolSize	back to summary
protected int connectionPoolSize Annotations @JsonProperty:connection-pool-size

connectionTimeout	back to summary
protected long connectionTimeout Annotations @JsonProperty:connection-timeout-millis

connectionTTL	back to summary
protected long connectionTTL Annotations @JsonProperty:connection-ttl-millis

disableTrustManager	back to summary
protected boolean disableTrustManager Annotations @JsonProperty:disable-trust-manager

ignoreOAuthQueryParameter	back to summary
protected boolean ignoreOAuthQueryParameter Annotations @JsonProperty:ignore-oauth-query-parameter

minTimeBetweenJwksRequests	back to summary
protected int minTimeBetweenJwksRequests Annotations @JsonProperty:min-time-between-jwks-requests

pkce	back to summary
protected boolean pkce Annotations @JsonProperty:enable-pkce

policyEnforcerConfig	back to summary
protected PolicyEnforcerConfig policyEnforcerConfig Annotations @JsonProperty:policy-enforcer

principalAttribute	back to summary
protected String principalAttribute Annotations @JsonProperty:principal-attribute

proxyUrl	back to summary
protected String proxyUrl The Proxy url to use for requests to the auth-server, configurable via the adapter config property `proxy-url`. Annotations @JsonProperty:proxy-url

publicKeyCacheTtl	back to summary
protected int publicKeyCacheTtl Annotations @JsonProperty:public-key-cache-ttl

registerNodeAtStartup	back to summary
protected boolean registerNodeAtStartup Annotations @JsonProperty:register-node-at-startup

registerNodePeriod	back to summary
protected int registerNodePeriod Annotations @JsonProperty:register-node-period

socketTimeout	back to summary
protected long socketTimeout Annotations @JsonProperty:socket-timeout-millis

tokenCookiePath	back to summary
protected String tokenCookiePath Annotations @JsonProperty:adapter-state-cookie-path

tokenMinimumTimeToLive	back to summary
protected int tokenMinimumTimeToLive Annotations @JsonProperty:token-minimum-time-to-live

tokenStore	back to summary
protected String tokenStore Annotations @JsonProperty:token-store

truststore	back to summary
protected String truststore Annotations @JsonProperty:truststore

truststorePassword	back to summary
protected String truststorePassword Annotations @JsonProperty:truststore-password

turnOffChangeSessionIdOnLogin	back to summary
protected Boolean turnOffChangeSessionIdOnLogin Annotations @JsonProperty:turn-off-change-session-id-on-login

verifyTokenAudience	back to summary
protected boolean verifyTokenAudience Annotations @JsonProperty:verify-token-audience

Constructor Detail

AdapterConfig	back to summary
public AdapterConfig()

Method Detail

getClientKeyPassword	back to summary
public String getClientKeyPassword()

getClientKeystore	back to summary
public String getClientKeystore() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getClientKeystore. Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getClientKeystore. Returns keystore with client keys. Annotations @Override

getClientKeystore

back to summary

public String getClientKeystore()

Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getClientKeystore.

Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getClientKeystore.

Returns keystore with client keys.

Annotations

@Override

getClientKeystorePassword	back to summary
public String getClientKeystorePassword() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getClientKeystorePassword. Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getClientKeystorePassword. Returns keystore password. Annotations @Override

getClientKeystorePassword

back to summary

public String getClientKeystorePassword()

Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getClientKeystorePassword.

Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getClientKeystorePassword.

Returns keystore password.

Annotations

@Override

getConnectionPoolSize	back to summary
public int getConnectionPoolSize() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getConnectionPoolSize. Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getConnectionPoolSize. Returns size of connection pool. Annotations @Override

getConnectionPoolSize

back to summary

public int getConnectionPoolSize()

Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getConnectionPoolSize.

Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getConnectionPoolSize.

Returns size of connection pool.

Annotations

@Override

getConnectionTimeout	back to summary
public long getConnectionTimeout() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getConnectionTimeout. Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getConnectionTimeout. Returns timeout for establishing the connection with the remote host in milliseconds.

getConnectionTimeout

back to summary

public long getConnectionTimeout()

Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getConnectionTimeout.

Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getConnectionTimeout.

Returns timeout for establishing the connection with the remote host in milliseconds.

getConnectionTTL	back to summary
public long getConnectionTTL() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getConnectionTTL. Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getConnectionTTL. Returns the connection time-to-live Annotations @Override

getConnectionTTL

back to summary

public long getConnectionTTL()

Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getConnectionTTL.

Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getConnectionTTL.

Returns the connection time-to-live

Annotations

@Override

getMinTimeBetweenJwksRequests	back to summary
public int getMinTimeBetweenJwksRequests()

getPolicyEnforcerConfig	back to summary
public PolicyEnforcerConfig getPolicyEnforcerConfig()

getPrincipalAttribute	back to summary
public String getPrincipalAttribute()

getProxyUrl	back to summary
public String getProxyUrl() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getProxyUrl. Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getProxyUrl. Returns URL of HTTP proxy. Annotations @Override

getProxyUrl

back to summary

public String getProxyUrl()

Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getProxyUrl.

Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getProxyUrl.

Returns URL of HTTP proxy.

Annotations

@Override

getPublicKeyCacheTtl	back to summary
public int getPublicKeyCacheTtl()

getRealmInfoUrl	back to summary
public String getRealmInfoUrl() Annotations @JsonIgnore

getRegisterNodePeriod	back to summary
public int getRegisterNodePeriod()

getSocketTimeout	back to summary
public long getSocketTimeout() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getSocketTimeout. Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getSocketTimeout. Returns timeout for socket waiting for data in milliseconds.

getSocketTimeout

back to summary

public long getSocketTimeout()

Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getSocketTimeout.

Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getSocketTimeout.

Returns timeout for socket waiting for data in milliseconds.

getTokenCookiePath	back to summary
public String getTokenCookiePath()

getTokenMinimumTimeToLive	back to summary
public int getTokenMinimumTimeToLive()

getTokenStore	back to summary
public String getTokenStore()

getTruststore	back to summary
public String getTruststore() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getTruststore. Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getTruststore. Returns truststore filename. Annotations @Override

getTruststore

back to summary

public String getTruststore()

Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getTruststore.

Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getTruststore.

Returns truststore filename.

Annotations

@Override

getTruststorePassword	back to summary
public String getTruststorePassword() Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getTruststorePassword. Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getTruststorePassword. Returns truststore password. Annotations @Override

getTruststorePassword

back to summary

public String getTruststorePassword()

Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getTruststorePassword.

Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.getTruststorePassword.

Returns truststore password.

Annotations

@Override

getTurnOffChangeSessionIdOnLogin	back to summary
public Boolean getTurnOffChangeSessionIdOnLogin()

isAllowAnyHostname back to summary

public boolean isAllowAnyHostname()

Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.isAllowAnyHostname.

Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.isAllowAnyHostname.

Returns boolean flag whether any hostname verification is done on the server's certificate, true means that verification is not done.

Annotations

@Override

isAlwaysRefreshToken	back to summary
public boolean isAlwaysRefreshToken()

isDisableTrustManager

back to summary

public boolean isDisableTrustManager()

Implements org.keycloak.representations.adapters.config.AdapterHttpClientConfig.isDisableTrustManager.

Doc from org.keycloak.representations.adapters.config.AdapterHttpClientConfig.isDisableTrustManager.

Returns boolean flag whether any trust management and hostname verification is done.

Note

Disabling trust manager is a security hole, so only set this option if you cannot or do not want to verify the identity of the host you are communicating with.

Annotations

@Override

isIgnoreOAuthQueryParameter	back to summary
public boolean isIgnoreOAuthQueryParameter()

isPkce	back to summary
public boolean isPkce()

isRegisterNodeAtStartup	back to summary
public boolean isRegisterNodeAtStartup()

isVerifyTokenAudience	back to summary
public boolean isVerifyTokenAudience()

setAllowAnyHostname	back to summary
public void setAllowAnyHostname(boolean allowAnyHostname)

setAlwaysRefreshToken	back to summary
public void setAlwaysRefreshToken(boolean alwaysRefreshToken)

setClientKeyPassword	back to summary
public void setClientKeyPassword(String clientKeyPassword)

setClientKeystore	back to summary
public void setClientKeystore(String clientKeystore)

setClientKeystorePassword	back to summary
public void setClientKeystorePassword(String clientKeystorePassword)

setConnectionPoolSize	back to summary
public void setConnectionPoolSize(int connectionPoolSize)

setConnectionTimeout	back to summary
public void setConnectionTimeout(long connectionTimeout)

setConnectionTTL	back to summary
public void setConnectionTTL(long connectionTTL)

setDisableTrustManager	back to summary
public void setDisableTrustManager(boolean disableTrustManager)

setIgnoreOAuthQueryParameter	back to summary
public void setIgnoreOAuthQueryParameter(boolean ignoreOAuthQueryParameter)

setMinTimeBetweenJwksRequests	back to summary
public void setMinTimeBetweenJwksRequests(int minTimeBetweenJwksRequests)

setPkce	back to summary
public void setPkce(boolean pkce)

setPolicyEnforcerConfig	back to summary
public void setPolicyEnforcerConfig(PolicyEnforcerConfig policyEnforcerConfig)

setPrincipalAttribute	back to summary
public void setPrincipalAttribute(String principalAttribute)

setProxyUrl	back to summary
public void setProxyUrl(String proxyUrl)

setPublicKeyCacheTtl	back to summary
public void setPublicKeyCacheTtl(int publicKeyCacheTtl)

setRegisterNodeAtStartup	back to summary
public void setRegisterNodeAtStartup(boolean registerNodeAtStartup)

setRegisterNodePeriod	back to summary
public void setRegisterNodePeriod(int registerNodePeriod)

setSocketTimeout	back to summary
public void setSocketTimeout(long socketTimeout)

setTokenCookiePath	back to summary
public void setTokenCookiePath(String tokenCookiePath)

setTokenMinimumTimeToLive	back to summary
public void setTokenMinimumTimeToLive(final int tokenMinimumTimeToLive)

setTokenStore	back to summary
public void setTokenStore(String tokenStore)

setTruststore	back to summary
public void setTruststore(String truststore)

setTruststorePassword	back to summary
public void setTruststorePassword(String truststorePassword)

setTurnOffChangeSessionIdOnLogin	back to summary
public void setTurnOffChangeSessionIdOnLogin(Boolean turnOffChangeSessionIdOnLogin)

setVerifyTokenAudience	back to summary
public void setVerifyTokenAudience(boolean verifyTokenAudience)

public Class AdapterConfig

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail