net.shibboleth.ext.spring.factory

Class HttpClientFactoryBean

java.lang.Object

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

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

net.shibboleth.ext.spring.factory.HttpClientFactoryBean

All Implemented Interfaces:

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

Direct Known Subclasses:

FileCachingHttpClientFactoryBean, InMemoryCachingHttpClientFactoryBean

public class HttpClientFactoryBean
extends AbstractComponentAwareFactoryBean<HttpClient>

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

Field Summary

Fields

Modifier and Type	Field and Description
private net.shibboleth.utilities.java.support.httpclient.HttpClientBuilder	builder Our captive builder.
private long	connectionRequestTimeout Connection request timeout. We need this field to ensure that Spring does the conversion.
private long	connectionTimeout Connection timeout. We need this field to ensure that Spring does the conversion.
private long	socketTimeout Socket timeout. We need this field to ensure that Spring does the conversion.

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

logger

Constructor Summary

Constructors

Constructor and Description
HttpClientFactoryBean() 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.
protected net.shibboleth.utilities.java.support.httpclient.HttpClientBuilder	getHttpClientBuilder() Get the instance of HttpClientBuilder to use.
Class<HttpClient>	getObjectType()
void	setConnectionDisregardTLSCertificate(boolean disregard) Sets whether the responder's SSL/TLS certificate should be ignored.
void	setConnectionProxyHost(String host) Sets the hostname of the default proxy used when making connection.
void	setConnectionProxyPassword(String password) Sets the password used when authenticating to the proxy.
void	setConnectionProxyPort(int port) Sets the port of the default proxy used when making connection.
void	setConnectionProxyUsername(String usename) Sets the username to use when authenticating to the proxy.
void	setConnectionRequestTimeout(long timeout) Sets the maximum length of time in milliseconds to wait for a connection to be returned from the connection manager.
void	setConnectionTimeout(long timeout) Sets the maximum length of time in milliseconds to wait for the connection to be established.
void	setMaxConnectionsPerRoute(int max) Sets the max simultaneous connections per route allowed by the pooling connection manager.
void	setMaxConnectionsTotal(int max) Sets the max total simultaneous connections allowed by the pooling connection manager.
void	setSocketTimeout(long timeout) Sets the maximum period inactivity between two consecutive data packets in milliseconds.
void	setTLSSocketFactory(LayeredConnectionSocketFactory factory) Set the TLS socket factory to use.
void	setUserAgent(String agent) Sets the user agent to be used when talking to the server.

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

Field Detail

builder

private final net.shibboleth.utilities.java.support.httpclient.HttpClientBuilder builder

Our captive builder.

connectionTimeout

@Duration
private long connectionTimeout

Connection timeout.
We need this field to ensure that Spring does the conversion.

connectionRequestTimeout

@Duration
private long connectionRequestTimeout

Connection request timeout.
We need this field to ensure that Spring does the conversion.

socketTimeout

@Duration
private long socketTimeout

Socket timeout.
We need this field to ensure that Spring does the conversion.

Constructor Detail

HttpClientFactoryBean

public HttpClientFactoryBean()

Constructor.

Method Detail

getObjectType

public Class<HttpClient> getObjectType()

Specified by:

getObjectType in interface FactoryBean<HttpClient>

Specified by:

getObjectType in class AbstractFactoryBean<HttpClient>

setMaxConnectionsTotal

public void setMaxConnectionsTotal(int max)

Sets the max total simultaneous connections allowed by the pooling connection manager.

Parameters:

max - the max total connection

setMaxConnectionsPerRoute

public void setMaxConnectionsPerRoute(int max)

Sets the max simultaneous connections per route allowed by the pooling connection manager.

Parameters:

max - the max connections per route

setConnectionTimeout

@Duration
public void setConnectionTimeout(@Duration
                                 long timeout)

Sets the maximum length of time in milliseconds to wait for the connection to be established. A value of less than 1 indicates no timeout.

Parameters:

timeout - maximum length of time in milliseconds to wait for the connection to be established

setConnectionRequestTimeout

@Duration
public void setConnectionRequestTimeout(@Duration
                                        long timeout)

Sets the maximum length of time in milliseconds to wait for a connection to be returned from the connection manager. A value of less than 1 indicates no timeout.

Parameters:

timeout - maximum length of time in milliseconds to wait for a connection from the connection manager

setSocketTimeout

@Duration
public void setSocketTimeout(@Duration
                             long timeout)

Sets the maximum period inactivity between two consecutive data packets in milliseconds. A value of less than 1 indicates no timeout.

Parameters:

timeout - maximum length of time in milliseconds between two consecutive data packets

setTLSSocketFactory

public void setTLSSocketFactory(@Nullable
                       LayeredConnectionSocketFactory factory)

Set the TLS socket factory to use.

Parameters:

factory - the new socket factory, may be null

setConnectionDisregardTLSCertificate

public void setConnectionDisregardTLSCertificate(boolean disregard)

Sets whether the responder's SSL/TLS certificate should be ignored.

Parameters:

disregard - whether the responder's SSL/TLS certificate should be ignored

setConnectionProxyHost

public void setConnectionProxyHost(String host)

Sets the hostname of the default proxy used when making connection. A null indicates no default proxy.

Parameters:

host - hostname of the default proxy used when making connection

setConnectionProxyPort

public void setConnectionProxyPort(int port)

Sets the port of the default proxy used when making connection.

Parameters:

port - port of the default proxy used when making connection; must be greater than 0 and less than 65536

setConnectionProxyUsername

public void setConnectionProxyUsername(String usename)

Sets the username to use when authenticating to the proxy.

Parameters:

usename - username to use when authenticating to the proxy; may be null

setConnectionProxyPassword

public void setConnectionProxyPassword(String password)

Sets the password used when authenticating to the proxy.

Parameters:

password - password used when authenticating to the proxy; may be null

setUserAgent

public void setUserAgent(@Nullable
                String agent)

Sets the user agent to be used when talking to the server. may not be null in which case the default will be used.

Parameters:

agent - what 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.

Returns:

a new builder instance

getHttpClientBuilder

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

Get the instance of HttpClientBuilder to use.

Returns:

the existing builder instance in use

doCreateInstance

protected HttpClient doCreateInstance()
                               throws Exception

Call the parent class to create the instance.

Specified by:

doCreateInstance in class AbstractComponentAwareFactoryBean<HttpClient>

Returns:

the bean.

Throws:

Exception - if needed.