Package org.springframework.ws.transport.http

Class HttpComponents5MessageSender

java.lang.Object

org.springframework.ws.transport.http.AbstractHttpWebServiceMessageSender

org.springframework.ws.transport.http.HttpComponents5MessageSender

All Implemented Interfaces:

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

public class HttpComponents5MessageSender
extends AbstractHttpWebServiceMessageSender
implements org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

WebServiceMessageSender implementation that uses Apache HttpClient 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).

Since:

4.0.5

Author:

Alan Stewart, Barry Pitman, Arjen Poutsma, Greg Turnquist, Lars Uffmann

See Also:

• HttpClient

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpComponents5MessageSender.RemoveSoapHeadersInterceptor	HttpClient HttpRequestInterceptor implementation that removes Content-Length and Transfer-Encoding headers from the request.

Field Summary

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

logger

Constructor Summary

Constructors

Constructor	Description
HttpComponents5MessageSender()	Create a new instance of the HttpClientMessageSender with a default HttpClient that uses a default PoolingHttpClientConnectionManager.
HttpComponents5MessageSender(org.apache.hc.client5.http.classic.HttpClient httpClient)	Create a new instance of the HttpComponents5MessageSender with the given HttpClient instance.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
WebServiceConnection	createConnection(URI uri)	Create a new WebServiceConnection to the specified URI.
protected org.apache.hc.core5.http.protocol.HttpContext	createContext(URI uri)	Template method that allows for creation of an HttpContext for the given uri.
void	destroy()
org.apache.hc.client5.http.classic.HttpClient	getHttpClient()	Returns the HttpClient used by this message sender.
void	setAuthScope(org.apache.hc.client5.http.auth.AuthScope authScope)
void	setConnectionTimeout(Duration timeout)
void	setCredentials(org.apache.hc.client5.http.auth.Credentials credentials)
void	setHttpClient(org.apache.hc.client5.http.classic.HttpClient httpClient)	Set the HttpClient used by this message sender.
void	setMaxConnectionsPerHost(Map<String,String> maxConnectionsPerHost)
void	setMaxTotalConnections(int maxTotalConnections)
void	setReadTimeout(Duration timeout)

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

Constructor Details

HttpComponents5MessageSender

public HttpComponents5MessageSender()

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

HttpComponents5MessageSender

public HttpComponents5MessageSender(org.apache.hc.client5.http.classic.HttpClient httpClient)

Create a new instance of the HttpComponents5MessageSender with the given HttpClient instance.

This constructor does not change the given HttpClient in any way. As such, it does not set timeouts, nor does it add the HttpComponents5MessageSender.RemoveSoapHeadersInterceptor.

Parameters:

httpClient - the HttpClient instance to use for this sender

Method Details

setAuthScope

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

See Also:

• HttpComponents5ClientFactory.setAuthScope(AuthScope)

setCredentials

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

See Also:

• HttpComponents5ClientFactory.setCredentials(Credentials)

getHttpClient

public org.apache.hc.client5.http.classic.HttpClient getHttpClient()

Returns the HttpClient used by this message sender.

setHttpClient

public void setHttpClient(org.apache.hc.client5.http.classic.HttpClient httpClient)

Set the HttpClient used by this message sender.

setConnectionTimeout

public void setConnectionTimeout(Duration timeout)

See Also:

• HttpComponents5ClientFactory.setConnectionTimeout(Duration)

setReadTimeout

public void setReadTimeout(Duration timeout)

See Also:

• HttpComponents5ClientFactory.setReadTimeout(Duration)

setMaxTotalConnections

public void setMaxTotalConnections(int maxTotalConnections)

See Also:

• HttpComponents5ClientFactory.setMaxTotalConnections(int)

setMaxConnectionsPerHost

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

See Also:

• HttpComponents5ClientFactory.setMaxConnectionsPerHost(Map)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

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

Throws:

Exception

createConnection

public WebServiceConnection createConnection(URI uri)
                                      throws IOException

Description copied from interface: WebServiceMessageSender

Create a new WebServiceConnection to the specified URI.

Specified by:

createConnection in interface WebServiceMessageSender

Parameters:

uri - the URI to open a connection to

Returns:

the new connection

Throws:

IOException - in case of I/O errors

createContext

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

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

Parameters:

uri - the URI to create the context for

Returns:

the context, or null

destroy

public void destroy()
             throws Exception

Specified by:

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

Throws:

Exception