org.springframework.integration.http.dsl

Class BaseHttpInboundEndpointSpec<S extends BaseHttpInboundEndpointSpec<S,E>,E extends HttpRequestHandlingEndpointSupport>

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<S,G>

org.springframework.integration.dsl.MessagingGatewaySpec<S,E>

org.springframework.integration.http.dsl.BaseHttpInboundEndpointSpec<S,E>

Type Parameters:

S - the target BaseHttpInboundEndpointSpec implementation type.

E - the target HttpRequestHandlingEndpointSupport implementation type.

All Implemented Interfaces:

FactoryBean<E>, ComponentsRegistration

Direct Known Subclasses:

HttpControllerEndpointSpec, HttpRequestHandlerEndpointSpec

public abstract class BaseHttpInboundEndpointSpec<S extends BaseHttpInboundEndpointSpec<S,E>,E extends HttpRequestHandlingEndpointSupport>
extends MessagingGatewaySpec<S,E>
implements ComponentsRegistration

A base MessagingGatewaySpec for the HttpRequestHandlingEndpointSupport implementations.

Since:

5.0

Author:

Artem Bilan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseHttpInboundEndpointSpec.CrossOriginSpec A fluent API for the CrossOrigin.
static class	BaseHttpInboundEndpointSpec.RequestMappingSpec A fluent API for the RequestMapping.

Field Summary

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

logger, PARSER, target

Method Summary

Modifier and Type	Method and Description
S	crossOrigin(java.util.function.Consumer<BaseHttpInboundEndpointSpec.CrossOriginSpec> crossOrigin) Provide a Consumer for configuring CrossOrigin via BaseHttpInboundEndpointSpec.CrossOriginSpec
S	extractReplyPayload(boolean extractReplyPayload) Specify whether only the reply Message's payload should be passed in the response.
Collection<Object>	getComponentsToRegister()
S	headerExpression(String header, Expression expression) Specify SpEL expression for provided header to populate.
S	headerExpression(String header, String expression) Specify SpEL expression for provided header to populate.
S	headerExpressions(Map<String,Expression> headerExpressions) Specify a Map of SpEL expressions to evaluate in order to generate the Message headers.
<P> S	headerFunction(String header, java.util.function.Function<HttpEntity<P>,?> headerFunction) Specify a Function for provided header to populate.
S	headerMapper(HeaderMapper<HttpHeaders> headerMapper) Set the HeaderMapper to use when mapping between HTTP headers and MessageHeaders.
S	mappedRequestHeaders(String... patterns) Provide the pattern array for request headers to map.
S	mappedResponseHeaders(String... patterns) Provide the pattern array for response headers to map.
S	mergeWithDefaultConverters(boolean mergeWithDefaultConverters) Flag which determines if the default converters should be available after custom converters.
S	messageConverters(HttpMessageConverter<?>... messageConverters) Set the message body converters to use.
S	multipartResolver(MultipartResolver multipartResolver) Specify the MultipartResolver to use when checking requests.
S	payloadExpression(Expression payloadExpression) Specify a SpEL expression to evaluate in order to generate the Message payload.
S	payloadExpression(String payloadExpression) Specify a SpEL expression to evaluate in order to generate the Message payload.
<P> S	payloadFunction(java.util.function.Function<HttpEntity<P>,?> payloadFunction) Specify a Function to evaluate in order to generate the Message payload.
S	requestMapping(java.util.function.Consumer<BaseHttpInboundEndpointSpec.RequestMappingSpec> requestMapping) Provide a Consumer for configuring RequestMapping via BaseHttpInboundEndpointSpec.RequestMappingSpec
S	requestPayloadType(Class<?> requestPayloadType) Specify the type of payload to be generated when the inbound HTTP request content is read by the HttpMessageConverters.
S	statusCodeExpression(Expression statusCodeExpression) Specify the Expression to resolve a status code for Response to override the default '200 OK' or '500 Internal Server Error' for a timeout.
S	statusCodeExpression(String statusCodeExpression) Specify the Expression to resolve a status code for Response to override the default '200 OK' or '500 Internal Server Error' for a timeout.
S	statusCodeFunction(java.util.function.Function<Void,?> statusCodeFunction) Specify the Function to resolve a status code for Response to override the default '200 OK' or '500 Internal Server Error' for a timeout.

Methods inherited from class org.springframework.integration.dsl.MessagingGatewaySpec

autoStartup, errorChannel, errorChannel, id, phase, replyChannel, replyChannel, replyMapper, replyTimeout, requestChannel, requestChannel, requestMapper, requestTimeout

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, doGet, get, getId, getObject, getObjectType, isSingleton

Methods inherited from class java.lang.Object

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

Method Detail

requestMapping

public S requestMapping(java.util.function.Consumer<BaseHttpInboundEndpointSpec.RequestMappingSpec> requestMapping)

Provide a Consumer for configuring RequestMapping via BaseHttpInboundEndpointSpec.RequestMappingSpec

Parameters:

requestMapping - the Consumer to configure BaseHttpInboundEndpointSpec.RequestMappingSpec.

Returns:

the spec

See Also:

RequestMapping

crossOrigin

public S crossOrigin(java.util.function.Consumer<BaseHttpInboundEndpointSpec.CrossOriginSpec> crossOrigin)

Provide a Consumer for configuring CrossOrigin via BaseHttpInboundEndpointSpec.CrossOriginSpec

Parameters:

crossOrigin - the Consumer to configure BaseHttpInboundEndpointSpec.CrossOriginSpec.

Returns:

the spec

See Also:

CrossOrigin

payloadExpression

public S payloadExpression(String payloadExpression)

Specify a SpEL expression to evaluate in order to generate the Message payload.

Parameters:

payloadExpression - The payload expression.

Returns:

the spec

See Also:

HttpRequestHandlingEndpointSupport.setPayloadExpression(Expression)

payloadExpression

public S payloadExpression(Expression payloadExpression)

Specify a SpEL expression to evaluate in order to generate the Message payload.

Parameters:

payloadExpression - The payload expression.

Returns:

the spec

See Also:

HttpRequestHandlingEndpointSupport.setPayloadExpression(Expression)

payloadFunction

public <P> S payloadFunction(java.util.function.Function<HttpEntity<P>,?> payloadFunction)

Specify a Function to evaluate in order to generate the Message payload.

Type Parameters:

P - the expected HTTP request body type.

Parameters:

payloadFunction - The payload Function.

Returns:

the spec

See Also:

HttpRequestHandlingEndpointSupport.setPayloadExpression(Expression)

headerExpressions

public S headerExpressions(Map<String,Expression> headerExpressions)

Specify a Map of SpEL expressions to evaluate in order to generate the Message headers.

Parameters:

headerExpressions - The Map of SpEL expressions for headers.

Returns:

the spec

See Also:

HttpRequestHandlingEndpointSupport.setHeaderExpressions(Map)

headerExpression

public S headerExpression(String header,
                          String expression)

Specify SpEL expression for provided header to populate.

Parameters:

header - the header name to populate.

expression - the SpEL expression for the header.

Returns:

the spec

See Also:

HttpRequestHandlingEndpointSupport.setHeaderExpressions(Map)

headerExpression

public S headerExpression(String header,
                          Expression expression)

Specify SpEL expression for provided header to populate.

Parameters:

header - the header name to populate.

expression - the SpEL expression for the header.

Returns:

the spec

See Also:

HttpRequestHandlingEndpointSupport.setHeaderExpressions(Map)

headerFunction

public <P> S headerFunction(String header,
                            java.util.function.Function<HttpEntity<P>,?> headerFunction)

Specify a Function for provided header to populate.

Type Parameters:

P - the expected HTTP body type.

Parameters:

header - the header name to add.

headerFunction - the function to evaluate the header value against HttpEntity.

Returns:

the current Spec.

See Also:

HttpRequestHandlingEndpointSupport.setHeaderExpressions(Map)

messageConverters

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

Set the message body converters to use. These converters are used to convert from and to HTTP requests and responses.

Parameters:

messageConverters - The message converters.

Returns:

the current Spec.

mergeWithDefaultConverters

public S mergeWithDefaultConverters(boolean mergeWithDefaultConverters)

Flag which determines if the default converters should be available after custom converters.

Parameters:

mergeWithDefaultConverters - true to merge, false to replace.

Returns:

the current Spec.

headerMapper

public S headerMapper(HeaderMapper<HttpHeaders> headerMapper)

Set the HeaderMapper to use when mapping between HTTP headers and MessageHeaders.

Parameters:

headerMapper - The header mapper.

Returns:

the current Spec.

mappedRequestHeaders

public S mappedRequestHeaders(String... patterns)

Provide the pattern array for request headers to map.

Parameters:

patterns - the patterns for request headers to map.

Returns:

the current Spec.

See Also:

DefaultHttpHeaderMapper.setOutboundHeaderNames(String[])

mappedResponseHeaders

public S mappedResponseHeaders(String... patterns)

Provide the pattern array for response headers to map.

Parameters:

patterns - the patterns for response headers to map.

Returns:

the current Spec.

See Also:

DefaultHttpHeaderMapper.setInboundHeaderNames(String[])

requestPayloadType

public S requestPayloadType(Class<?> requestPayloadType)

Specify the type of payload to be generated when the inbound HTTP request content is read by the HttpMessageConverters. By default this value is null which means at runtime any "text" Content-Type will result in String while all others default to byte[].class.

Parameters:

requestPayloadType - The payload type.

Returns:

the current Spec.

extractReplyPayload

public S extractReplyPayload(boolean extractReplyPayload)

Specify whether only the reply Message's payload should be passed in the response. If this is set to false, the entire Message will be used to generate the response. The default is true.

Parameters:

extractReplyPayload - true to extract the reply payload.

Returns:

the current Spec.

multipartResolver

public S multipartResolver(MultipartResolver multipartResolver)

Specify the MultipartResolver to use when checking requests.

Parameters:

multipartResolver - The multipart resolver.

Returns:

the current Spec.

statusCodeExpression

public S statusCodeExpression(String statusCodeExpression)

Specify the Expression to resolve a status code for Response to override the default '200 OK' or '500 Internal Server Error' for a timeout.

Parameters:

statusCodeExpression - The status code Expression.

Returns:

the current Spec.

See Also:

HttpRequestHandlingEndpointSupport.setStatusCodeExpression(Expression)

statusCodeExpression

public S statusCodeExpression(Expression statusCodeExpression)

Specify the Expression to resolve a status code for Response to override the default '200 OK' or '500 Internal Server Error' for a timeout.

Parameters:

statusCodeExpression - The status code Expression.

Returns:

the current Spec.

See Also:

HttpRequestHandlingEndpointSupport.setStatusCodeExpression(Expression)

statusCodeFunction

public S statusCodeFunction(java.util.function.Function<Void,?> statusCodeFunction)

Specify the Function to resolve a status code for Response to override the default '200 OK' or '500 Internal Server Error' for a timeout.

Parameters:

statusCodeFunction - The status code Function.

Returns:

the current Spec.

See Also:

HttpRequestHandlingEndpointSupport.setStatusCodeExpression(Expression)

getComponentsToRegister

public Collection<Object> getComponentsToRegister()

Specified by:

getComponentsToRegister in interface ComponentsRegistration