Package org.springframework.ws.transport.http

Class HttpComponents5Connection

java.lang.Object

org.springframework.ws.transport.AbstractWebServiceConnection

org.springframework.ws.transport.AbstractSenderConnection

org.springframework.ws.transport.http.AbstractHttpSenderConnection

org.springframework.ws.transport.http.HttpComponents5Connection

All Implemented Interfaces:

AutoCloseable, FaultAwareWebServiceConnection, HeadersAwareSenderWebServiceConnection, WebServiceConnection

public class HttpComponents5Connection
extends AbstractHttpSenderConnection

Implementation of WebServiceConnection that is based on Apache HttpClient 5. Exposes a HttpPost and HttpResponse.

Since:

4.0.5

Author:

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpComponents5Connection(org.apache.hc.client5.http.classic.HttpClient httpClient, org.apache.hc.client5.http.classic.methods.HttpPost httpPost, org.apache.hc.core5.http.protocol.HttpContext httpContext)

Method Summary

Modifier and Type	Method	Description
void	addRequestHeader(String name, String value)	Adds a request header with the given name and value.
org.apache.hc.client5.http.classic.methods.HttpPost	getHttpPost()
org.apache.hc.core5.http.HttpResponse	getHttpResponse()
protected InputStream	getRawResponseInputStream()	Returns the raw, possibly compressed input stream to read the response from.
protected OutputStream	getRequestOutputStream()	Returns the output stream to write the request to.
protected int	getResponseCode()	Returns the HTTP status code of the response.
protected long	getResponseContentLength()	Returns the length of the response.
Iterator<String>	getResponseHeaderNames()	Returns an iteration over all the header names this request contains.
Iterator<String>	getResponseHeaders(String name)	Returns an iteration over all the string values of the specified header.
protected String	getResponseMessage()	Returns the HTTP status message of the response.
URI	getUri()	Returns the URI for this connection.
void	onClose()	Template method invoked from AbstractWebServiceConnection.close().
protected void	onSendAfterWrite(WebServiceMessage message)	Called after the given message has been written to the TransportOutputStream.
protected void	onSendBeforeWrite(WebServiceMessage message)	Called before the given message has been written to the TransportOutputStream.

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

getErrorMessage, getResponseInputStream, hasError, hasFault, hasResponse, setFault, setFaultCode

Methods inherited from class org.springframework.ws.transport.AbstractSenderConnection

createTransportInputStream, createTransportOutputStream

Methods inherited from class org.springframework.ws.transport.AbstractWebServiceConnection

close, onReceiveAfterRead, onReceiveBeforeRead, receive, send

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ws.transport.WebServiceConnection

close, receive, send

Constructor Details

HttpComponents5Connection

protected HttpComponents5Connection(org.apache.hc.client5.http.classic.HttpClient httpClient,
 org.apache.hc.client5.http.classic.methods.HttpPost httpPost,
 org.apache.hc.core5.http.protocol.HttpContext httpContext)

Method Details

getHttpPost

public org.apache.hc.client5.http.classic.methods.HttpPost getHttpPost()

getHttpResponse

public org.apache.hc.core5.http.HttpResponse getHttpResponse()

onClose

public void onClose()
             throws IOException

Description copied from class: AbstractSenderConnection

Template method invoked from AbstractWebServiceConnection.close(). Default implementation is empty.

Overrides:

onClose in class AbstractSenderConnection

Throws:

IOException - if an I/O error occurs when closing this connection

getUri

public URI getUri()
           throws URISyntaxException

Description copied from interface: WebServiceConnection

Returns the URI for this connection.

Throws:

URISyntaxException

onSendBeforeWrite

protected void onSendBeforeWrite(WebServiceMessage message)
                          throws IOException

Description copied from class: AbstractWebServiceConnection

Called before the given message has been written to the TransportOutputStream. Called from AbstractWebServiceConnection.send(WebServiceMessage).

Default implementation does nothing.

Overrides:

onSendBeforeWrite in class AbstractWebServiceConnection

Parameters:

message - the message

Throws:

IOException - when an I/O exception occurs

addRequestHeader

public void addRequestHeader(String name,
 String value)
                      throws IOException

Description copied from interface: HeadersAwareSenderWebServiceConnection

Adds a request header with the given name and value. This method can be called multiple times, to allow for headers with multiple values.

Parameters:

name - the name of the header

value - the value of the header

Throws:

IOException

getRequestOutputStream

protected OutputStream getRequestOutputStream()
                                       throws IOException

Description copied from class: AbstractSenderConnection

Returns the output stream to write the request to.

Specified by:

getRequestOutputStream in class AbstractSenderConnection

Throws:

IOException

onSendAfterWrite

protected void onSendAfterWrite(WebServiceMessage message)
                         throws IOException

Description copied from class: AbstractWebServiceConnection

Called after the given message has been written to the TransportOutputStream. Called from AbstractWebServiceConnection.send(WebServiceMessage).

Default implementation does nothing.

Overrides:

onSendAfterWrite in class AbstractWebServiceConnection

Parameters:

message - the message

Throws:

IOException - when an I/O exception occurs

getResponseCode

protected int getResponseCode()
                       throws IOException

Description copied from class: AbstractHttpSenderConnection

Returns the HTTP status code of the response.

Specified by:

getResponseCode in class AbstractHttpSenderConnection

Throws:

IOException

getResponseMessage

protected String getResponseMessage()
                             throws IOException

Description copied from class: AbstractHttpSenderConnection

Returns the HTTP status message of the response.

Specified by:

getResponseMessage in class AbstractHttpSenderConnection

Throws:

IOException

getResponseContentLength

protected long getResponseContentLength()
                                 throws IOException

Description copied from class: AbstractHttpSenderConnection

Returns the length of the response.

Specified by:

getResponseContentLength in class AbstractHttpSenderConnection

Throws:

IOException

getRawResponseInputStream

protected InputStream getRawResponseInputStream()
                                         throws IOException

Description copied from class: AbstractHttpSenderConnection

Returns the raw, possibly compressed input stream to read the response from.

Specified by:

getRawResponseInputStream in class AbstractHttpSenderConnection

Throws:

IOException

getResponseHeaderNames

public Iterator<String> getResponseHeaderNames()
                                        throws IOException

Description copied from interface: HeadersAwareSenderWebServiceConnection

Returns an iteration over all the header names this request contains. Returns an empty Iterator if there are no headers.

Throws:

IOException

getResponseHeaders

public Iterator<String> getResponseHeaders(String name)
                                    throws IOException

Description copied from interface: HeadersAwareSenderWebServiceConnection

Returns an iteration over all the string values of the specified header. Returns an empty Iterator if there are no headers of the specified name.

Throws:

IOException