AdapterDeploymentContext.DeploymentDelegate (Red Hat Single Sign-On CD 7 public API)

java.lang.Object
- org.keycloak.adapters.KeycloakDeployment
- - org.keycloak.adapters.AdapterDeploymentContext.DeploymentDelegate

Enclosing class:

AdapterDeploymentContext
```
protected static class AdapterDeploymentContext.DeploymentDelegate
extends KeycloakDeployment
```
This delegate is used to store temporary, per-request metadata like request resolved URLs. Ever method is delegated except URL get methods and isConfigured()

Field Summary

Fields
Modifier and Type Field and Description

protected KeycloakDeployment delegate
- Fields inherited from class org.keycloak.adapters.KeycloakDeployment
  accountUrl, adapterStateCookiePath, alwaysRefreshToken, authServerBaseUrl, authUrl, autodetectBearerOnly, bearerOnly, client, clientAuthenticator, confidentialPort, cors, corsAllowedHeaders, corsAllowedMethods, corsExposedHeaders, corsMaxAge, delegateBearerErrorResponseSending, enableBasicAuth, exposeToken, ignoreOAuthQueryParameter, jwksUrl, logoutUrl, minTimeBetweenJwksRequests, notBefore, pkce, policyEnforcer, principalAttribute, publicClient, publicKeyCacheTtl, publicKeyLocator, realm, realmInfoUrl, redirectRewriteRules, registerNodeAtStartup, registerNodePeriod, registerNodeUrl, relativeUrls, resourceCredentials, resourceName, scope, sslRequired, stateCookieName, tokenMinimumTimeToLive, tokenStore, tokenUrl, turnOffChangeSessionIdOnLogin, unregisterNodeUrl, useResourceRoleMappings, verifyTokenAudience

Fields
Modifier and Type	Field and Description
`protected KeycloakDeployment`	`delegate`

Constructor Summary

Constructors
Constructor and Description

DeploymentDelegate(KeycloakDeployment delegate)

Constructors
Constructor and Description
`DeploymentDelegate(KeycloakDeployment delegate)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAccountUrl()`
`String`	`getAdapterStateCookiePath()`
`org.apache.http.client.HttpClient`	`getClient()`
`ClientCredentialsProvider`	`getClientAuthenticator()`
`int`	`getConfidentialPort()`
`String`	`getCorsAllowedHeaders()`
`String`	`getCorsAllowedMethods()`
`int`	`getCorsMaxAge()`
`String`	`getJwksUrl()`
`KeycloakUriBuilder`	`getLogoutUrl()`
`int`	`getMinTimeBetweenJwksRequests()`
`int`	`getNotBefore()`
`PolicyEnforcer`	`getPolicyEnforcer()`
`String`	`getPrincipalAttribute()`
`int`	`getPublicKeyCacheTtl()`
`PublicKeyLocator`	`getPublicKeyLocator()`
`String`	`getRealm()`
`String`	`getRealmInfoUrl()`
`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`	`isCors()`
`boolean`	`isEnableBasicAuth()`
`boolean`	`isExposeToken()`
`boolean`	`isPublicClient()`
`boolean`	`isRegisterNodeAtStartup()`
`boolean`	`isTurnOffChangeSessionIdOnLogin()`
`boolean`	`isUseResourceRoleMappings()`
`boolean`	`isVerifyTokenAudience()`
`void`	`setAdapterStateCookiePath(String adapterStateCookiePath)`
`void`	`setAlwaysRefreshToken(boolean alwaysRefreshToken)`
`void`	`setAuthServerBaseUrl(String authServerBaseUrl)`
`void`	`setAutodetectBearerOnly(boolean autodetectBearerOnly)`
`void`	`setBearerOnly(boolean bearerOnly)`
`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`	`setCorsMaxAge(int corsMaxAge)`
`void`	`setEnableBasicAuth(boolean enableBasicAuth)`
`void`	`setExposeToken(boolean exposeToken)`
`void`	`setMinTimeBetweenJwksRequests(int minTimeBetweenJwksRequests)`
`void`	`setNotBefore(int notBefore)`
`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`	`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 org.keycloak.adapters.KeycloakDeployment
getAuthServerBaseUrl, getAuthUrl, getCorsExposedHeaders, getRedirectRewriteRules, isConfigured, isDelegateBearerErrorResponseSending, isOAuthQueryParameterEnabled, isPkce, isSSLEnabled, resolveUrls, setAuthServerBaseUrl, setClient, setCorsExposedHeaders, setDelegateBearerErrorResponseSending, setIgnoreOAuthQueryParameter, setPkce, setRewriteRedirectRules

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

- Field Detail
  - delegate
```
protected KeycloakDeployment delegate
```
- Constructor Detail
  - DeploymentDelegate
```
public DeploymentDelegate(KeycloakDeployment delegate)
```
- Method Detail
  - setAuthServerBaseUrl
```
public void setAuthServerBaseUrl(String authServerBaseUrl)
```
  - getRelativeUrls
```
public RelativeUrlsUsed getRelativeUrls()
```
    Overrides:
    
    getRelativeUrls in class KeycloakDeployment
  - getRealmInfoUrl
```
public String getRealmInfoUrl()
```
    Overrides:
    
    getRealmInfoUrl in class KeycloakDeployment
  - getTokenUrl
```
public String getTokenUrl()
```
    Overrides:
    
    getTokenUrl in class KeycloakDeployment
  - getLogoutUrl
```
public KeycloakUriBuilder getLogoutUrl()
```
    Overrides:
    
    getLogoutUrl in class KeycloakDeployment
  - getAccountUrl
```
public String getAccountUrl()
```
    Overrides:
    
    getAccountUrl in class KeycloakDeployment
  - getRegisterNodeUrl
```
public String getRegisterNodeUrl()
```
    Overrides:
    
    getRegisterNodeUrl in class KeycloakDeployment
  - getUnregisterNodeUrl
```
public String getUnregisterNodeUrl()
```
    Overrides:
    
    getUnregisterNodeUrl in class KeycloakDeployment
  - getJwksUrl
```
public String getJwksUrl()
```
    Overrides:
    
    getJwksUrl in class KeycloakDeployment
  - getResourceName
```
public String getResourceName()
```
    Overrides:
    
    getResourceName in class KeycloakDeployment
  - getRealm
```
public String getRealm()
```
    Overrides:
    
    getRealm in class KeycloakDeployment
  - setRealm
```
public void setRealm(String realm)
```
    Overrides:
    
    setRealm in class KeycloakDeployment
  - setPublicKeyLocator
```
public void setPublicKeyLocator(PublicKeyLocator publicKeyLocator)
```
    Overrides:
    
    setPublicKeyLocator in class KeycloakDeployment
  - getPublicKeyLocator
```
public PublicKeyLocator getPublicKeyLocator()
```
    Overrides:
    
    getPublicKeyLocator in class KeycloakDeployment
  - setResourceName
```
public void setResourceName(String resourceName)
```
    Overrides:
    
    setResourceName in class KeycloakDeployment
  - isBearerOnly
```
public boolean isBearerOnly()
```
    Overrides:
    
    isBearerOnly in class KeycloakDeployment
  - setBearerOnly
```
public void setBearerOnly(boolean bearerOnly)
```
    Overrides:
    
    setBearerOnly in class KeycloakDeployment
  - isAutodetectBearerOnly
```
public boolean isAutodetectBearerOnly()
```
    Overrides:
    
    isAutodetectBearerOnly in class KeycloakDeployment
  - setAutodetectBearerOnly
```
public void setAutodetectBearerOnly(boolean autodetectBearerOnly)
```
    Overrides:
    
    setAutodetectBearerOnly in class KeycloakDeployment
  - isEnableBasicAuth
```
public boolean isEnableBasicAuth()
```
    Overrides:
    
    isEnableBasicAuth in class KeycloakDeployment
  - setEnableBasicAuth
```
public void setEnableBasicAuth(boolean enableBasicAuth)
```
    Overrides:
    
    setEnableBasicAuth in class KeycloakDeployment
  - isPublicClient
```
public boolean isPublicClient()
```
    Overrides:
    
    isPublicClient in class KeycloakDeployment
  - setPublicClient
```
public void setPublicClient(boolean publicClient)
```
    Overrides:
    
    setPublicClient in class KeycloakDeployment
  - getResourceCredentials
```
public Map<String,Object> getResourceCredentials()
```
    Overrides:
    
    getResourceCredentials in class KeycloakDeployment
  - setResourceCredentials
```
public void setResourceCredentials(Map<String,Object> resourceCredentials)
```
    Overrides:
    
    setResourceCredentials in class KeycloakDeployment
  - setClientAuthenticator
```
public void setClientAuthenticator(ClientCredentialsProvider clientAuthenticator)
```
    Overrides:
    
    setClientAuthenticator in class KeycloakDeployment
  - getClientAuthenticator
```
public ClientCredentialsProvider getClientAuthenticator()
```
    Overrides:
    
    getClientAuthenticator in class KeycloakDeployment
  - getClient
```
public org.apache.http.client.HttpClient getClient()
```
    Overrides:
    
    getClient in class KeycloakDeployment
  - setClient
```
public void setClient(org.apache.http.client.HttpClient client)
```
    Overrides:
    
    setClient in class KeycloakDeployment
  - getScope
```
public String getScope()
```
    Overrides:
    
    getScope in class KeycloakDeployment
  - setScope
```
public void setScope(String scope)
```
    Overrides:
    
    setScope in class KeycloakDeployment
  - getSslRequired
```
public SslRequired getSslRequired()
```
    Overrides:
    
    getSslRequired in class KeycloakDeployment
  - setSslRequired
```
public void setSslRequired(SslRequired sslRequired)
```
    Overrides:
    
    setSslRequired in class KeycloakDeployment
  - getConfidentialPort
```
public int getConfidentialPort()
```
    Overrides:
    
    getConfidentialPort in class KeycloakDeployment
  - setConfidentialPort
```
public void setConfidentialPort(int confidentialPort)
```
    Overrides:
    
    setConfidentialPort in class KeycloakDeployment
  - getTokenStore
```
public TokenStore getTokenStore()
```
    Overrides:
    
    getTokenStore in class KeycloakDeployment
  - setTokenStore
```
public void setTokenStore(TokenStore tokenStore)
```
    Overrides:
    
    setTokenStore in class KeycloakDeployment
  - getAdapterStateCookiePath
```
public String getAdapterStateCookiePath()
```
    Overrides:
    
    getAdapterStateCookiePath in class KeycloakDeployment
  - setAdapterStateCookiePath
```
public void setAdapterStateCookiePath(String adapterStateCookiePath)
```
    Overrides:
    
    setAdapterStateCookiePath in class KeycloakDeployment
  - getStateCookieName
```
public String getStateCookieName()
```
    Overrides:
    
    getStateCookieName in class KeycloakDeployment
  - setStateCookieName
```
public void setStateCookieName(String stateCookieName)
```
    Overrides:
    
    setStateCookieName in class KeycloakDeployment
  - isUseResourceRoleMappings
```
public boolean isUseResourceRoleMappings()
```
    Overrides:
    
    isUseResourceRoleMappings in class KeycloakDeployment
  - setUseResourceRoleMappings
```
public void setUseResourceRoleMappings(boolean useResourceRoleMappings)
```
    Overrides:
    
    setUseResourceRoleMappings in class KeycloakDeployment
  - isCors
```
public boolean isCors()
```
    Overrides:
    
    isCors in class KeycloakDeployment
  - setCors
```
public void setCors(boolean cors)
```
    Overrides:
    
    setCors in class KeycloakDeployment
  - getCorsMaxAge
```
public int getCorsMaxAge()
```
    Overrides:
    
    getCorsMaxAge in class KeycloakDeployment
  - setCorsMaxAge
```
public void setCorsMaxAge(int corsMaxAge)
```
    Overrides:
    
    setCorsMaxAge in class KeycloakDeployment
  - getCorsAllowedHeaders
```
public String getCorsAllowedHeaders()
```
    Overrides:
    
    getCorsAllowedHeaders in class KeycloakDeployment
  - setNotBefore
```
public void setNotBefore(int notBefore)
```
    Overrides:
    
    setNotBefore in class KeycloakDeployment
  - getNotBefore
```
public int getNotBefore()
```
    Overrides:
    
    getNotBefore in class KeycloakDeployment
  - updateNotBefore
```
public void updateNotBefore(int notBefore)
```
    Overrides:
    
    updateNotBefore in class KeycloakDeployment
  - setExposeToken
```
public void setExposeToken(boolean exposeToken)
```
    Overrides:
    
    setExposeToken in class KeycloakDeployment
  - isExposeToken
```
public boolean isExposeToken()
```
    Overrides:
    
    isExposeToken in class KeycloakDeployment
  - setCorsAllowedMethods
```
public void setCorsAllowedMethods(String corsAllowedMethods)
```
    Overrides:
    
    setCorsAllowedMethods in class KeycloakDeployment
  - getCorsAllowedMethods
```
public String getCorsAllowedMethods()
```
    Overrides:
    
    getCorsAllowedMethods in class KeycloakDeployment
  - setCorsAllowedHeaders
```
public void setCorsAllowedHeaders(String corsAllowedHeaders)
```
    Overrides:
    
    setCorsAllowedHeaders in class KeycloakDeployment
  - isAlwaysRefreshToken
```
public boolean isAlwaysRefreshToken()
```
    Overrides:
    
    isAlwaysRefreshToken in class KeycloakDeployment
  - setAlwaysRefreshToken
```
public void setAlwaysRefreshToken(boolean alwaysRefreshToken)
```
    Overrides:
    
    setAlwaysRefreshToken in class KeycloakDeployment
  - getRegisterNodePeriod
```
public int getRegisterNodePeriod()
```
    Overrides:
    
    getRegisterNodePeriod in class KeycloakDeployment
  - setRegisterNodePeriod
```
public void setRegisterNodePeriod(int registerNodePeriod)
```
    Overrides:
    
    setRegisterNodePeriod in class KeycloakDeployment
  - setRegisterNodeAtStartup
```
public void setRegisterNodeAtStartup(boolean registerNodeAtStartup)
```
    Overrides:
    
    setRegisterNodeAtStartup in class KeycloakDeployment
  - isRegisterNodeAtStartup
```
public boolean isRegisterNodeAtStartup()
```
    Overrides:
    
    isRegisterNodeAtStartup in class KeycloakDeployment
  - getPrincipalAttribute
```
public String getPrincipalAttribute()
```
    Overrides:
    
    getPrincipalAttribute in class KeycloakDeployment
  - setPrincipalAttribute
```
public void setPrincipalAttribute(String principalAttribute)
```
    Overrides:
    
    setPrincipalAttribute in class KeycloakDeployment
  - isTurnOffChangeSessionIdOnLogin
```
public boolean isTurnOffChangeSessionIdOnLogin()
```
    Overrides:
    
    isTurnOffChangeSessionIdOnLogin in class KeycloakDeployment
  - setTurnOffChangeSessionIdOnLogin
```
public void setTurnOffChangeSessionIdOnLogin(boolean turnOffChangeSessionIdOnLogin)
```
    Overrides:
    
    setTurnOffChangeSessionIdOnLogin in class KeycloakDeployment
  - getTokenMinimumTimeToLive
```
public int getTokenMinimumTimeToLive()
```
    Overrides:
    
    getTokenMinimumTimeToLive in class KeycloakDeployment
  - setTokenMinimumTimeToLive
```
public void setTokenMinimumTimeToLive(int tokenMinimumTimeToLive)
```
    Overrides:
    
    setTokenMinimumTimeToLive in class KeycloakDeployment
  - getPolicyEnforcer
```
public PolicyEnforcer getPolicyEnforcer()
```
    Overrides:
    
    getPolicyEnforcer in class KeycloakDeployment
  - setPolicyEnforcer
```
public void setPolicyEnforcer(Callable<PolicyEnforcer> policyEnforcer)
```
    Overrides:
    
    setPolicyEnforcer in class KeycloakDeployment
  - setMinTimeBetweenJwksRequests
```
public void setMinTimeBetweenJwksRequests(int minTimeBetweenJwksRequests)
```
    Overrides:
    
    setMinTimeBetweenJwksRequests in class KeycloakDeployment
  - getMinTimeBetweenJwksRequests
```
public int getMinTimeBetweenJwksRequests()
```
    Overrides:
    
    getMinTimeBetweenJwksRequests in class KeycloakDeployment
  - getPublicKeyCacheTtl
```
public int getPublicKeyCacheTtl()
```
    Overrides:
    
    getPublicKeyCacheTtl in class KeycloakDeployment
  - setPublicKeyCacheTtl
```
public void setPublicKeyCacheTtl(int publicKeyCacheTtl)
```
    Overrides:
    
    setPublicKeyCacheTtl in class KeycloakDeployment
  - isVerifyTokenAudience
```
public boolean isVerifyTokenAudience()
```
    Overrides:
    
    isVerifyTokenAudience in class KeycloakDeployment
  - setVerifyTokenAudience
```
public void setVerifyTokenAudience(boolean verifyTokenAudience)
```
    Overrides:
    
    setVerifyTokenAudience in class KeycloakDeployment

Class AdapterDeploymentContext.DeploymentDelegate

Field Summary

Fields inherited from class org.keycloak.adapters.KeycloakDeployment

Constructor Summary

Method Summary

Methods inherited from class org.keycloak.adapters.KeycloakDeployment

Methods inherited from class java.lang.Object

Field Detail

delegate

Constructor Detail

DeploymentDelegate

Method Detail

setAuthServerBaseUrl

getRelativeUrls

getRealmInfoUrl

getTokenUrl

getLogoutUrl

getAccountUrl

getRegisterNodeUrl

getUnregisterNodeUrl

getJwksUrl

getResourceName

getRealm

setRealm

setPublicKeyLocator

getPublicKeyLocator

setResourceName

isBearerOnly

setBearerOnly

isAutodetectBearerOnly

setAutodetectBearerOnly

isEnableBasicAuth

setEnableBasicAuth

isPublicClient

setPublicClient

getResourceCredentials

setResourceCredentials

setClientAuthenticator

getClientAuthenticator

getClient

setClient

getScope

setScope

getSslRequired

setSslRequired

getConfidentialPort

setConfidentialPort

getTokenStore

setTokenStore

getAdapterStateCookiePath

setAdapterStateCookiePath

getStateCookieName

setStateCookieName

isUseResourceRoleMappings

setUseResourceRoleMappings

isCors

setCors

getCorsMaxAge

setCorsMaxAge

getCorsAllowedHeaders

setNotBefore

getNotBefore

updateNotBefore

setExposeToken

isExposeToken

setCorsAllowedMethods

getCorsAllowedMethods

setCorsAllowedHeaders

isAlwaysRefreshToken

setAlwaysRefreshToken

getRegisterNodePeriod

setRegisterNodePeriod

setRegisterNodeAtStartup

isRegisterNodeAtStartup

getPrincipalAttribute

setPrincipalAttribute

isTurnOffChangeSessionIdOnLogin

setTurnOffChangeSessionIdOnLogin

getTokenMinimumTimeToLive

setTokenMinimumTimeToLive