KeycloakDeployment (Red Hat Single Sign-On CD 7 public API)

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 and Description
`protected String`	`accountUrl`
`protected String`	`adapterStateCookiePath`
`protected boolean`	`alwaysRefreshToken`
`protected String`	`authServerBaseUrl`
`protected 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 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 RelativeUrlsUsed`	`relativeUrls`
`protected Map<String,Object>`	`resourceCredentials`
`protected String`	`resourceName`
`protected String`	`scope`
`protected 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 and Description

KeycloakDeployment()

Constructors
Constructor and Description
`KeycloakDeployment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAccountUrl()`
`String`	`getAdapterStateCookiePath()`
`String`	`getAuthServerBaseUrl()`
`KeycloakUriBuilder`	`getAuthUrl()`
`org.apache.http.client.HttpClient`	`getClient()`
`ClientCredentialsProvider`	`getClientAuthenticator()`
`int`	`getConfidentialPort()`
`String`	`getCorsAllowedHeaders()`
`String`	`getCorsAllowedMethods()`
`String`	`getCorsExposedHeaders()`
`int`	`getCorsMaxAge()`
`String`	`getJwksUrl()`
`KeycloakUriBuilder`	`getLogoutUrl()`
`int`	`getMinTimeBetweenJwksRequests()`
`int`	`getNotBefore()`
`PolicyEnforcer`	`getPolicyEnforcer()`
`String`	`getPrincipalAttribute()`
`int`	`getPublicKeyCacheTtl()`
`PublicKeyLocator`	`getPublicKeyLocator()`
`String`	`getRealm()`
`String`	`getRealmInfoUrl()`
`Map<String,String>`	`getRedirectRewriteRules()`
`int`	`getRegisterNodePeriod()`
`String`	`getRegisterNodeUrl()`
`RelativeUrlsUsed`	`getRelativeUrls()`
`Map<String,Object>`	`getResourceCredentials()`
`String`	`getResourceName()`
`String`	`getScope()`
`SslRequired`	`getSslRequired()`
`String`	`getStateCookieName()`
`int`	`getTokenMinimumTimeToLive()`
`TokenStore`	`getTokenStore()`
`String`	`getTokenUrl()`
`String`	`getUnregisterNodeUrl()`
`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`	`isUseResourceRoleMappings()`
`boolean`	`isVerifyTokenAudience()`
`protected void`	`resolveUrls(KeycloakUriBuilder authUrlBuilder)`
`void`	`setAdapterStateCookiePath(String adapterStateCookiePath)`
`void`	`setAlwaysRefreshToken(boolean alwaysRefreshToken)`
`void`	`setAuthServerBaseUrl(AdapterConfig 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`	`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`	`setRealm(String realm)`
`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`	`setScope(String scope)`
`void`	`setSslRequired(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)`

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

Field Detail

relativeUrls

protected RelativeUrlsUsed relativeUrls

realm
```
protected String realm
```

publicKeyLocator

protected PublicKeyLocator publicKeyLocator

authServerBaseUrl
```
protected String authServerBaseUrl
```

realmInfoUrl
```
protected String realmInfoUrl
```

authUrl
```
protected KeycloakUriBuilder authUrl
```

tokenUrl
```
protected String tokenUrl
```

logoutUrl
```
protected 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
```

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 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

redirectRewriteRules

protected Map<String,String> redirectRewriteRules

delegateBearerErrorResponseSending

protected boolean delegateBearerErrorResponseSending

verifyTokenAudience
```
protected boolean verifyTokenAudience
```

Constructor Detail
- KeycloakDeployment
```
public KeycloakDeployment()
```

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(KeycloakUriBuilder authUrlBuilder)

Parameters:: authUrlBuilder - absolute URI

getRelativeUrls

public RelativeUrlsUsed getRelativeUrls()

getRealmInfoUrl
```
public String getRealmInfoUrl()
```

getAuthUrl

public KeycloakUriBuilder getAuthUrl()

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

getLogoutUrl

public 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)

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 SslRequired getSslRequired()
```

setSslRequired

public void setSslRequired(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()

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)

Class KeycloakDeployment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

relativeUrls

realm

publicKeyLocator

authServerBaseUrl

realmInfoUrl

authUrl

tokenUrl

logoutUrl

accountUrl

registerNodeUrl

unregisterNodeUrl

jwksUrl

principalAttribute

resourceName

bearerOnly

autodetectBearerOnly

enableBasicAuth

publicClient

resourceCredentials

clientAuthenticator

client

scope

sslRequired

confidentialPort

tokenStore

adapterStateCookiePath

stateCookieName

useResourceRoleMappings

cors

corsMaxAge

corsAllowedHeaders

corsAllowedMethods

corsExposedHeaders

exposeToken

alwaysRefreshToken

registerNodeAtStartup

registerNodePeriod

turnOffChangeSessionIdOnLogin

notBefore

tokenMinimumTimeToLive

minTimeBetweenJwksRequests

publicKeyCacheTtl

policyEnforcer

pkce

ignoreOAuthQueryParameter

redirectRewriteRules

delegateBearerErrorResponseSending

verifyTokenAudience

Constructor Detail

KeycloakDeployment

Method Detail

isConfigured

getResourceName

getRealm

setRealm

getPublicKeyLocator

setPublicKeyLocator

getAuthServerBaseUrl

setAuthServerBaseUrl

resolveUrls

getRelativeUrls

getRealmInfoUrl

getAuthUrl

getTokenUrl

getLogoutUrl

getAccountUrl

getRegisterNodeUrl

getUnregisterNodeUrl

getJwksUrl

setResourceName

isBearerOnly

setBearerOnly

isAutodetectBearerOnly

setAutodetectBearerOnly