public class BaseHttpInboundEndpoint
extends org.springframework.integration.gateway.MessagingGatewaySupport
implements org.springframework.integration.context.OrderlyShutdownCapable
MessagingGatewaySupport extension for HTTP Inbound endpoints
with basic properties.| Modifier and Type | Field and Description |
|---|---|
protected java.util.concurrent.atomic.AtomicInteger |
activeCount |
protected static boolean |
JAXB_PRESENT |
protected static java.util.List<org.springframework.http.HttpMethod> |
NON_READABLE_BODY_HTTP_METHODS |
protected static boolean |
ROME_TOOLS_PRESENT |
messagingTemplatelifecycleCondition, lifecycleLockEXPRESSION_PARSER, logger| Constructor and Description |
|---|
BaseHttpInboundEndpoint(boolean expectReply) |
| Modifier and Type | Method and Description |
|---|---|
int |
afterShutdown() |
int |
beforeShutdown() |
protected org.springframework.expression.spel.support.StandardEvaluationContext |
createEvaluationContext() |
protected org.springframework.http.HttpStatus |
evaluateHttpStatus(org.springframework.http.HttpEntity<?> httpEntity) |
java.lang.String |
getComponentType() |
CrossOrigin |
getCrossOrigin() |
protected boolean |
getExtractReplyPayload() |
protected java.util.Map<java.lang.String,org.springframework.expression.Expression> |
getHeaderExpressions() |
protected org.springframework.integration.mapping.HeaderMapper<org.springframework.http.HttpHeaders> |
getHeaderMapper() |
org.springframework.integration.IntegrationPatternType |
getIntegrationPatternType() |
protected org.springframework.expression.Expression |
getPayloadExpression() |
RequestMapping |
getRequestMapping() |
protected org.springframework.core.ResolvableType |
getRequestPayloadType() |
protected org.springframework.expression.Expression |
getStatusCodeExpression() |
protected org.springframework.validation.Validator |
getValidator() |
protected boolean |
isExpectReply() |
protected static boolean |
isReadable(org.springframework.http.HttpMethod httpMethod)
Checks if the request has a readable body (not a GET, HEAD, or OPTIONS request).
|
protected void |
onInit() |
protected org.springframework.http.HttpStatus |
resolveHttpStatusFromHeaders(org.springframework.messaging.MessageHeaders headers) |
void |
setCrossOrigin(CrossOrigin crossOrigin)
Set the
CrossOrigin to permit cross origin requests for this endpoint. |
void |
setExtractReplyPayload(boolean extractReplyPayload)
Specify whether only the reply Message's payload should be passed in the response.
|
void |
setHeaderExpressions(java.util.Map<java.lang.String,org.springframework.expression.Expression> headerExpressions)
Specifies a Map of SpEL expressions to evaluate in order to generate the Message headers.
|
void |
setHeaderMapper(org.springframework.integration.mapping.HeaderMapper<org.springframework.http.HttpHeaders> headerMapper)
Set the
HeaderMapper to use when mapping between HTTP headers and MessageHeaders. |
void |
setPayloadExpression(org.springframework.expression.Expression payloadExpression)
Specifies a SpEL expression to evaluate in order to generate the Message payload.
|
void |
setRequestMapping(RequestMapping requestMapping)
Set the
RequestMapping which allows you to specify a flexible RESTFul-mapping for this endpoint. |
void |
setRequestPayloadType(org.springframework.core.ResolvableType requestPayloadType)
Specify the type of payload to be generated when the inbound HTTP request
content is read by the converters/encoders.
|
void |
setRequestPayloadTypeClass(java.lang.Class<?> requestPayloadType)
Specify the type of payload to be generated when the inbound HTTP request
content is read by the converters/encoders.
|
void |
setStatusCodeExpression(org.springframework.expression.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. |
void |
setStatusCodeExpressionString(java.lang.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. |
void |
setValidator(org.springframework.validation.Validator validator)
Specify a
Validator to validate a converted payload from request. |
protected void |
validate(java.lang.Object value) |
buildErrorMessage, buildSendTimer, destroy, doStart, doStop, getErrorChannel, getErrorMessageAttributes, getManagedName, getManagedType, getOverrides, getReplyChannel, getRequestChannel, isLoggingEnabled, receive, receive, receiveMessage, receiveMessage, registerMetricsCaptor, registerReplyMessageCorrelatorIfNecessary, send, sendAndReceive, sendAndReceiveMessage, sendAndReceiveMessageReactive, sendTimer, setErrorChannel, setErrorChannelName, setErrorMessageStrategy, setErrorOnTimeout, setLoggingEnabled, setManagedName, setManagedType, setReplyChannel, setReplyChannelName, setReplyMapper, setReplyTimeout, setRequestChannel, setRequestChannelName, setRequestMapper, setRequestTimeout, setShouldTrackdoStop, getPhase, getRole, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stopafterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitprotected static final boolean JAXB_PRESENT
protected static final boolean ROME_TOOLS_PRESENT
protected static final java.util.List<org.springframework.http.HttpMethod> NON_READABLE_BODY_HTTP_METHODS
protected final java.util.concurrent.atomic.AtomicInteger activeCount
public void setPayloadExpression(org.springframework.expression.Expression payloadExpression)
#pathVariables#requestParams#requestAttributes#requestHeaders#matrixVariables#cookies
payloadExpression - The payload expression.public void setHeaderExpressions(java.util.Map<java.lang.String,org.springframework.expression.Expression> headerExpressions)
#pathVariables#requestParams#requestAttributes#requestHeaders#matrixVariables#cookies
headerExpressions - The header expressions.public void setRequestMapping(RequestMapping requestMapping)
RequestMapping which allows you to specify a flexible RESTFul-mapping for this endpoint.requestMapping - The request mapping.public final RequestMapping getRequestMapping()
public void setCrossOrigin(CrossOrigin crossOrigin)
CrossOrigin to permit cross origin requests for this endpoint.crossOrigin - the CrossOrigin config.public CrossOrigin getCrossOrigin()
protected org.springframework.expression.Expression getPayloadExpression()
protected java.util.Map<java.lang.String,org.springframework.expression.Expression> getHeaderExpressions()
protected boolean isExpectReply()
public void setHeaderMapper(org.springframework.integration.mapping.HeaderMapper<org.springframework.http.HttpHeaders> headerMapper)
HeaderMapper to use when mapping between HTTP headers and MessageHeaders.headerMapper - The header mapper.protected org.springframework.integration.mapping.HeaderMapper<org.springframework.http.HttpHeaders> getHeaderMapper()
public void setRequestPayloadTypeClass(java.lang.Class<?> requestPayloadType)
byte[].class.requestPayloadType - The payload type.public void setRequestPayloadType(org.springframework.core.ResolvableType requestPayloadType)
byte[].class.requestPayloadType - The payload type.protected org.springframework.core.ResolvableType getRequestPayloadType()
public void setExtractReplyPayload(boolean extractReplyPayload)
extractReplyPayload - true to extract the reply payload.protected boolean getExtractReplyPayload()
public void setStatusCodeExpressionString(java.lang.String statusCodeExpression)
Expression to resolve a status code for Response to override
the default '200 OK' or '500 Internal Server Error' for a timeout.statusCodeExpression - The status code Expression.setStatusCodeExpression(Expression)public void setStatusCodeExpression(org.springframework.expression.Expression statusCodeExpression)
Expression to resolve a status code for Response to override
the default '200 OK' or '500 Internal Server Error' for a timeout.
The statusCodeExpression is applied only for the one-way
<http:inbound-channel-adapter/> or when no reply (timeout) is received for
a gateway. The <http:inbound-gateway/> (or whenever
expectReply is true) resolves
an HttpStatus from the
HttpHeaders.STATUS_CODE reply
Message header.
statusCodeExpression - The status code Expression.MessagingGatewaySupport.setReplyTimeout(long),
HttpRequestHandlingEndpointSupport.HttpRequestHandlingEndpointSupport(boolean)protected org.springframework.expression.Expression getStatusCodeExpression()
public void setValidator(org.springframework.validation.Validator validator)
Validator to validate a converted payload from request.validator - the Validator to use.protected org.springframework.validation.Validator getValidator()
protected void onInit()
onInit in class org.springframework.integration.gateway.MessagingGatewaySupportprotected org.springframework.http.HttpStatus evaluateHttpStatus(org.springframework.http.HttpEntity<?> httpEntity)
protected org.springframework.http.HttpStatus resolveHttpStatusFromHeaders(org.springframework.messaging.MessageHeaders headers)
protected org.springframework.expression.spel.support.StandardEvaluationContext createEvaluationContext()
public int beforeShutdown()
beforeShutdown in interface org.springframework.integration.context.OrderlyShutdownCapablepublic int afterShutdown()
afterShutdown in interface org.springframework.integration.context.OrderlyShutdownCapablepublic java.lang.String getComponentType()
getComponentType in interface org.springframework.integration.support.context.NamedComponentgetComponentType in class org.springframework.integration.gateway.MessagingGatewaySupportpublic org.springframework.integration.IntegrationPatternType getIntegrationPatternType()
getIntegrationPatternType in interface org.springframework.integration.IntegrationPatterngetIntegrationPatternType in class org.springframework.integration.gateway.MessagingGatewaySupportprotected void validate(java.lang.Object value)
protected static boolean isReadable(@Nullable
org.springframework.http.HttpMethod httpMethod)
httpMethod - the HTTP method to check