net.shibboleth.utilities.java.support.httpclient

Class FileCachingHttpClientBuilder

java.lang.Object

net.shibboleth.utilities.java.support.httpclient.HttpClientBuilder

net.shibboleth.utilities.java.support.httpclient.FileCachingHttpClientBuilder

public class FileCachingHttpClientBuilder
extends HttpClientBuilder

An HttpClient builder that supports RFC 2616 caching.

Cached content is written to disk. Special care should be taken so that multiple clients do not share a single cache directory unintentionally. This could result senstive data being available in ways it should not be.

When using the single-arg constructor variant to wrap an existing instance of CachingHttpClientBuilder, there are several caveats of which to be aware:

• Several important non-caching-specific caveats are enumerated in this class's superclass HttpClientBuilder.
• Instances of the following which are set as the default instance on the Apache builder will be unconditionally overwritten by this builder when buildClient() is called:
  • CacheConfig

  This is due to the unfortunate fact that the Apache builder does not currently provide accessor methods to obtain the default instances currently set on the builder. Therefore, if you need to set any default cache config parameters which are not exposed by this builder, then you must use the Apache builder directly and may not use this builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileCachingHttpClientBuilder.StorageMaintenanceTask Scheduled task to manage an instance of ManagedHttpCacheStorage.
static class	FileCachingHttpClientBuilder.StorageManagingHttpClient Class which wraps a caching instance of CloseableHttpClient and its associated ManagedHttpCacheStorage, and manages the scheduled maintenance and lifecycle of the latter.

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	cacheDir Directory in which cached content will be stored.
private long	maintentanceTaskInterval Interval at which the storage maintenance task whould run.
private org.apache.http.impl.client.cache.ManagedHttpCacheStorage	managedStorage The current managed storage instance.
private int	maxCacheEntries The maximum number of cached responses.
private long	maxCacheEntrySize The maximum response body size, in bytes, that will be eligible for caching.

Constructor Summary

Constructors

Constructor and Description
FileCachingHttpClientBuilder() Constructor.
FileCachingHttpClientBuilder(org.apache.http.impl.client.cache.CachingHttpClientBuilder builder) Constructor.

Method Summary

Modifier and Type	Method and Description
org.apache.http.client.HttpClient	buildClient() Constructs an HttpClient using the settings of this builder.
protected void	decorateApacheBuilder() Decorate the Apache builder as determined by this builder's parameters.
java.io.File	getCacheDirectory() Gets the directory in which cached content will be stored.
long	getMaintentanceTaskInterval() Get the interval at which the storage maintenance task should run.
int	getMaxCacheEntries() Gets the maximum number of cached responses.
long	getMaxCacheEntrySize() Gets the maximum response body size, in bytes, that will be eligible for caching.
void	setCacheDirectory(java.io.File directory) Sets the directory in which cached content will be stored.
void	setCacheDirectory(java.lang.String directoryPath) Sets the directory in which cached content will be stored.
void	setMaintentanceTaskInterval(long value) Set the interval at which the storage maintenance task should run.
void	setMaxCacheEntries(int maxEntries) Sets the maximum number of cached responses.
void	setMaxCacheEntrySize(long size) Sets the maximum response body size, in bytes, that will be eligible for caching.

Methods inherited from class net.shibboleth.utilities.java.support.httpclient.HttpClientBuilder

getApacheBuilder, getConnectionProxyHost, getConnectionProxyPassword, getConnectionProxyPort, getConnectionProxyUsername, getConnectionTimeout, getHttpContentCharSet, getHttpRequestRetryHandler, getSocketBufferSize, getSocketLocalAddress, getSocketTimeout, getTLSSocketFactory, getUserAgent, isConnectionCloseAfterResponse, isConnectionDisregardTLSCertificate, isConnectionStalecheck, isHttpFollowRedirects, resetDefaults, setConnectionCloseAfterResponse, setConnectionDisregardTLSCertificate, setConnectionProxyHost, setConnectionProxyPassword, setConnectionProxyPort, setConnectionProxyUsername, setConnectionStalecheck, setConnectionTimeout, setHttpContentCharSet, setHttpFollowRedirects, setHttpRequestRetryHandler, setSocketBufferSize, setSocketLocalAddress, setSocketLocalAddress, setSocketTimeout, setTLSSocketFactory, setUserAgent

Methods inherited from class java.lang.Object

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

Field Detail

cacheDir

private java.io.File cacheDir

Directory in which cached content will be stored. Default: System.getProperty("java.io.tmpdir") + File.separator + "wwwcache"

maxCacheEntries

private int maxCacheEntries

The maximum number of cached responses. Default: 100

maxCacheEntrySize

private long maxCacheEntrySize

The maximum response body size, in bytes, that will be eligible for caching. Default: 10485760 (10 megabytes)

maintentanceTaskInterval

@Duration
private long maintentanceTaskInterval

Interval at which the storage maintenance task whould run.

managedStorage

private org.apache.http.impl.client.cache.ManagedHttpCacheStorage managedStorage

The current managed storage instance.

Constructor Detail

FileCachingHttpClientBuilder

public FileCachingHttpClientBuilder()

Constructor.

FileCachingHttpClientBuilder

public FileCachingHttpClientBuilder(@Nonnull
                                    org.apache.http.impl.client.cache.CachingHttpClientBuilder builder)

Constructor.

Parameters:

builder - builder of clients used to fetch data from remote servers

Method Detail

getCacheDirectory

public java.io.File getCacheDirectory()

Gets the directory in which cached content will be stored.

Returns:

directory in which cached content will be stored

setCacheDirectory

public void setCacheDirectory(@Nonnull @NotEmpty
                              java.lang.String directoryPath)

Sets the directory in which cached content will be stored.

Parameters:

directoryPath - filesystem path to the directory

setCacheDirectory

public void setCacheDirectory(@Nonnull
                              java.io.File directory)

Sets the directory in which cached content will be stored.

Parameters:

directory - the directory

getMaxCacheEntries

public int getMaxCacheEntries()

Gets the maximum number of cached responses.

Returns:

maximum number of cached responses

setMaxCacheEntries

public void setMaxCacheEntries(int maxEntries)

Sets the maximum number of cached responses.

Parameters:

maxEntries - maximum number of cached responses, must be greater than zero

getMaxCacheEntrySize

public long getMaxCacheEntrySize()

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

Returns:

maximum response body size that will be eligible for caching

setMaxCacheEntrySize

public void setMaxCacheEntrySize(long size)

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

Parameters:

size - maximum response body size that will be eligible for caching, must be greater than zero

getMaintentanceTaskInterval

public long getMaintentanceTaskInterval()

Get the interval at which the storage maintenance task should run.

Returns:

the maintenance task interval, in milliseconds

setMaintentanceTaskInterval

public void setMaintentanceTaskInterval(long value)

Set the interval at which the storage maintenance task should run.

Parameters:

value - the new maintenance task interval, in milliseconds

decorateApacheBuilder

protected void decorateApacheBuilder()
                              throws java.lang.Exception

Decorate the Apache builder as determined by this builder's parameters. Subclasses will likely add additional decoration.

Overrides:

decorateApacheBuilder in class HttpClientBuilder

Throws:

java.lang.Exception - if there is a problem decorating the Apache builder

buildClient

public org.apache.http.client.HttpClient buildClient()
                                              throws java.lang.Exception

Constructs an HttpClient using the settings of this builder.

Overrides:

buildClient in class HttpClientBuilder

Returns:

the constructed client

Throws:

java.lang.Exception - if there is any problem building the new client instance