Class HttpMessageHandlerSpec

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<HttpMessageHandlerSpec, HttpRequestExecutingMessageHandler>

org.springframework.integration.dsl.MessageHandlerSpec<HttpMessageHandlerSpec, HttpRequestExecutingMessageHandler>

org.springframework.integration.http.dsl.BaseHttpMessageHandlerSpec<HttpMessageHandlerSpec, HttpRequestExecutingMessageHandler>

org.springframework.integration.http.dsl.HttpMessageHandlerSpec

All Implemented Interfaces:

DisposableBean, FactoryBean<HttpRequestExecutingMessageHandler>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration

public class HttpMessageHandlerSpec
extends BaseHttpMessageHandlerSpec<HttpMessageHandlerSpec, HttpRequestExecutingMessageHandler>

The BaseHttpMessageHandlerSpec implementation for the HttpRequestExecutingMessageHandler.

Since:

5.0

Author:

Artem Bilan, Shiliang Li, Oleksii Komlyk, Arun Sethumadhavan, Glenn Renfro

See Also:

• HttpRequestExecutingMessageHandler

Field Summary

Fields inherited from class IntegrationComponentSpec

logger, PARSER, target

Fields inherited from interface FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpMessageHandlerSpec(String uri, @Nullable RestClient restClient)
protected	HttpMessageHandlerSpec(String uri, @Nullable RestTemplate restTemplate)	Deprecated, for removal: This API element is subject to removal in a future version. Since 7.1 in favor of RestClient-based configuration.
protected	HttpMessageHandlerSpec(URI uri, @Nullable RestClient restClient)
protected	HttpMessageHandlerSpec(URI uri, @Nullable RestTemplate restTemplate)	Deprecated, for removal: This API element is subject to removal in a future version. Since 7.1 in favor of RestClient-based configuration.
protected	HttpMessageHandlerSpec(Expression uriExpression, @Nullable RestClient restClient)
protected	HttpMessageHandlerSpec(Expression uriExpression, @Nullable RestTemplate restTemplate)	Deprecated, for removal: This API element is subject to removal in a future version. Since 7.1 in favor of RestClient-based configuration.

Method Summary

Modifier and Type	Method	Description
HttpMessageHandlerSpec	defaultStatusHandler(Predicate<HttpStatusCode> predicate, RestClient.ResponseSpec.ErrorHandler errorHandler)	Set the status Predicate and RestClient.ResponseSpec.ErrorHandler for the underlying RestClient.
HttpMessageHandlerSpec	defaultStatusHandler(RestClient.ResponseSpec.ErrorHandler errorHandler)	Set the RestClient.ResponseSpec.ErrorHandler for the underlying RestClient, applied to any error response status.
HttpMessageHandlerSpec	errorHandler(ResponseErrorHandler errorHandler)	Deprecated, for removal: This API element is subject to removal in a future version. Since 7.2 in favor of RestClient.ResponseSpec.ErrorHandler.
protected boolean	isClientSet()
HttpMessageHandlerSpec	messageConverters(HttpMessageConverter<?>... messageConverters)	Set a list of HttpMessageConverters to be used by the underlying RestClient.
HttpMessageHandlerSpec	requestFactory(ClientHttpRequestFactory requestFactory)	Deprecated, for removal: This API element is subject to removal in a future version. Since 7.2 in favor of RestClient-based configuration.

Methods inherited from class BaseHttpMessageHandlerSpec

charset, encodingMode, expectedResponseType, expectedResponseType, expectedResponseTypeExpression, expectedResponseTypeFunction, expectReply, extractPayload, extractResponseBody, getComponentsToRegister, headerMapper, httpMethod, httpMethodExpression, httpMethodFunction, mappedRequestHeaders, mappedResponseHeaders, transferCookies, uriVariable, uriVariable, uriVariable, uriVariableExpressions, uriVariablesExpression, uriVariablesExpression, uriVariablesFunction

Methods inherited from class IntegrationComponentSpec

_this, afterPropertiesSet, destroy, doGet, getId, getObject, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class Object

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

Methods inherited from interface FactoryBean

isSingleton

Methods inherited from interface SmartLifecycle

isPauseable

Constructor Details

HttpMessageHandlerSpec

@Deprecated(since="7.1",
            forRemoval=true)
protected HttpMessageHandlerSpec(URI uri,
 @Nullable RestTemplate restTemplate)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 7.1 in favor of RestClient-based configuration.

HttpMessageHandlerSpec

@Deprecated(since="7.1",
            forRemoval=true)
protected HttpMessageHandlerSpec(String uri,
 @Nullable RestTemplate restTemplate)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 7.1 in favor of RestClient-based configuration.

HttpMessageHandlerSpec

@Deprecated(since="7.1",
            forRemoval=true)
protected HttpMessageHandlerSpec(Expression uriExpression,
 @Nullable RestTemplate restTemplate)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 7.1 in favor of RestClient-based configuration.

HttpMessageHandlerSpec

protected HttpMessageHandlerSpec(URI uri,
 @Nullable RestClient restClient)

HttpMessageHandlerSpec

protected HttpMessageHandlerSpec(String uri,
 @Nullable RestClient restClient)

HttpMessageHandlerSpec

protected HttpMessageHandlerSpec(Expression uriExpression,
 @Nullable RestClient restClient)

Method Details

requestFactory

@Deprecated(since="7.2",
            forRemoval=true)
public HttpMessageHandlerSpec requestFactory(ClientHttpRequestFactory requestFactory)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 7.2 in favor of RestClient-based configuration.

Set the ClientHttpRequestFactory for the underlying RestTemplate.

Parameters:

requestFactory - The request factory.

Returns:

the spec

errorHandler

@Deprecated(since="7.2",
            forRemoval=true)
public HttpMessageHandlerSpec errorHandler(ResponseErrorHandler errorHandler)

Deprecated, for removal: This API element is subject to removal in a future version.

Since 7.2 in favor of RestClient.ResponseSpec.ErrorHandler.

Set the ResponseErrorHandler for the underlying RestTemplate.

Parameters:

errorHandler - The error handler.

Returns:

the spec

defaultStatusHandler

public HttpMessageHandlerSpec defaultStatusHandler(RestClient.ResponseSpec.ErrorHandler errorHandler)

Set the RestClient.ResponseSpec.ErrorHandler for the underlying RestClient, applied to any error response status.

Parameters:

errorHandler - The error handler.

Returns:

the spec

Since:

7.2

defaultStatusHandler

public HttpMessageHandlerSpec defaultStatusHandler(Predicate<HttpStatusCode> predicate,
 RestClient.ResponseSpec.ErrorHandler errorHandler)

Set the status Predicate and RestClient.ResponseSpec.ErrorHandler for the underlying RestClient.

Parameters:

predicate - the predicate for the response status to match for this error handler.

errorHandler - The error handler.

Returns:

the spec

Since:

7.2

messageConverters

public HttpMessageHandlerSpec messageConverters(HttpMessageConverter<?>... messageConverters)

Set a list of HttpMessageConverters to be used by the underlying RestClient. Converters configured via this method will override the default converters.

Parameters:

messageConverters - The message converters.

Returns:

the spec

isClientSet

protected boolean isClientSet()

Specified by:

isClientSet in class BaseHttpMessageHandlerSpec<HttpMessageHandlerSpec, HttpRequestExecutingMessageHandler>