Uses of Class
org.keycloak.adapters.KeycloakDeployment

Packages that use KeycloakDeployment

Package	Description
org.keycloak.adapters
org.keycloak.adapters.authentication
org.keycloak.adapters.authorization
org.keycloak.adapters.jaas
org.keycloak.adapters.rotation

Uses of KeycloakDeployment in org.keycloak.adapters

Subclasses of KeycloakDeployment in org.keycloak.adapters

Modifier and Type	Class and Description
protected static class	AdapterDeploymentContext.DeploymentDelegate This delegate is used to store temporary, per-request metadata like request resolved URLs.

Fields in org.keycloak.adapters declared as KeycloakDeployment

Modifier and Type	Field and Description
protected KeycloakDeployment	AdapterDeploymentContext.DeploymentDelegate.delegate
protected KeycloakDeployment	RequestAuthenticator.deployment
protected KeycloakDeployment	RefreshableKeycloakSecurityContext.deployment
protected KeycloakDeployment	PreAuthActionsHandler.deployment
protected KeycloakDeployment	OAuthRequestAuthenticator.deployment
protected KeycloakDeployment	KeycloakDeploymentBuilder.deployment
protected KeycloakDeployment	BearerTokenRequestAuthenticator.deployment
protected KeycloakDeployment	AuthenticatedActionsHandler.deployment
protected KeycloakDeployment	AdapterDeploymentContext.deployment

Methods in org.keycloak.adapters that return KeycloakDeployment

Modifier and Type	Method and Description
static KeycloakDeployment	KeycloakDeploymentBuilder.build(AdapterConfig adapterConfig)
static KeycloakDeployment	KeycloakDeploymentBuilder.build(InputStream is)
KeycloakDeployment	RefreshableKeycloakSecurityContext.getDeployment()
protected KeycloakDeployment	KeycloakDeploymentBuilder.internalBuild(AdapterConfig adapterConfig)
KeycloakDeployment	KeycloakConfigResolver.resolve(HttpFacade.Request facade) Resolves the KeycloakDeployment based on the Request
KeycloakDeployment	AdapterDeploymentContext.resolveDeployment(HttpFacade facade) For single-tenant deployments, it complements KeycloakDeployment by resolving a relative Auth Server's URL based on the current request For multi-tenant deployments, defers the resolution of KeycloakDeployment to the KeycloakConfigResolver .
protected KeycloakDeployment	AdapterDeploymentContext.resolveUrls(KeycloakDeployment deployment, HttpFacade facade)

Methods in org.keycloak.adapters with parameters of type KeycloakDeployment

Modifier and Type	Method and Description
static KeycloakPrincipal<RefreshableKeycloakSecurityContext>	AdapterUtils.createPrincipal(KeycloakDeployment deployment, RefreshableKeycloakSecurityContext securityContext)
static KeycloakPrincipal<RefreshableKeycloakSecurityContext>	CookieTokenStore.getPrincipalFromCookie(KeycloakDeployment deployment, HttpFacade facade, AdapterTokenStore tokenStore)
static String	AdapterUtils.getPrincipalName(KeycloakDeployment deployment, AccessToken token)
static AccessTokenResponse	ServerRequest.invokeAccessCodeToToken(KeycloakDeployment deployment, String code, String redirectUri, String sessionId)
static AccessTokenResponse	ServerRequest.invokeAccessCodeToToken(KeycloakDeployment deployment, String code, String redirectUri, String sessionId, String codeVerifier)
static void	ServerRequest.invokeClientManagementRequest(KeycloakDeployment deployment, String host, String endpointUrl)
static void	ServerRequest.invokeLogout(KeycloakDeployment deployment, String refreshToken)
static AccessTokenResponse	ServerRequest.invokeRefresh(KeycloakDeployment deployment, String refreshToken)
static void	ServerRequest.invokeRegisterNode(KeycloakDeployment deployment, String host)
static void	ServerRequest.invokeUnregisterNode(KeycloakDeployment deployment, String host)
void	RefreshableKeycloakSecurityContext.logout(KeycloakDeployment deployment)
static void	CookieTokenStore.removeCookie(KeycloakDeployment deployment, HttpFacade facade)
protected KeycloakDeployment	AdapterDeploymentContext.resolveUrls(KeycloakDeployment deployment, HttpFacade facade)
static <T> T	HttpAdapterUtils.sendJsonHttpRequest(KeycloakDeployment deployment, org.apache.http.client.methods.HttpRequestBase httpRequest, Class<T> clazz)
protected void	NodesRegistrationManagement.sendRegistrationEvent(KeycloakDeployment deployment)
protected boolean	NodesRegistrationManagement.sendUnregistrationEvent(KeycloakDeployment deployment)
void	RefreshableKeycloakSecurityContext.setCurrentRequestInfo(KeycloakDeployment deployment, AdapterTokenStore tokenStore)
static void	CookieTokenStore.setTokenCookie(KeycloakDeployment deployment, HttpFacade facade, RefreshableKeycloakSecurityContext session)
void	NodesRegistrationManagement.tryRegister(KeycloakDeployment resolvedDeployment)

Constructors in org.keycloak.adapters with parameters of type KeycloakDeployment

Constructor and Description
AdapterDeploymentContext(KeycloakDeployment deployment) For single-tenant deployments, this constructor is to be used, as a full KeycloakDeployment is known at deployment time and won't change during the application deployment's life cycle.
AuthenticatedActionsHandler(KeycloakDeployment deployment, OIDCHttpFacade facade)
BasicAuthRequestAuthenticator(KeycloakDeployment deployment)
BearerTokenRequestAuthenticator(KeycloakDeployment deployment)
DeploymentDelegate(KeycloakDeployment delegate)
NodeRegistrationContext(Integer lastRegTime, KeycloakDeployment deployment)
OAuthRequestAuthenticator(RequestAuthenticator requestAuthenticator, HttpFacade facade, KeycloakDeployment deployment, int sslRedirectPort, AdapterSessionStore tokenStore)
QueryParameterTokenRequestAuthenticator(KeycloakDeployment deployment)
RefreshableKeycloakSecurityContext(KeycloakDeployment deployment, AdapterTokenStore tokenStore, String tokenString, AccessToken token, String idTokenString, IDToken idToken, String refreshToken)
RequestAuthenticator(HttpFacade facade, KeycloakDeployment deployment)
RequestAuthenticator(HttpFacade facade, KeycloakDeployment deployment, AdapterTokenStore tokenStore, int sslRedirectPort)

Uses of KeycloakDeployment in org.keycloak.adapters.authentication

Methods in org.keycloak.adapters.authentication with parameters of type KeycloakDeployment

Modifier and Type	Method and Description
static ClientCredentialsProvider	ClientCredentialsProviderUtils.bootstrapClientAuthenticator(KeycloakDeployment deployment)
void	JWTClientSecretCredentialsProvider.init(KeycloakDeployment deployment, Object config)
void	JWTClientCredentialsProvider.init(KeycloakDeployment deployment, Object config)
void	ClientIdAndSecretCredentialsProvider.init(KeycloakDeployment deployment, Object config)
void	ClientCredentialsProvider.init(KeycloakDeployment deployment, Object config) Called by adapter during deployment of your application.
static void	ClientCredentialsProviderUtils.setClientCredentials(KeycloakDeployment deployment, org.apache.http.client.methods.HttpPost post, List<org.apache.http.NameValuePair> formparams) Don't use directly from your JEE apps to avoid HttpClient linkage errors! Instead use the method ClientCredentialsProviderUtils.setClientCredentials(KeycloakDeployment, Map, Map)
void	JWTClientSecretCredentialsProvider.setClientCredentials(KeycloakDeployment deployment, Map<String,String> requestHeaders, Map<String,String> formParams)
void	JWTClientCredentialsProvider.setClientCredentials(KeycloakDeployment deployment, Map<String,String> requestHeaders, Map<String,String> formParams)
void	ClientIdAndSecretCredentialsProvider.setClientCredentials(KeycloakDeployment deployment, Map<String,String> requestHeaders, Map<String,String> formParams)
static void	ClientCredentialsProviderUtils.setClientCredentials(KeycloakDeployment deployment, Map<String,String> requestHeaders, Map<String,String> formparams) Use this method when calling backchannel request directly from your application.
void	ClientCredentialsProvider.setClientCredentials(KeycloakDeployment deployment, Map<String,String> requestHeaders, Map<String,String> formParams) Called every time adapter needs to perform backchannel request

Uses of KeycloakDeployment in org.keycloak.adapters.authorization

Methods in org.keycloak.adapters.authorization that return KeycloakDeployment

Modifier and Type	Method and Description
KeycloakDeployment	PolicyEnforcer.getDeployment()

Constructors in org.keycloak.adapters.authorization with parameters of type KeycloakDeployment

Constructor and Description
PolicyEnforcer(KeycloakDeployment deployment, AdapterConfig adapterConfig)

Uses of KeycloakDeployment in org.keycloak.adapters.jaas

Fields in org.keycloak.adapters.jaas declared as KeycloakDeployment

Modifier and Type	Field and Description
protected KeycloakDeployment	AbstractKeycloakLoginModule.deployment

Methods in org.keycloak.adapters.jaas that return KeycloakDeployment

Modifier and Type	Method and Description
protected KeycloakDeployment	AbstractKeycloakLoginModule.resolveDeployment(String keycloakConfigFile)

Uses of KeycloakDeployment in org.keycloak.adapters.rotation

Methods in org.keycloak.adapters.rotation with parameters of type KeycloakDeployment

Modifier and Type	Method and Description
static <T extends JsonWebToken> TokenVerifier<T>	AdapterTokenVerifier.createVerifier(String tokenString, KeycloakDeployment deployment, boolean withDefaultChecks, Class<T> tokenClass) Creates verifier, initializes it from the KeycloakDeployment and adds the publicKey and some default basic checks (activeness and tokenType).
PublicKey	PublicKeyLocator.getPublicKey(String kid, KeycloakDeployment deployment)
PublicKey	JWKPublicKeyLocator.getPublicKey(String kid, KeycloakDeployment deployment)
PublicKey	HardcodedPublicKeyLocator.getPublicKey(String kid, KeycloakDeployment deployment)
void	PublicKeyLocator.reset(KeycloakDeployment deployment) Reset the state of locator (eg.
void	JWKPublicKeyLocator.reset(KeycloakDeployment deployment)
void	HardcodedPublicKeyLocator.reset(KeycloakDeployment deployment)
static AccessToken	AdapterTokenVerifier.verifyToken(String tokenString, KeycloakDeployment deployment) Verifies bearer token.
static AdapterTokenVerifier.VerifiedTokens	AdapterTokenVerifier.verifyTokens(String accessTokenString, String idTokenString, KeycloakDeployment deployment) Verify access token and ID token.