Package org.keycloak.connections.httpclient

Class DefaultHttpClientFactory

java.lang.Object

org.keycloak.connections.httpclient.DefaultHttpClientFactory

All Implemented Interfaces:

HttpClientFactory, ProviderFactory<HttpClientProvider>

public class DefaultHttpClientFactory
extends Object
implements HttpClientFactory

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

The constructed clients can be configured via Keycloaks SPI configuration, e.g. standalone.xml, standalone-ha.xml, domain.xml.

Examples for jboss-cli

 

 /subsystem=keycloak-server/spi=connectionsHttpClient/provider=default:add(enabled=true)
 /subsystem=keycloak-server/spi=connectionsHttpClient/provider=default:write-attribute(name=properties.connection-pool-size,value=128)
 /subsystem=keycloak-server/spi=connectionsHttpClient/provider=default:write-attribute(name=properties.proxy-mappings,value=[".*\\.(google|googleapis)\\.com;http://www-proxy.acme.corp.com:8080",".*\\.acme\\.corp\\.com;NO_PROXY",".*;http://fallback:8080"])
 
 

Author:

Stian Thorgersen

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

order

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. This config is pulled from keycloak_server.json

Specified by:

init in interface ProviderFactory<HttpClientProvider>

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