Package org.keycloak.adapters
Class KeycloakDeployment
- java.lang.Object
-
- org.keycloak.adapters.KeycloakDeployment
-
- Direct Known Subclasses:
AdapterDeploymentContext.DeploymentDelegate
public class KeycloakDeployment extends Object
- Version:
- $Revision: 1 $
- Author:
- Bill Burke, Brad Culley, John D. Ament
-
-
Field Summary
Fields Modifier and Type Field Description protected String
accountUrl
protected String
adapterStateCookiePath
protected boolean
alwaysRefreshToken
protected String
authServerBaseUrl
protected org.keycloak.common.util.KeycloakUriBuilder
authUrl
protected boolean
autodetectBearerOnly
protected boolean
bearerOnly
protected Callable<org.apache.http.client.HttpClient>
client
protected ClientCredentialsProvider
clientAuthenticator
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
jwksUrl
protected org.keycloak.common.util.KeycloakUriBuilder
logoutUrl
protected int
minTimeBetweenJwksRequests
protected int
notBefore
protected boolean
pkce
protected Callable<PolicyEnforcer>
policyEnforcer
protected String
principalAttribute
protected boolean
publicClient
protected int
publicKeyCacheTtl
protected PublicKeyLocator
publicKeyLocator
protected String
realm
protected String
realmInfoUrl
protected Map<String,String>
redirectRewriteRules
protected boolean
registerNodeAtStartup
protected int
registerNodePeriod
protected String
registerNodeUrl
protected org.keycloak.common.enums.RelativeUrlsUsed
relativeUrls
protected Map<String,Object>
resourceCredentials
protected String
resourceName
protected String
scope
protected org.keycloak.common.enums.SslRequired
sslRequired
protected String
stateCookieName
protected int
tokenMinimumTimeToLive
protected TokenStore
tokenStore
protected String
tokenUrl
protected boolean
turnOffChangeSessionIdOnLogin
protected String
unregisterNodeUrl
protected boolean
useResourceRoleMappings
protected boolean
verifyTokenAudience
-
Constructor Summary
Constructors Constructor Description KeycloakDeployment()
-
Method Summary
-
-
-
Field Detail
-
relativeUrls
protected org.keycloak.common.enums.RelativeUrlsUsed relativeUrls
-
realm
protected String realm
-
publicKeyLocator
protected PublicKeyLocator publicKeyLocator
-
authServerBaseUrl
protected String authServerBaseUrl
-
realmInfoUrl
protected String realmInfoUrl
-
authUrl
protected org.keycloak.common.util.KeycloakUriBuilder authUrl
-
tokenUrl
protected String tokenUrl
-
logoutUrl
protected org.keycloak.common.util.KeycloakUriBuilder logoutUrl
-
accountUrl
protected String accountUrl
-
registerNodeUrl
protected String registerNodeUrl
-
unregisterNodeUrl
protected String unregisterNodeUrl
-
jwksUrl
protected String jwksUrl
-
principalAttribute
protected String principalAttribute
-
resourceName
protected String resourceName
-
bearerOnly
protected boolean bearerOnly
-
autodetectBearerOnly
protected boolean autodetectBearerOnly
-
enableBasicAuth
protected boolean enableBasicAuth
-
publicClient
protected boolean publicClient
-
clientAuthenticator
protected ClientCredentialsProvider clientAuthenticator
-
client
protected Callable<org.apache.http.client.HttpClient> client
-
scope
protected String scope
-
sslRequired
protected org.keycloak.common.enums.SslRequired sslRequired
-
confidentialPort
protected int confidentialPort
-
tokenStore
protected TokenStore tokenStore
-
adapterStateCookiePath
protected String adapterStateCookiePath
-
stateCookieName
protected String stateCookieName
-
useResourceRoleMappings
protected boolean useResourceRoleMappings
-
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
-
policyEnforcer
protected Callable<PolicyEnforcer> policyEnforcer
-
pkce
protected boolean pkce
-
ignoreOAuthQueryParameter
protected boolean ignoreOAuthQueryParameter
-
delegateBearerErrorResponseSending
protected boolean delegateBearerErrorResponseSending
-
verifyTokenAudience
protected boolean verifyTokenAudience
-
-
Method Detail
-
isConfigured
public boolean isConfigured()
-
getResourceName
public String getResourceName()
-
getRealm
public String getRealm()
-
setRealm
public void setRealm(String realm)
-
getPublicKeyLocator
public PublicKeyLocator getPublicKeyLocator()
-
setPublicKeyLocator
public void setPublicKeyLocator(PublicKeyLocator publicKeyLocator)
-
getAuthServerBaseUrl
public String getAuthServerBaseUrl()
-
setAuthServerBaseUrl
public void setAuthServerBaseUrl(AdapterConfig config)
-
resolveUrls
protected void resolveUrls()
URLs are loaded lazily when used. This allows adapter to be deployed prior to Keycloak server starting, and will also allow the adapter to retry loading config for each request until the Keycloak server is ready. In the future we may want to support reloading config at a configurable interval.
-
resolveUrls
protected void resolveUrls(org.keycloak.common.util.KeycloakUriBuilder authUrlBuilder)
-
getOidcConfiguration
protected OIDCConfigurationRepresentation getOidcConfiguration(String discoveryUrl) throws Exception
- Throws:
Exception
-
getRelativeUrls
public org.keycloak.common.enums.RelativeUrlsUsed getRelativeUrls()
-
getRealmInfoUrl
public String getRealmInfoUrl()
-
getAuthUrl
public org.keycloak.common.util.KeycloakUriBuilder getAuthUrl()
-
getTokenUrl
public String getTokenUrl()
-
getLogoutUrl
public org.keycloak.common.util.KeycloakUriBuilder getLogoutUrl()
-
getAccountUrl
public String getAccountUrl()
-
getRegisterNodeUrl
public String getRegisterNodeUrl()
-
getUnregisterNodeUrl
public String getUnregisterNodeUrl()
-
getJwksUrl
public String getJwksUrl()
-
setResourceName
public void setResourceName(String resourceName)
-
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)
-
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 org.keycloak.common.enums.SslRequired getSslRequired()
-
setSslRequired
public void setSslRequired(org.keycloak.common.enums.SslRequired sslRequired)
-
isSSLEnabled
public boolean isSSLEnabled()
-
getConfidentialPort
public int getConfidentialPort()
-
setConfidentialPort
public void setConfidentialPort(int confidentialPort)
-
getTokenStore
public TokenStore getTokenStore()
-
setTokenStore
public void setTokenStore(TokenStore tokenStore)
-
getAdapterStateCookiePath
public String getAdapterStateCookiePath()
-
setAdapterStateCookiePath
public void setAdapterStateCookiePath(String adapterStateCookiePath)
-
getStateCookieName
public String getStateCookieName()
-
setStateCookieName
public void setStateCookieName(String stateCookieName)
-
isUseResourceRoleMappings
public boolean isUseResourceRoleMappings()
-
setUseResourceRoleMappings
public void setUseResourceRoleMappings(boolean useResourceRoleMappings)
-
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)
-
setPolicyEnforcer
public void setPolicyEnforcer(Callable<PolicyEnforcer> policyEnforcer)
-
getPolicyEnforcer
public PolicyEnforcer getPolicyEnforcer()
-
isPkce
public boolean isPkce()
-
setPkce
public void setPkce(boolean pkce)
-
setIgnoreOAuthQueryParameter
public void setIgnoreOAuthQueryParameter(boolean ignoreOAuthQueryParameter)
-
isOAuthQueryParameterEnabled
public boolean isOAuthQueryParameterEnabled()
-
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)
-
getAdapterConfig
public AdapterConfig getAdapterConfig()
-
-