Package org.keycloak.connections.httpclient

Class DefaultHttpClientFactory

java.lang.Object

org.keycloak.connections.httpclient.DefaultHttpClientFactory

All Implemented Interfaces:

HttpClientFactory, EnvironmentDependentProviderFactory, ProviderFactory<HttpClientProvider>

public class DefaultHttpClientFactory
extends Object
implements HttpClientFactory, EnvironmentDependentProviderFactory

The default HttpClientFactory for HttpClientProvider's used by Keycloak for outbound HTTP calls.

Example for Quarkus configuration:

spi-connections-http-client-default-connection-pool-size=10

Author:

Stian Thorgersen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_REDIRECTS
static final String	MAX_CONSUMED_RESPONSE_SIZE

Constructor Summary

Constructors

Constructor	Description
DefaultHttpClientFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
HttpClientProvider	create(KeycloakSession session)
Config.Scope	getConfig()
List<ProviderConfigProperty>	getConfigMetadata()	Returns the metadata for each configuration property supported by this factory.
String	getId()
void	init(Config.Scope config)	Only called once when the factory is first created.
boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
protected HttpClientBuilder	newHttpClientBuilder()	Deprecated. use newHttpClientBuilder(KeycloakSession)
protected HttpClientBuilder	newHttpClientBuilder(KeycloakSession session)
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, order

Field Details

MAX_CONSUMED_RESPONSE_SIZE

public static final String MAX_CONSUMED_RESPONSE_SIZE

See Also:

• Constant Field Values

ALLOW_REDIRECTS

public static final String ALLOW_REDIRECTS

See Also:

• Constant Field Values

Constructor Details

DefaultHttpClientFactory

public DefaultHttpClientFactory()

Method Details

create

public HttpClientProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<HttpClientProvider>

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<HttpClientProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<HttpClientProvider>

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created.

Specified by:

init in interface ProviderFactory<HttpClientProvider>

newHttpClientBuilder

@Deprecated(since="26.6.0")
protected HttpClientBuilder newHttpClientBuilder()

Deprecated.

use newHttpClientBuilder(KeycloakSession)

newHttpClientBuilder

protected HttpClientBuilder newHttpClientBuilder(KeycloakSession session)

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<HttpClientProvider>

getConfigMetadata

public List<ProviderConfigProperty> getConfigMetadata()

Description copied from interface: ProviderFactory

Returns the metadata for each configuration property supported by this factory.

Specified by:

getConfigMetadata in interface ProviderFactory<HttpClientProvider>

Returns:

a list with the metadata for each configuration property supported by this factory

isSupported

public boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.

getConfig

public Config.Scope getConfig()