GH-3957: Add JmsInboundGateway.replyToExpression #8560

artembilan · 2023-02-22T17:35:32Z

Sometimes we cannot use a standard JmsReplyTo property for sending replies from the server. A DestinationResolver API does not have access to the request message.

Introduce a ChannelPublishingJmsMessageListener.replyToExpression property to evaluate a reply destination against request JMS Message
Use this expression only of no JmsReplyTo property
Expose this property on Java DSL level
To simplify end-user experience with lambda configuration for this property, introduce a CheckedFunction which essentially re-throws exception "sneaky" way

garyrussell · 2023-02-22T17:48:23Z

...s/src/main/java/org/springframework/integration/jms/ChannelPublishingJmsMessageListener.java

+	/**
+	 * Set a SpEL expression to resolve a 'replyTo' destination from a request {@link jakarta.jms.Message}
+	 * as a root evaluation object if {@link jakarta.jms.Message#getJMSReplyTo()} is null.
+	 * @param replyToExpression the SpEL expression for 'replyTo' destination.
+	 * @since 6.1
+	 */


Javadocs should wrap at 90 chars max.

Suggested change

/**

* Set a SpEL expression to resolve a 'replyTo' destination from a request {@link jakarta.jms.Message}

* as a root evaluation object if {@link jakarta.jms.Message#getJMSReplyTo()} is null.

* @param replyToExpression the SpEL expression for 'replyTo' destination.

* @since 6.1

*/

/**

* Set a SpEL expression to resolve a 'replyTo' destination from a request

* {@link jakarta.jms.Message} as a root evaluation object if

* {@link jakarta.jms.Message#getJMSReplyTo()} is null.

* @param replyToExpression the SpEL expression for 'replyTo' destination.

* @since 6.1

*/

garyrussell · 2023-02-22T17:49:57Z

...s/src/main/java/org/springframework/integration/jms/ChannelPublishingJmsMessageListener.java

-	 * {@link #resolveDefaultReplyDestination default reply destination} is returned; if this too is <code>null</code>,
+	 * It will first check the JMS Reply-To {@link Destination} of the supplied request message;
+	 * if that is null, then the configured {@link #replyToExpression} is evaluated (if any), then a
+	 * {@link #resolveDefaultReplyDestination default reply destination} is returned; if this too is null,


garyrussell · 2023-02-22T17:50:54Z

...s/src/main/java/org/springframework/integration/jms/ChannelPublishingJmsMessageListener.java

+	}
+
+	@Nullable
+	private Destination resolveReplyTo(jakarta.jms.Message request, Session session) throws JMSException {


protected so subclasses can override?

I don't think so. Then it is probably better to make the whole getReplyDestination() as protected.
And then we will dive to a mess what is protected and what is not and can be accessed from the inheritors.
If you wish, we can revise this in a separate issue.

garyrussell · 2023-02-22T17:56:33Z

src/reference/asciidoc/jms.adoc

+By default, a `JmsInboundGateway` looks for a `jakarta.jms.Message.getJMSReplyTo()` property in the received message for sending a reply.
+Otherwise, it can be configured with a static `defaultReplyDestination`, or `defaultReplyQueueName` or `defaultReplyTopicName`.
+In addition, starting with version 6.1, a `replyToExpression` can be configured on a provided `ChannelPublishingJmsMessageListener` to determine a reply destination dynamically if standard `JMSReplyTo` property cannot be on request.
+A received `jakarta.jms.Message` is used a root evaluation context object.
+The following example demonstrates how to use Java DSL API to configure an inbound JMS gateway for custom reply destination resolved from request message:


Suggested change

By default, a `JmsInboundGateway` looks for a `jakarta.jms.Message.getJMSReplyTo()` property in the received message for sending a reply.

Otherwise, it can be configured with a static `defaultReplyDestination`, or `defaultReplyQueueName` or `defaultReplyTopicName`.

In addition, starting with version 6.1, a `replyToExpression` can be configured on a provided `ChannelPublishingJmsMessageListener` to determine a reply destination dynamically if standard `JMSReplyTo` property cannot be on request.

A received `jakarta.jms.Message` is used a root evaluation context object.

The following example demonstrates how to use Java DSL API to configure an inbound JMS gateway for custom reply destination resolved from request message:

By default, the `JmsInboundGateway` looks for a `jakarta.jms.Message.getJMSReplyTo()` property in the received message to determine where to send a reply.

Otherwise, it can be configured with a static `defaultReplyDestination`, or `defaultReplyQueueName` or `defaultReplyTopicName`.

In addition, starting with version 6.1, a `replyToExpression` can be configured on a provided `ChannelPublishingJmsMessageListener` to determine the reply destination dynamically, if the standard `JMSReplyTo` property is `null`on the request.

The received `jakarta.jms.Message` is used the root evaluation context object.

The following example demonstrates how to use Java DSL API to configure an inbound JMS gateway with a custom reply destination resolved from the request message:

garyrussell · 2023-02-22T17:58:13Z

src/reference/asciidoc/whats-new.adoc

+[[x6.1-jms]]
+=== JMS Changes
+
+A `JmsInboundGateway`, via its `ChannelPublishingJmsMessageListener`, can now be configured with a `replyToExpression` to resolve a reply destination against request message at runtime.


Suggested change

A `JmsInboundGateway`, via its `ChannelPublishingJmsMessageListener`, can now be configured with a `replyToExpression` to resolve a reply destination against request message at runtime.

The `JmsInboundGateway`, via its `ChannelPublishingJmsMessageListener`, can now be configured with a `replyToExpression` to resolve a reply destination against the request message at runtime.

garyrussell · 2023-02-22T17:58:45Z

spring-integration-core/src/main/java/org/springframework/integration/util/CheckedFunction.java

+			try {
+				return apply(t1);
+			}
+			catch (Throwable t) {


Sonar will complain about this.

Suggested change

catch (Throwable t) {

catch (Throwable t) { // NOSONAR

garyrussell · 2023-02-22T18:03:55Z

spring-integration-core/src/main/java/org/springframework/integration/util/CheckedFunction.java

+				return sneakyThrow(t);
+			}
+		};
+	}


I am not really comfortable with institutionalizing this JVM abuse. Is there no alternative?

OK. Will it be better if there is no that unchecked() then?
Something like plain:

@FunctionalInterface public interface CheckedFunction<T, R> { R apply(T t) throws Throwable; }

?

Right; that's the bit I was objecting to. You probebly need a // NOSONAR here too.

garyrussell · 2023-02-22T19:16:22Z

...gration-jms/src/main/java/org/springframework/integration/jms/dsl/JmsInboundGatewaySpec.java

+	public S replyToFunction(CheckedFunction<Message, ?> replyToFunction) {
+		return replyToExpression(new FunctionExpression<>(replyToFunction.unchecked()));
+	}


Why do we need this; why not just

Suggested change

public S replyToFunction(CheckedFunction<Message, ?> replyToFunction) {

return replyToExpression(new FunctionExpression<>(replyToFunction.unchecked()));

}

public S replyToFunction(Function<Message, ?> replyToFunction) {

return replyToExpression(new FunctionExpression<>(replyToFunction));

}

??

Sure, but then .replyToFunction(message -> message.getStringProperty("myReplyTo")) is not going to be clean and end-user has to handle that JMSException himself which is not runtime one.

So, you are assuming that the user will use a JMS operation to determine the destination? I guess that's reasonable given that the root object is a Message.

OK.

Fixes spring-projects#3957 Sometimes we cannot use a standard `JmsReplyTo` property for sending replies from the server. A `DestinationResolver` API does not have access to the request message. * Introduce a `ChannelPublishingJmsMessageListener.replyToExpression` property to evaluate a reply destination against request JMS `Message` * Use this expression only of no `JmsReplyTo` property * Expose this property on Java DSL level * To simplify end-user experience with lambda configuration for this property, introduce a `CheckedFunction` which essentially re-throws exception "sneaky" way

* Fix Javadocs lines length * Regular `catch` and re-throw in the `CheckedFunction`

artembilan requested a review from garyrussell February 22, 2023 17:35

garyrussell suggested changes Feb 22, 2023

View reviewed changes

garyrussell reviewed Feb 22, 2023

View reviewed changes

artembilan added 3 commits February 22, 2023 14:21

Fix Javadoc for CheckedFunction

949fba8

* Fix language in docs

2d20529

* Fix Javadocs lines length * Regular `catch` and re-throw in the `CheckedFunction`

artembilan force-pushed the GH-3957 branch from 505339e to 2d20529 Compare February 22, 2023 19:21

garyrussell merged commit acd8a03 into spring-projects:main Feb 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

GH-3957: Add JmsInboundGateway.replyToExpression #8560

GH-3957: Add JmsInboundGateway.replyToExpression #8560

Uh oh!

artembilan commented Feb 22, 2023

Uh oh!

garyrussell Feb 22, 2023

Uh oh!

garyrussell Feb 22, 2023

Uh oh!

garyrussell Feb 22, 2023

Uh oh!

artembilan Feb 22, 2023

Uh oh!

garyrussell Feb 22, 2023

Uh oh!

garyrussell Feb 22, 2023

Uh oh!

garyrussell Feb 22, 2023

Uh oh!

garyrussell Feb 22, 2023

Uh oh!

artembilan Feb 22, 2023

Uh oh!

garyrussell Feb 22, 2023

Uh oh!

garyrussell Feb 22, 2023

Uh oh!

artembilan Feb 22, 2023

Uh oh!

garyrussell Feb 22, 2023

Uh oh!

Uh oh!

	A `JmsInboundGateway`, via its `ChannelPublishingJmsMessageListener`, can now be configured with a `replyToExpression` to resolve a reply destination against request message at runtime.
	The `JmsInboundGateway`, via its `ChannelPublishingJmsMessageListener`, can now be configured with a `replyToExpression` to resolve a reply destination against the request message at runtime.

GH-3957: Add JmsInboundGateway.replyToExpression #8560

GH-3957: Add JmsInboundGateway.replyToExpression #8560

Uh oh!

Conversation

artembilan commented Feb 22, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!