Package org.springframework.integration.http.dsl

Class HttpControllerEndpointSpec

java.lang.Object

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

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

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

org.springframework.integration.http.dsl.BaseHttpInboundEndpointSpec<HttpControllerEndpointSpec,HttpRequestHandlingController>

org.springframework.integration.http.dsl.HttpControllerEndpointSpec

All Implemented Interfaces:

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

public class HttpControllerEndpointSpec
extends BaseHttpInboundEndpointSpec<HttpControllerEndpointSpec,HttpRequestHandlingController>

The BaseHttpInboundEndpointSpec implementation for the HttpRequestHandlingController.

Since:

5.0

Author:

Artem Bilan

See Also:

• HttpRequestHandlingController

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.http.dsl.HttpInboundEndpointSupportSpec

HttpInboundEndpointSupportSpec.CrossOriginSpec, HttpInboundEndpointSupportSpec.RequestMappingSpec

Field Summary

Fields inherited from class org.springframework.integration.http.dsl.HttpInboundEndpointSupportSpec

headerExpressions, headerMapper, requestMapping

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

logger, PARSER, target

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpControllerEndpointSpec(HttpRequestHandlingController controller, String... path)

Method Summary

Modifier and Type	Method	Description
HttpControllerEndpointSpec	errorCode(String errorCode)	The error code to use to signal an error in the message handling.
HttpControllerEndpointSpec	errorsKey(String errorsKey)	The key used to expose Errors in the core, in the case that message handling fails.
HttpControllerEndpointSpec	replyKey(String replyKey)	Specify the key to be used when adding the reply Message or payload to the core map (will be payload only unless the value of BaseHttpInboundEndpoint.setExtractReplyPayload(boolean) is false).

Methods inherited from class org.springframework.integration.http.dsl.BaseHttpInboundEndpointSpec

mergeWithDefaultConverters, messageConverters, multipartResolver

Methods inherited from class org.springframework.integration.http.dsl.HttpInboundEndpointSupportSpec

crossOrigin, extractReplyPayload, getComponentsToRegister, headerExpression, headerExpression, headerExpressions, headerFunction, headerMapper, mappedRequestHeaders, mappedResponseHeaders, payloadExpression, payloadExpression, payloadFunction, requestMapping, requestPayloadType, requestPayloadType, statusCodeExpression, statusCodeExpression, statusCodeFunction, validator

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

autoStartup, errorChannel, errorChannel, errorOnTimeout, id, observationConvention, phase, replyChannel, replyChannel, replyMapper, replyTimeout, requestChannel, requestChannel, requestMapper, requestTimeout, shouldTrack

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.FactoryBean

isSingleton

Constructor Details

HttpControllerEndpointSpec

protected HttpControllerEndpointSpec(HttpRequestHandlingController controller,
 String... path)

Method Details

replyKey

public HttpControllerEndpointSpec replyKey(String replyKey)

Specify the key to be used when adding the reply Message or payload to the core map (will be payload only unless the value of BaseHttpInboundEndpoint.setExtractReplyPayload(boolean) is false). The default key is reply.

Parameters:

replyKey - The reply key.

Returns:

the spec

See Also:

• HttpRequestHandlingController.setReplyKey(String)

errorsKey

public HttpControllerEndpointSpec errorsKey(String errorsKey)

The key used to expose Errors in the core, in the case that message handling fails. Defaults to errors.

Parameters:

errorsKey - The key value to set.

Returns:

the spec

See Also:

• HttpRequestHandlingController.setErrorsKey(String)

errorCode

public HttpControllerEndpointSpec errorCode(String errorCode)

The error code to use to signal an error in the message handling.

Parameters:

errorCode - The error code to set.

Returns:

the spec

See Also:

• HttpRequestHandlingController.setErrorCode(String)