org.springframework.http.client

Class OkHttp3ClientHttpRequest

java.lang.Object

org.springframework.http.client.AbstractClientHttpRequest

org.springframework.http.client.AbstractBufferingClientHttpRequest

org.springframework.http.client.OkHttp3ClientHttpRequest

All Implemented Interfaces:

ClientHttpRequest, HttpMessage, HttpOutputMessage, HttpRequest

class OkHttp3ClientHttpRequest
extends AbstractBufferingClientHttpRequest

ClientHttpRequest implementation based on OkHttp 3.x.

Created via the OkHttp3ClientHttpRequestFactory.

Since:

4.3

Author:

Luciano Leggieri, Arjen Poutsma, Roy Clarkson

Field Summary

Fields

Modifier and Type	Field and Description
private OkHttpClient	client
private HttpMethod	method
private java.net.URI	uri

Constructor Summary

Constructors

Constructor and Description
OkHttp3ClientHttpRequest(OkHttpClient client, java.net.URI uri, HttpMethod method)

Method Summary

Modifier and Type	Method and Description
protected ClientHttpResponse	executeInternal(HttpHeaders headers, byte[] content) Abstract template method that writes the given headers and content to the HTTP request.
HttpMethod	getMethod() Return the HTTP method of the request.
java.lang.String	getMethodValue() Return the HTTP method of the request as a String value.
java.net.URI	getURI() Return the URI of the request (including a query string if any, but only if it is well-formed for a URI representation).

Methods inherited from class org.springframework.http.client.AbstractBufferingClientHttpRequest

executeInternal, getBodyInternal

Methods inherited from class org.springframework.http.client.AbstractClientHttpRequest

assertNotExecuted, execute, getBody, getHeaders

Methods inherited from class java.lang.Object

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

Field Detail

client

private final OkHttpClient client

uri

private final java.net.URI uri

method

private final HttpMethod method

Constructor Detail

OkHttp3ClientHttpRequest

public OkHttp3ClientHttpRequest(OkHttpClient client,
                                java.net.URI uri,
                                HttpMethod method)

Method Detail

getMethod

public HttpMethod getMethod()

Description copied from interface: HttpRequest

Return the HTTP method of the request.

Returns:

the HTTP method as an HttpMethod enum value, or null if not resolvable (e.g. in case of a non-standard HTTP method)

See Also:

HttpRequest.getMethodValue(), HttpMethod.resolve(String)

getMethodValue

public java.lang.String getMethodValue()

Description copied from interface: HttpRequest

Return the HTTP method of the request as a String value.

Returns:

the HTTP method as a plain String

See Also:

HttpRequest.getMethod()

getURI

public java.net.URI getURI()

Description copied from interface: HttpRequest

Return the URI of the request (including a query string if any, but only if it is well-formed for a URI representation).

Returns:

the URI of the request (never null)

executeInternal

protected ClientHttpResponse executeInternal(HttpHeaders headers,
                                             byte[] content)
                                      throws java.io.IOException

Description copied from class: AbstractBufferingClientHttpRequest

Abstract template method that writes the given headers and content to the HTTP request.

Specified by:

executeInternal in class AbstractBufferingClientHttpRequest

Parameters:

headers - the HTTP headers

content - the body content

Returns:

the response object for the executed request

Throws:

java.io.IOException