Module net.shibboleth.utilities.java.support

Package net.shibboleth.utilities.java.support.httpclient

Class ContextHandlingHttpClient

java.lang.Object

org.apache.http.impl.client.CloseableHttpClient

net.shibboleth.utilities.java.support.httpclient.ContextHandlingHttpClient

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.http.client.HttpClient

class ContextHandlingHttpClient
extends org.apache.http.impl.client.CloseableHttpClient

A wrapper implementation of HttpClient which invokes supplied instances of HttpClientContextHandler before and after request execution.

By definition the handlers will only be invoked for the HttpClient execute(...) method variants which take an HttpContext argument.

The order of execution is:

1. Static handlers supplied via the constructor, in original list order
2. Dynamic handlers from the context attribute HttpClientSupport.CONTEXT_KEY_DYNAMIC_CONTEXT_HANDLERS, in original list order
3. the wrapped client's corresponding execute(...) method
4. Dynamic handlers from the context attribute HttpClientSupport.CONTEXT_KEY_DYNAMIC_CONTEXT_HANDLERS, in reverse list order
5. Static handlers supplied via the constructor, in reverse list order

Field Summary

Fields

Modifier and Type	Field	Description
private List<HttpClientContextHandler>	handlers	Optional list of static handlers supplied to this class instance.
private org.apache.http.impl.client.CloseableHttpClient	httpClient	The wrapped client instance.
private org.slf4j.Logger	log	Logger.

Constructor Summary

Constructors

Constructor	Description
ContextHandlingHttpClient(org.apache.http.impl.client.CloseableHttpClient client)	Constructor.
ContextHandlingHttpClient(org.apache.http.impl.client.CloseableHttpClient client, List<HttpClientContextHandler> staticHandlers)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()
protected org.apache.http.client.methods.CloseableHttpResponse	doExecute(org.apache.http.HttpHost target, org.apache.http.HttpRequest request, org.apache.http.protocol.HttpContext context)
org.apache.http.conn.ClientConnectionManager	getConnectionManager()	Deprecated.
org.apache.http.params.HttpParams	getParams()	Deprecated.
private void	invokeAfter(org.apache.http.client.methods.HttpUriRequest request, org.apache.http.client.protocol.HttpClientContext context, Throwable priorError)	Invoke HttpClientContextHandler.invokeAfter(HttpClientContext, HttpUriRequest) for all supplied handlers.
private void	invokeBefore(org.apache.http.client.methods.HttpUriRequest request, org.apache.http.client.protocol.HttpClientContext context)	Invoke HttpClientContextHandler.invokeBefore(HttpClientContext, HttpUriRequest) for supplied handlers.
private void	processErrorsForInvokeAfter(IOException invokeAfterException, Throwable priorError)	Process errors for invokeAfter(HttpUriRequest, HttpClientContext, Throwable).
private IOException	processHandlerErrors(String stage, List<Throwable> errors)	Process the error(s) seen during invokeBefore(HttpUriRequest, HttpClientContext) or invokeAfter(HttpUriRequest, HttpClientContext, Throwable) into a single IOException that will be propagated out of that method.

Methods inherited from class org.apache.http.impl.client.CloseableHttpClient

execute, execute, execute, execute, execute, execute, execute, execute

Methods inherited from class java.lang.Object

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

Field Detail

log

private org.slf4j.Logger log

Logger.

httpClient

@Nonnull
private org.apache.http.impl.client.CloseableHttpClient httpClient

The wrapped client instance.

handlers

@Nonnull
private List<HttpClientContextHandler> handlers

Optional list of static handlers supplied to this class instance.

Constructor Detail

ContextHandlingHttpClient

public ContextHandlingHttpClient(@Nonnull
                                 org.apache.http.impl.client.CloseableHttpClient client)

Constructor.

Parameters:

client - the wrapped client instance

ContextHandlingHttpClient

public ContextHandlingHttpClient(@Nonnull
                                 org.apache.http.impl.client.CloseableHttpClient client,
                                 @Nonnull
                                 List<HttpClientContextHandler> staticHandlers)

Constructor.

Parameters:

client - the wrapped client instance

staticHandlers - the list of static handlers

Method Detail

getParams

@Deprecated
public org.apache.http.params.HttpParams getParams()

Deprecated.

getConnectionManager

@Deprecated
public org.apache.http.conn.ClientConnectionManager getConnectionManager()

Deprecated.

close

public void close()
           throws IOException

Throws:

IOException

doExecute

protected org.apache.http.client.methods.CloseableHttpResponse doExecute(org.apache.http.HttpHost target,
                                                                         org.apache.http.HttpRequest request,
                                                                         org.apache.http.protocol.HttpContext context)
                                                                  throws IOException,
                                                                         org.apache.http.client.ClientProtocolException

Specified by:

doExecute in class org.apache.http.impl.client.CloseableHttpClient

Throws:

IOException

org.apache.http.client.ClientProtocolException

invokeBefore

private void invokeBefore(org.apache.http.client.methods.HttpUriRequest request,
                          org.apache.http.client.protocol.HttpClientContext context)
                   throws IOException

Invoke HttpClientContextHandler.invokeBefore(HttpClientContext, HttpUriRequest) for supplied handlers.

Parameters:

request - the HTTP request

context - the HTTP context

Throws:

IOException - if any handler throws an error

invokeAfter

private void invokeAfter(org.apache.http.client.methods.HttpUriRequest request,
                         org.apache.http.client.protocol.HttpClientContext context,
                         Throwable priorError)
                  throws IOException

Invoke HttpClientContextHandler.invokeAfter(HttpClientContext, HttpUriRequest) for all supplied handlers.

Parameters:

request - the HTTP request

context - the HTTP context

priorError - an error thrown by by either invokeBefore(HttpUriRequest, HttpClientContext) or by HttpClient execute(...).

Throws:

IOException - if any handler throws an error, or if priorError is an IOException. If priorError is a type of unchecked error (RuntimeException or Error) that will be propagated out here as well.

processHandlerErrors

private IOException processHandlerErrors(String stage,
                                         List<Throwable> errors)

Process the error(s) seen during invokeBefore(HttpUriRequest, HttpClientContext) or invokeAfter(HttpUriRequest, HttpClientContext, Throwable) into a single IOException that will be propagated out of that method.

Parameters:

stage - the name of the stage, for reporting purposes

errors - all errors seen during the method execution

Returns:

the single exception to be propagated out, will be null if no errors present

processErrorsForInvokeAfter

private void processErrorsForInvokeAfter(IOException invokeAfterException,
                                         Throwable priorError)
                                  throws IOException

Process errors for invokeAfter(HttpUriRequest, HttpClientContext, Throwable).

Parameters:

invokeAfterException - the exception thrown by invokeAfter handlers, if any

priorError - an error thrown by by either invokeBefore(HttpUriRequest, HttpClientContext) or by HttpClient execute(...), if any.

Throws:

IOException - if invokeAfterException is non-null, or if priorError is an IOException. If priorError is a type of unchecked error (RuntimeException or Error) that will be propagated out here as well.