| Table of Contents |
|---|
Overview
The IdP software uses the Apache HttpClient library anywhere more or less anywhere that this functionality is required, which for most deployers is confined to obtaining metadata from remote sources. The necessary settings to control the behavior of the metadata client code can be handled directly in the metadata-providers.xml file in most cases, so this topic is primarily a reference for people who have very advanced needs or are using other components and features that make use of the client.
...
Now you have a bean name you can inject into other components that support an httpClientRef property that will behave differently than the defaults.
Reference
Beans
| Name | Type | Description |
|---|---|---|
shibboleth.NonCachingHttpClient | HttpClientFactoryBean | Factory bean for non-caching HTTP client |
| shibboleth.FileCachingHttpClient | FileCachingHttpClientFactoryBean | Factory bean for file-based-caching HTTP client |
shibboleth.MemoryCachingHttpClient | InMemoryCachingHttpClientFactoryBean | Factory bean for in-memory-caching HTTP client |
| shibboleth.SecurityEnhancedTLSSocketFactory | org.apache.http.conn.socket.LayeredConnectionSocketFactory | |
| shibboleth.SecurityEnhancedTLSSocketFactoryWithClientTLS | org.apache.http.conn.socket.LayeredConnectionSocketFactory |
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| idp.httpclient.useSecurityEnhancedTLSSocketFactory | boolean | false | If true, causes the default clients to be injected with a special socket factory that supports advanced TLS features (requires substantial additional configuration) |
| idp.httpclient.connectionDisregardTLSCertificate | boolean | false | If the previous property is false, this allows the default TLS behavior of the client to ignore the TLS server certificate entirely (use with obvious caution, typically only while testing) |
| idp.httpclient.connectionRequestTimeout | Duration | PT1M | TIme to wait for a connection to be returned from the pool (can be 0 for no imposed value) |
| idp.httpclient.connectionTimeout | Duration | PT1M | TIme to wait for a connection to be established (can be 0 for no imposed value) |
| idp.httpclient.socketTimeout | Duration | PT1M | Time to allow between packets on a connection (can be 0 for no imposed value) |
| idp.httpclient.maxConnectionsTotal | integer | 100 | Caps the number of simultaneous connections created by the pooling connection manager |
| idp.httpclient.maxConnectionsPerRoute | integer | 100 | Caps the number of simultaneous connections per route created by the pooling connection manager |
| idp.httpclient.memorycaching.maxCacheEntries | integer | 50 | Size of the in-memory result cache |
| idp.httpclient.memorycaching.maxCacheEntrySize | long | 1048576 | Largest size to allow for an in-memory cache entry |
| idp.httpclient.filecaching.maxCacheEntries | integer | 100 | Size of the non-disk result cache |
| idp.httpclient.filecaching.maxCacheEntrySize | long | 10485760 | Largest sze to allow for an on-disk cache entry |
| idp.httpclient.filecaching.cacheDirectory | local directory | Location of on-disk cache |