spring-projectsGH-2792: HEnrichSpec: Add hooks for common headers

Fixes spring-projects#2792

Author: artembilan

spring-integration-core/src/main/java/org/springframework/integration/dsl/HeaderEnricherSpec.java

@@ -23,6 +23,7 @@
 import java.util.function.Function;
 
 import org.springframework.expression.Expression;
+import org.springframework.integration.IntegrationMessageHeaderAccessor;
 import org.springframework.integration.config.ConsumerEndpointFactoryBean;
 import org.springframework.integration.context.IntegrationContextUtils;
 import org.springframework.integration.expression.FunctionExpression;
@@ -38,6 +39,7 @@
 import org.springframework.integration.transformer.support.HeaderValueMessageProcessor;
 import org.springframework.integration.transformer.support.StaticHeaderValueMessageProcessor;
 import org.springframework.messaging.Message;
+import org.springframework.messaging.MessageHeaders;
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
@@ -290,6 +292,243 @@ public HeaderEnricherSpec headerExpressions(Map<String, String> headers, Boolean
 		return this;
 	}
 
+	/**
+	 * Add a {@link IntegrationMessageHeaderAccessor#CORRELATION_ID} header.
+	 * If the header exists, it will <b>not</b> be overwritten unless {@link #defaultOverwrite(boolean)} is true.
+	 * @param correlationId the header value for {@link IntegrationMessageHeaderAccessor#CORRELATION_ID}.
+	 * @return the header enricher spec.
+	 * @since 5.2
+	 */
+	public HeaderEnricherSpec correlationId(Object correlationId) {
+		return correlationId(correlationId, null);
+	}
+
+	/**
+	 * Add a {@link IntegrationMessageHeaderAccessor#CORRELATION_ID} header.
+	 * @param correlationId the header value for {@link IntegrationMessageHeaderAccessor#CORRELATION_ID}.
+	 * @param overwrite true to overwrite an existing header.
+	 * @return the header enricher spec.
+	 * @since 5.2
+	 */
+	public HeaderEnricherSpec correlationId(Object correlationId, Boolean overwrite) {
+		return header(IntegrationMessageHeaderAccessor.CORRELATION_ID, correlationId, overwrite);
+	}
+
+	/**
+	 * Add a {@link IntegrationMessageHeaderAccessor#CORRELATION_ID} header
+	 * where the value is a SpEL {@link Expression} evaluation result.
+	 * If the header exists, it will <b>not</b> be overwritten
+	 * unless {@link #defaultOverwrite(boolean)} is true.
+	 * @param correlationIdExpression the expression for
+	 * {@link IntegrationMessageHeaderAccessor#CORRELATION_ID} header.
+	 * @return the header enricher spec.
+	 * @since 5.2
+	 */
+	public HeaderEnricherSpec correlationIdExpression(String correlationIdExpression) {
+		return correlationIdExpression(correlationIdExpression, null);
+	}
+
+	/**
+	 * Add a {@link IntegrationMessageHeaderAccessor#CORRELATION_ID} header
+	 * where the value is a SpEL {@link Expression} evaluation result.
+	 * @param correlationIdExpression the expression for
+	 * {@link IntegrationMessageHeaderAccessor#CORRELATION_ID} header.
+	 * @param overwrite true to overwrite an existing header.
+	 * @return the header enricher spec.
+	 * @since 5.2
+	 */
+	public HeaderEnricherSpec correlationIdExpression(String correlationIdExpression, Boolean overwrite) {
+		return headerExpression(IntegrationMessageHeaderAccessor.CORRELATION_ID, correlationIdExpression, overwrite);
+	}
+
+	/**
+	 * Add a {@link IntegrationMessageHeaderAccessor#CORRELATION_ID} header where the
+	 * value is obtained by invoking the {@link Function} callback.
+	 * If the header exists, it will <b>not</b> be overwritten
+	 * unless {@link #defaultOverwrite(boolean)} is true.
+	 * @param correlationIdFunction the function.
+	 * @param <P> the payload type.
+	 * @return the header enricher spec.
+	 * @see FunctionExpression
+	 * @since 5.2
+	 */
+	public <P> HeaderEnricherSpec correlationIdFunction(Function<Message<P>, Object> correlationIdFunction) {
+		return correlationIdFunction(correlationIdFunction, null);
+	}
+
+	/**
+	 * Add a {@link IntegrationMessageHeaderAccessor#CORRELATION_ID} header where the
+	 * value is obtained by invoking the {@link Function} callback.
+	 * @param correlationIdFunction the function.
+	 * @param overwrite true to overwrite an existing header.
+	 * @param <P> the payload type.
+	 * @return the header enricher spec.
+	 * @see FunctionExpression
+	 * @since 5.2
+	 */
+	public <P> HeaderEnricherSpec correlationIdFunction(Function<Message<P>, ?> correlationIdFunction,
+			Boolean overwrite) {
+
+		return headerFunction(IntegrationMessageHeaderAccessor.CORRELATION_ID, correlationIdFunction, overwrite);
+	}
+
+	/**
+	 * Add a {@link MessageHeaders#REPLY_CHANNEL} header: bean name or instance.
+	 * If the header exists, it will <b>not</b> be overwritten unless {@link #defaultOverwrite(boolean)} is true.
+	 * @param replyChannel the header value for {@link MessageHeaders#REPLY_CHANNEL}.
+	 * @return the header enricher spec.
+	 * @since 5.2
+	 */
+	public HeaderEnricherSpec replyChannel(Object replyChannel) {
+		return replyChannel(replyChannel, null);
+	}
+
+	/**
+	 * Add a {@link MessageHeaders#REPLY_CHANNEL} header: bean name or instance.
+	 * @param replyChannel the header value for {@link MessageHeaders#REPLY_CHANNEL}.
+	 * @param overwrite true to overwrite an existing header.
+	 * @return the header enricher spec.
+	 * @since 5.2
+	 */
+	public HeaderEnricherSpec replyChannel(Object replyChannel, Boolean overwrite) {
+		return header(MessageHeaders.REPLY_CHANNEL, replyChannel, overwrite);
+	}
+
+	/**
+	 * Add a {@link MessageHeaders#REPLY_CHANNEL} header
+	 * where the value is a SpEL {@link Expression} evaluation result.
+	 * If the header exists, it will <b>not</b> be overwritten
+	 * unless {@link #defaultOverwrite(boolean)} is true.
+	 * @param replyChannelExpression the expression for {@link MessageHeaders#REPLY_CHANNEL} header.
+	 * @return the header enricher spec.
+	 * @since 5.2
+	 */
+	public HeaderEnricherSpec replyChannelExpression(String replyChannelExpression) {
+		return replyChannelExpression(replyChannelExpression, null);
+	}
+
+	/**
+	 * Add a {@link MessageHeaders#REPLY_CHANNEL} header
+	 * where the value is a SpEL {@link Expression} evaluation result.
+	 * @param replyChannelExpression the expression for {@link MessageHeaders#REPLY_CHANNEL} header.
+	 * @param overwrite true to overwrite an existing header.
+	 * @return the header enricher spec.
+	 * @since 5.2
+	 */
+	public HeaderEnricherSpec replyChannelExpression(String replyChannelExpression, Boolean overwrite) {
+		return headerExpression(MessageHeaders.REPLY_CHANNEL, replyChannelExpression, overwrite);
+	}
+
+	/**
+	 * Add a {@link MessageHeaders#REPLY_CHANNEL} header where the
+	 * value is obtained by invoking the {@link Function} callback.
+	 * If the header exists, it will <b>not</b> be overwritten
+	 * unless {@link #defaultOverwrite(boolean)} is true.
+	 * @param replyChannelFunction the function.
+	 * @param <P> the payload type.
+	 * @return the header enricher spec.
+	 * @see FunctionExpression
+	 * @since 5.2
+	 */
+	public <P> HeaderEnricherSpec replyChannelFunction(Function<Message<P>, Object> replyChannelFunction) {
+		return replyChannelFunction(replyChannelFunction, null);
+	}
+
+	/**
+	 * Add a {@link MessageHeaders#REPLY_CHANNEL} header where the
+	 * value is obtained by invoking the {@link Function} callback.
+	 * @param replyChannelFunction the function.
+	 * @param overwrite true to overwrite an existing header.
+	 * @param <P> the payload type.
+	 * @return the header enricher spec.
+	 * @see FunctionExpression
+	 * @since 5.2
+	 */
+	public <P> HeaderEnricherSpec replyChannelFunction(Function<Message<P>, ?> replyChannelFunction,
+			Boolean overwrite) {
+
+		return headerFunction(MessageHeaders.REPLY_CHANNEL, replyChannelFunction, overwrite);
+	}
+
+	/**
+	 * Add a {@link MessageHeaders#ERROR_CHANNEL} header: bean name or instance.
+	 * If the header exists, it will <b>not</b> be overwritten unless {@link #defaultOverwrite(boolean)} is true.
+	 * @param errorChannel the header value for {@link MessageHeaders#ERROR_CHANNEL}.
+	 * @return the header enricher spec.
+	 * @since 5.2
+	 */
+	public HeaderEnricherSpec errorChannel(Object errorChannel) {
+		return errorChannel(errorChannel, null);
+	}
+
+	/**
+	 * Add a {@link MessageHeaders#ERROR_CHANNEL} header: bean name or instance.
+	 * @param errorChannel the header value for {@link MessageHeaders#ERROR_CHANNEL}.
+	 * @param overwrite true to overwrite an existing header.
+	 * @return the header enricher spec.
+	 * @since 5.2
+	 */
+	public HeaderEnricherSpec errorChannel(Object errorChannel, Boolean overwrite) {
+		return header(MessageHeaders.ERROR_CHANNEL, errorChannel, overwrite);
+	}
+
+	/**
+	 * Add a {@link MessageHeaders#ERROR_CHANNEL} header
+	 * where the value is a SpEL {@link Expression} evaluation result.
+	 * If the header exists, it will <b>not</b> be overwritten
+	 * unless {@link #defaultOverwrite(boolean)} is true.
+	 * @param errorChannelExpression the expression for {@link MessageHeaders#ERROR_CHANNEL} header.
+	 * @return the header enricher spec.
+	 * @since 5.2
+	 */
+	public HeaderEnricherSpec errorChannelExpression(String errorChannelExpression) {
+		return errorChannelExpression(errorChannelExpression, null);
+	}
+
+	/**
+	 * Add a {@link MessageHeaders#ERROR_CHANNEL} header
+	 * where the value is a SpEL {@link Expression} evaluation result.
+	 * @param errorChannelExpression the expression for {@link MessageHeaders#ERROR_CHANNEL} header.
+	 * @param overwrite true to overwrite an existing header.
+	 * @return the header enricher spec.
+	 * @since 5.2
+	 */
+	public HeaderEnricherSpec errorChannelExpression(String errorChannelExpression, Boolean overwrite) {
+		return headerExpression(MessageHeaders.ERROR_CHANNEL, errorChannelExpression, overwrite);
+	}
+
+	/**
+	 * Add a {@link MessageHeaders#ERROR_CHANNEL} header where the
+	 * value is obtained by invoking the {@link Function} callback.
+	 * If the header exists, it will <b>not</b> be overwritten
+	 * unless {@link #defaultOverwrite(boolean)} is true.
+	 * @param errorChannelFunction the function.
+	 * @param <P> the payload type.
+	 * @return the header enricher spec.
+	 * @see FunctionExpression
+	 * @since 5.2
+	 */
+	public <P> HeaderEnricherSpec errorChannelFunction(Function<Message<P>, Object> errorChannelFunction) {
+		return errorChannelFunction(errorChannelFunction, null);
+	}
+
+	/**
+	 * Add a {@link MessageHeaders#ERROR_CHANNEL} header where the
+	 * value is obtained by invoking the {@link Function} callback.
+	 * @param errorChannelFunction the function.
+	 * @param overwrite true to overwrite an existing header.
+	 * @param <P> the payload type.
+	 * @return the header enricher spec.
+	 * @see FunctionExpression
+	 * @since 5.2
+	 */
+	public <P> HeaderEnricherSpec errorChannelFunction(Function<Message<P>, ?> errorChannelFunction,
+			Boolean overwrite) {
+
+		return headerFunction(MessageHeaders.ERROR_CHANNEL, errorChannelFunction, overwrite);
+	}
+
+
 	/**
 	 * Add a single header specification. If the header exists, it will <b>not</b> be
 	 * overwritten unless {@link #defaultOverwrite(boolean)} is true.
@@ -352,7 +591,7 @@ public HeaderEnricherSpec headerExpression(String name, String expression, Boole
 	 * @return the header enricher spec.
 	 * @see FunctionExpression
 	 */
-	public <P> HeaderEnricherSpec headerFunction(String name, Function<Message<P>, Object> function) {
+	public <P> HeaderEnricherSpec headerFunction(String name, Function<Message<P>, ?> function) {
 		return headerFunction(name, function, null);
 	}
 
@@ -366,7 +605,7 @@ public <P> HeaderEnricherSpec headerFunction(String name, Function<Message<P>, O
 	 * @return the header enricher spec.
 	 * @see FunctionExpression
 	 */
-	public <P> HeaderEnricherSpec headerFunction(String name, Function<Message<P>, Object> function,
+	public <P> HeaderEnricherSpec headerFunction(String name, Function<Message<P>, ?> function,
 			Boolean overwrite) {
 
 		return headerExpression(name, new FunctionExpression<>(function), overwrite);