Top Description Fields Constructors Methods
org.springframework.http.client.support

public abstract Class HttpAccessor

extends Object
Class Inheritance
Known Direct Subclasses
org.springframework.http.client.support.InterceptingHttpAccessor
Imports
java.io.IOException, java.net.URI, java.util.ArrayList, .List, org.apache.commons.logging.Log, org.springframework.core.annotation.AnnotationAwareOrderComparator, org.springframework.http.HttpLogging, .HttpMethod, org.springframework.http.client.ClientHttpRequest, .ClientHttpRequestFactory, .ClientHttpRequestInitializer, .SimpleClientHttpRequestFactory, org.springframework.util.Assert
Base class for org.springframework.web.client.RestTemplate and other HTTP accessing gateway helpers, defining common properties such as the ClientHttpRequestFactory to operate on.

Not intended to be used directly.

See org.springframework.web.client.RestTemplate for an entry point.

Authors
Arjen Poutsma, Juergen Hoeller, Phillip Webb
Since
3.0
See Also
ClientHttpRequestFactory, org.springframework.web.client.RestTemplate

Field Summary

Modifier and TypeField and Description
private final List<ClientHttpRequestInitializer>
clientHttpRequestInitializers

protected final Log
logger

Logger available to subclasses.

private ClientHttpRequestFactory
requestFactory

Constructor Summary

AccessConstructor and Description
public
HttpAccessor()

Method Summary

Modifier and TypeMethod and Description
protected ClientHttpRequest

Returns:

the created request
createRequest(URI
the URL to connect to
url, HttpMethod
the HTTP method to execute (GET, POST, etc)
method)

Create a new ClientHttpRequest via this template's ClientHttpRequestFactory.

public List<ClientHttpRequestInitializer>
getClientHttpRequestInitializers()

Get the request initializers that this accessor uses.

public ClientHttpRequestFactory
getRequestFactory()

Return the request factory that this accessor uses for obtaining client request handles.

private void
initialize(ClientHttpRequest request)

public void
setClientHttpRequestInitializers(List<ClientHttpRequestInitializer> clientHttpRequestInitializers)

Set the request initializers that this accessor should use.

public void
setRequestFactory(ClientHttpRequestFactory requestFactory)

Set the request factory that this accessor uses for obtaining client request handles.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

clientHttpRequestInitializersback to summary
private final List<ClientHttpRequestInitializer> clientHttpRequestInitializers
loggerback to summary
protected final Log logger

Logger available to subclasses.

requestFactoryback to summary
private ClientHttpRequestFactory requestFactory

Constructor Detail

HttpAccessorback to summary
public HttpAccessor()

Method Detail

createRequestback to summary
protected ClientHttpRequest createRequest(URI url, HttpMethod method) throws IOException

Create a new ClientHttpRequest via this template's ClientHttpRequestFactory.

Parameters
url:URI

the URL to connect to

method:HttpMethod

the HTTP method to execute (GET, POST, etc)

Returns:ClientHttpRequest

the created request

Exceptions
IOException:
in case of I/O errors
See Also
getRequestFactory(), ClientHttpRequestFactory#createRequest(URI, HttpMethod)
getClientHttpRequestInitializersback to summary
public List<ClientHttpRequestInitializer> getClientHttpRequestInitializers()

Get the request initializers that this accessor uses.

The returned List is active and may be modified. Note, however, that the initializers will not be resorted according to their order before the ClientHttpRequest is initialized.

Since
5.2
See Also
setClientHttpRequestInitializers(List)
getRequestFactoryback to summary
public ClientHttpRequestFactory getRequestFactory()

Return the request factory that this accessor uses for obtaining client request handles.

initializeback to summary
private void initialize(ClientHttpRequest request)
setClientHttpRequestInitializersback to summary
public void setClientHttpRequestInitializers(List<ClientHttpRequestInitializer> clientHttpRequestInitializers)

Set the request initializers that this accessor should use.

The initializers will get immediately sorted according to their order.

Since
5.2
setRequestFactoryback to summary
public void setRequestFactory(ClientHttpRequestFactory requestFactory)

Set the request factory that this accessor uses for obtaining client request handles.

The default is a SimpleClientHttpRequestFactory based on the JDK's own HTTP libraries (java.net.HttpURLConnection).

Note that the standard JDK HTTP library does not support the HTTP PATCH method. Configure the Apache HttpComponents or OkHttp request factory to enable PATCH.

See Also
createRequest(URI, HttpMethod), SimpleClientHttpRequestFactory, org.springframework.http.client.HttpComponentsClientHttpRequestFactory, org.springframework.http.client.OkHttp3ClientHttpRequestFactory