net.shibboleth.ext.spring.factory

Class FileCachingHttpClientFactoryBean

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<T>

net.shibboleth.ext.spring.factory.AbstractComponentAwareFactoryBean<HttpClient>

net.shibboleth.ext.spring.factory.HttpClientFactoryBean

net.shibboleth.ext.spring.factory.FileCachingHttpClientFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<HttpClient>, InitializingBean

public class FileCachingHttpClientFactoryBean
extends HttpClientFactoryBean
implements DisposableBean

Factory bean to accumulate the parameters into a FileCachingHttpClientBuilder and to then emit a HttpClient.

Field Summary

Fields

Modifier and Type	Field and Description
private List<HttpClient>	clientRefs List of HttpClients produced by this factory, used to invoke their destroy() when this factory instances is destroy()-ed.

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Constructor Summary

Constructors

Constructor and Description
FileCachingHttpClientFactoryBean() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected net.shibboleth.utilities.java.support.httpclient.HttpClientBuilder	createHttpClientBuilder() Create and return the instance of HttpClientBuilder to use.
protected HttpClient	doCreateInstance() Call the parent class to create the instance.
void	setCacheDirectory(String cacheDirectory) Set the cache directory path.
void	setMaxCacheEntries(int maxCacheEntries) Set the maximum number of cached responses.
void	setMaxCacheEntrySize(long maxCacheEntrySize) Set the maximum response body size, in bytes, that will be eligible for caching.

Methods inherited from class net.shibboleth.ext.spring.factory.HttpClientFactoryBean

getHttpClientBuilder, getObjectType, setConnectionDisregardTLSCertificate, setConnectionProxyHost, setConnectionProxyPassword, setConnectionProxyPort, setConnectionProxyUsername, setConnectionRequestTimeout, setConnectionTimeout, setMaxConnectionsPerRoute, setMaxConnectionsTotal, setSocketTimeout, setTLSSocketFactory, setUserAgent

Methods inherited from class net.shibboleth.ext.spring.factory.AbstractComponentAwareFactoryBean

createInstance, destroyInstance

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.DisposableBean

destroy

Field Detail

clientRefs

private List<HttpClient> clientRefs

List of HttpClients produced by this factory, used to invoke their destroy() when this factory instances is destroy()-ed.

Constructor Detail

FileCachingHttpClientFactoryBean

public FileCachingHttpClientFactoryBean()

Constructor.

Method Detail

setCacheDirectory

public void setCacheDirectory(String cacheDirectory)

Set the cache directory path.

Parameters:

cacheDirectory - The cacheDirectory to set.

setMaxCacheEntries

public void setMaxCacheEntries(int maxCacheEntries)

Set the maximum number of cached responses.

Parameters:

maxCacheEntries - The maxCacheEntries to set.

setMaxCacheEntrySize

public void setMaxCacheEntrySize(long maxCacheEntrySize)

Set the maximum response body size, in bytes, that will be eligible for caching.

Parameters:

maxCacheEntrySize - The maxCacheEntrySize to set.

createHttpClientBuilder

protected net.shibboleth.utilities.java.support.httpclient.HttpClientBuilder createHttpClientBuilder()

Create and return the instance of HttpClientBuilder to use. Subclasses may override to build a specialized subclass.

Overrides:

createHttpClientBuilder in class HttpClientFactoryBean

Returns:

a new builder instance

doCreateInstance

protected HttpClient doCreateInstance()
                               throws Exception

Call the parent class to create the instance.

Overrides:

doCreateInstance in class HttpClientFactoryBean

Returns:

the bean.

Throws:

Exception - if needed.