Package org.keycloak.adapters
Class KeycloakDeployment
java.lang.Object
org.keycloak.adapters.KeycloakDeployment
- Direct Known Subclasses:
AdapterDeploymentContext.DeploymentDelegate
- Version:
- $Revision: 1 $
- Author:
- Bill Burke, Brad Culley, John D. Ament
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
protected String
protected boolean
protected String
protected org.keycloak.common.util.KeycloakUriBuilder
protected boolean
protected boolean
protected Callable<org.apache.http.client.HttpClient>
protected ClientCredentialsProvider
protected int
protected boolean
protected String
protected String
protected String
protected int
protected boolean
protected boolean
protected boolean
protected boolean
protected String
protected org.keycloak.common.util.KeycloakUriBuilder
protected int
protected int
protected boolean
protected Callable<PolicyEnforcer>
protected String
protected boolean
protected int
protected PublicKeyLocator
protected String
protected String
protected boolean
protected int
protected String
protected org.keycloak.common.enums.RelativeUrlsUsed
protected String
protected String
protected org.keycloak.common.enums.SslRequired
protected String
protected int
protected TokenStore
protected String
protected boolean
protected String
protected boolean
protected boolean
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionorg.keycloak.common.util.KeycloakUriBuilder
org.apache.http.client.HttpClient
int
int
org.keycloak.common.util.KeycloakUriBuilder
int
int
protected OIDCConfigurationRepresentation
getOidcConfiguration
(String discoveryUrl) int
getRealm()
int
org.keycloak.common.enums.RelativeUrlsUsed
getScope()
org.keycloak.common.enums.SslRequired
int
boolean
boolean
boolean
boolean
boolean
isCors()
boolean
boolean
boolean
boolean
boolean
isPkce()
boolean
boolean
boolean
boolean
boolean
boolean
protected void
URLs are loaded lazily when used.protected void
resolveUrls
(org.keycloak.common.util.KeycloakUriBuilder authUrlBuilder) void
setAdapterStateCookiePath
(String adapterStateCookiePath) void
setAlwaysRefreshToken
(boolean alwaysRefreshToken) void
setAuthServerBaseUrl
(AdapterConfig config) void
setAutodetectBearerOnly
(boolean autodetectBearerOnly) void
setBearerOnly
(boolean bearerOnly) void
void
setClient
(org.apache.http.client.HttpClient client) void
setClientAuthenticator
(ClientCredentialsProvider clientAuthenticator) 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
setPkce
(boolean pkce) void
setPolicyEnforcer
(Callable<PolicyEnforcer> policyEnforcer) void
setPrincipalAttribute
(String principalAttribute) void
setPublicClient
(boolean publicClient) void
setPublicKeyCacheTtl
(int publicKeyCacheTtl) void
setPublicKeyLocator
(PublicKeyLocator publicKeyLocator) void
void
setRegisterNodeAtStartup
(boolean registerNodeAtStartup) void
setRegisterNodePeriod
(int registerNodePeriod) void
setResourceCredentials
(Map<String, Object> resourceCredentials) void
setResourceName
(String resourceName) void
setRewriteRedirectRules
(Map<String, String> redirectRewriteRules) void
void
setSslRequired
(org.keycloak.common.enums.SslRequired sslRequired) void
setStateCookieName
(String stateCookieName) void
setTokenMinimumTimeToLive
(int tokenMinimumTimeToLive) void
setTokenStore
(TokenStore tokenStore) void
setTurnOffChangeSessionIdOnLogin
(boolean turnOffChangeSessionIdOnLogin) void
setUseResourceRoleMappings
(boolean useResourceRoleMappings) void
setVerifyTokenAudience
(boolean verifyTokenAudience) void
updateNotBefore
(int notBefore)
-
Field Details
-
relativeUrls
protected org.keycloak.common.enums.RelativeUrlsUsed relativeUrls -
realm
-
publicKeyLocator
-
authServerBaseUrl
-
realmInfoUrl
-
authUrl
protected org.keycloak.common.util.KeycloakUriBuilder authUrl -
tokenUrl
-
logoutUrl
protected org.keycloak.common.util.KeycloakUriBuilder logoutUrl -
accountUrl
-
registerNodeUrl
-
unregisterNodeUrl
-
jwksUrl
-
principalAttribute
-
resourceName
-
bearerOnly
protected boolean bearerOnly -
autodetectBearerOnly
protected boolean autodetectBearerOnly -
enableBasicAuth
protected boolean enableBasicAuth -
publicClient
protected boolean publicClient -
resourceCredentials
-
clientAuthenticator
-
client
-
scope
-
sslRequired
protected org.keycloak.common.enums.SslRequired sslRequired -
confidentialPort
protected int confidentialPort -
tokenStore
-
adapterStateCookiePath
-
stateCookieName
-
useResourceRoleMappings
protected boolean useResourceRoleMappings -
cors
protected boolean cors -
corsMaxAge
protected int corsMaxAge -
corsAllowedHeaders
-
corsAllowedMethods
-
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
-
pkce
protected boolean pkce -
ignoreOAuthQueryParameter
protected boolean ignoreOAuthQueryParameter -
redirectRewriteRules
-
delegateBearerErrorResponseSending
protected boolean delegateBearerErrorResponseSending -
verifyTokenAudience
protected boolean verifyTokenAudience
-
-
Constructor Details
-
KeycloakDeployment
public KeycloakDeployment()
-
-
Method Details
-
isConfigured
public boolean isConfigured() -
getResourceName
-
getRealm
-
setRealm
-
getPublicKeyLocator
-
setPublicKeyLocator
-
getAuthServerBaseUrl
-
setAuthServerBaseUrl
-
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
-
getAuthUrl
public org.keycloak.common.util.KeycloakUriBuilder getAuthUrl() -
getTokenUrl
-
getLogoutUrl
public org.keycloak.common.util.KeycloakUriBuilder getLogoutUrl() -
getAccountUrl
-
getRegisterNodeUrl
-
getUnregisterNodeUrl
-
getJwksUrl
-
setResourceName
-
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
-
setResourceCredentials
-
getClientAuthenticator
-
setClientAuthenticator
-
getClient
public org.apache.http.client.HttpClient getClient() -
setClient
public void setClient(org.apache.http.client.HttpClient client) -
getScope
-
setScope
-
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
-
setTokenStore
-
getAdapterStateCookiePath
-
setAdapterStateCookiePath
-
getStateCookieName
-
setStateCookieName
-
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
-
setCorsAllowedHeaders
-
getCorsAllowedMethods
-
setCorsAllowedMethods
-
getCorsExposedHeaders
-
setCorsExposedHeaders
-
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
-
setPrincipalAttribute
-
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
-
getPolicyEnforcer
-
isPkce
public boolean isPkce() -
setPkce
public void setPkce(boolean pkce) -
setIgnoreOAuthQueryParameter
public void setIgnoreOAuthQueryParameter(boolean ignoreOAuthQueryParameter) -
isOAuthQueryParameterEnabled
public boolean isOAuthQueryParameterEnabled() -
getRedirectRewriteRules
-
setRewriteRedirectRules
-
isDelegateBearerErrorResponseSending
public boolean isDelegateBearerErrorResponseSending() -
setDelegateBearerErrorResponseSending
public void setDelegateBearerErrorResponseSending(boolean delegateBearerErrorResponseSending) -
isVerifyTokenAudience
public boolean isVerifyTokenAudience() -
setVerifyTokenAudience
public void setVerifyTokenAudience(boolean verifyTokenAudience) -
setClient
-
getAdapterConfig
-