org.openhubframework.openhub.core.common.ws.transport.http

Class CloseableHttpComponentsMessageSender

java.lang.Object

org.springframework.ws.transport.http.AbstractHttpWebServiceMessageSender

org.springframework.ws.transport.http.HttpComponentsMessageSender

org.openhubframework.openhub.core.common.ws.transport.http.CloseableHttpComponentsMessageSender

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.ws.transport.WebServiceMessageSender

Direct Known Subclasses:

NtlmCloseableHttpComponentsMessageSender

public class CloseableHttpComponentsMessageSender
extends org.springframework.ws.transport.http.HttpComponentsMessageSender

WebServiceMessageSender implementation that uses Apache HttpClient (CloseableHttpClient) to execute POST requests.

Allows to use a pre-configured HttpClient instance, potentially with authentication, HTTP connection pooling, etc. Authentication can also be set by injecting a Credentials instance (such as the UsernamePasswordCredentials). Out of box contains CloseableHttpComponentsMessageSender.RemoveSoapHeadersInterceptor.

Author:

Tomas Hanus

See Also:

HttpClient, CloseableHttpClient, PoolingHttpClientConnectionManager, UsernamePasswordCredentials

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloseableHttpComponentsMessageSender.PreemptiveAuthInterceptor HttpClient HttpRequestInterceptor implementation that configures the Apache Http Client for preemptive authentication.
static class	CloseableHttpComponentsMessageSender.RemoveSoapHeadersInterceptor HttpClient HttpRequestInterceptor implementation that removes Content-Length and Transfer-Encoding headers from the request.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	MACHINE_NAME

Fields inherited from class org.springframework.ws.transport.http.AbstractHttpWebServiceMessageSender

logger

Constructor Summary

Constructors

Constructor and Description
CloseableHttpComponentsMessageSender() Create a new instance of the HttpClientMessageSender with a default HttpClient that uses a default PoolingHttpClientConnectionManager.
CloseableHttpComponentsMessageSender(boolean usePreemptiveAuth) Create a new instance of the HttpClientMessageSender with a default HttpClient that uses a default PoolingHttpClientConnectionManager.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	closeIdleConnections(long timeout) Closes connections that have been idle for at least the given amount of time.
protected org.apache.http.protocol.HttpContext	createContext(URI uri) Template method that allows for creation of a HttpContext for the given uri.
void	destroy()
protected org.apache.http.impl.client.HttpClientBuilder	getClientBuilder() Gets the HttpClientBuilder.
org.apache.http.pool.ConnPoolControl	getConnPoolControl() Gets the ConnPoolControl.
org.apache.http.client.HttpClient	getHttpClient() Returns the HttpClient used by this message sender.
void	setAuthScope(org.apache.http.auth.AuthScope authScope) Sets the authentication scope to be used.
void	setConnectionTimeout(int timeout) Sets the timeout until a connection is established.
void	setCredentials(org.apache.http.auth.Credentials credentials) Sets the credentials to be used.
protected void	setCredentialsProvider(org.apache.http.client.CredentialsProvider credentialsProvider) Sets the implementation of CredentialsProvider.
void	setDefaultMaxPerHost(int defaultMaxPerHost) Sets the default maximum number of connections allowed per host for the underlying HttpClient.
void	setMaxConnectionsPerHost(Map<String,String> maxConnectionsPerHost) Sets the maximum number of connections per host for the underlying HttpClient.
void	setMaxTotalConnections(int maxTotalConnections) Sets the maximum number of connections allowed for the underlying HttpClient.
void	setReadTimeout(int timeout) Set the socket read timeout for the underlying HttpClient.

Methods inherited from class org.springframework.ws.transport.http.HttpComponentsMessageSender

createConnection, setHttpClient

Methods inherited from class org.springframework.ws.transport.http.AbstractHttpWebServiceMessageSender

isAcceptGzipEncoding, setAcceptGzipEncoding, supports

Methods inherited from class java.lang.Object

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

Field Detail

MACHINE_NAME

protected static final String MACHINE_NAME

See Also:

Constant Field Values

Constructor Detail

CloseableHttpComponentsMessageSender

public CloseableHttpComponentsMessageSender()

Create a new instance of the HttpClientMessageSender with a default HttpClient that uses a default PoolingHttpClientConnectionManager.

CloseableHttpComponentsMessageSender

public CloseableHttpComponentsMessageSender(boolean usePreemptiveAuth)

Create a new instance of the HttpClientMessageSender with a default HttpClient that uses a default PoolingHttpClientConnectionManager.

Parameters:

usePreemptiveAuth - as flag whether preemptive authentication should be used

Method Detail

setCredentials

public void setCredentials(org.apache.http.auth.Credentials credentials)

Sets the credentials to be used. If not set, no authentication is done.

Overrides:

setCredentials in class org.springframework.ws.transport.http.HttpComponentsMessageSender

See Also:

UsernamePasswordCredentials, NTCredentials

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

Returns the HttpClient used by this message sender.

Overrides:

getHttpClient in class org.springframework.ws.transport.http.HttpComponentsMessageSender

setConnectionTimeout

public void setConnectionTimeout(int timeout)

Sets the timeout until a connection is established. A value of 0 means never timeout.

Overrides:

setConnectionTimeout in class org.springframework.ws.transport.http.HttpComponentsMessageSender

Parameters:

timeout - the timeout value in milliseconds

See Also:

RequestConfig.Builder.setConnectTimeout(int), RequestConfig.Builder.setConnectionRequestTimeout(int)

setReadTimeout

public void setReadTimeout(int timeout)

Set the socket read timeout for the underlying HttpClient. A value of 0 means never timeout.

Overrides:

setReadTimeout in class org.springframework.ws.transport.http.HttpComponentsMessageSender

Parameters:

timeout - the timeout value in milliseconds

See Also:

RequestConfig.Builder.setSocketTimeout(int)

closeIdleConnections

public void closeIdleConnections(long timeout)

Closes connections that have been idle for at least the given amount of time. A value of 0 means never timeout.

Parameters:

timeout - the timeout value in milliseconds

See Also:

PoolingHttpClientConnectionManager.closeIdleConnections(long, java.util.concurrent.TimeUnit)

setMaxTotalConnections

public void setMaxTotalConnections(int maxTotalConnections)

Sets the maximum number of connections allowed for the underlying HttpClient.

Overrides:

setMaxTotalConnections in class org.springframework.ws.transport.http.HttpComponentsMessageSender

Parameters:

maxTotalConnections - the maximum number of connections allowed

See Also:

HttpClientBuilder.setMaxConnTotal(int), PoolingHttpClientConnectionManager.setMaxTotal(int)

setDefaultMaxPerHost

public void setDefaultMaxPerHost(int defaultMaxPerHost)

Sets the default maximum number of connections allowed per host for the underlying HttpClient.

Parameters:

defaultMaxPerHost - the maximum number of connections allowed per host

See Also:

HttpClientBuilder.setMaxConnPerRoute(int), PoolingHttpClientConnectionManager.setDefaultMaxPerRoute(int)

setMaxConnectionsPerHost

public void setMaxConnectionsPerHost(Map<String,String> maxConnectionsPerHost)
                              throws URISyntaxException

Sets the maximum number of connections per host for the underlying HttpClient. The maximum number of connections per host can be set in a form accepted by the java.util.Properties class, like as follows:

 https://esb.openhubframework.org/esb/=1
 http://esb.openhubframework.org:8080/esb/=7
 http://esb.openhubframework.org/esb/=10
 

The host can be specified as a URI (with scheme and port).

Overrides:

setMaxConnectionsPerHost in class org.springframework.ws.transport.http.HttpComponentsMessageSender

Parameters:

maxConnectionsPerHost - a properties object specifying the maximum number of connection

Throws:

URISyntaxException

See Also:

PoolingHttpClientConnectionManager.setMaxPerRoute(org.apache.http.conn.routing.HttpRoute, int)

setAuthScope

public void setAuthScope(org.apache.http.auth.AuthScope authScope)

Sets the authentication scope to be used. Only used when the credentials property has been set.

By default, the AuthScope.ANY is used.

Overrides:

setAuthScope in class org.springframework.ws.transport.http.HttpComponentsMessageSender

See Also:

setCredentials(Credentials)

createContext

protected org.apache.http.protocol.HttpContext createContext(URI uri)

Template method that allows for creation of a HttpContext for the given uri. Default implementation returns null.

Overrides:

createContext in class org.springframework.ws.transport.http.HttpComponentsMessageSender

Parameters:

uri - the uri to create the context for

Returns:

the context, or null

getConnPoolControl

public org.apache.http.pool.ConnPoolControl getConnPoolControl()

Gets the ConnPoolControl.

Returns:

the ConnPoolControl

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Overrides:

afterPropertiesSet in class org.springframework.ws.transport.http.HttpComponentsMessageSender

Throws:

Exception

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Overrides:

destroy in class org.springframework.ws.transport.http.HttpComponentsMessageSender

Throws:

Exception

getClientBuilder

protected org.apache.http.impl.client.HttpClientBuilder getClientBuilder()

Gets the HttpClientBuilder.

Returns:

the HttpClientBuilder

setCredentialsProvider

protected void setCredentialsProvider(org.apache.http.client.CredentialsProvider credentialsProvider)

Sets the implementation of CredentialsProvider.

Parameters:

credentialsProvider - the implementation of CredentialsProvider