From 32962894a0157362d4cfdb90fad836311b36e8ec Mon Sep 17 00:00:00 2001 From: Brian Clozel Date: Mon, 14 Oct 2024 14:54:24 +0200 Subject: [PATCH] Add runtime hints for JMS connection factories proxies Prior to this commit, the JMS connection factories would proxy various interfaces. This typically requires runtime hints for GraalVM native applications and spring-jms is missing those. This commit adds a new `ConnectionFactoriesRuntimeHints` that contributes such hints with type conditions. Fixes gh-33590 --- .../ConnectionFactoriesRuntimeHints.java | 49 ++++++++++++++++ .../resources/META-INF/spring/aot.factories | 2 + .../ConnectionFactoriesRuntimeHintsTests.java | 56 +++++++++++++++++++ 3 files changed, 107 insertions(+) create mode 100644 spring-jms/src/main/java/org/springframework/jms/connection/ConnectionFactoriesRuntimeHints.java create mode 100644 spring-jms/src/main/resources/META-INF/spring/aot.factories create mode 100644 spring-jms/src/test/java/org/springframework/jms/connection/ConnectionFactoriesRuntimeHintsTests.java diff --git a/spring-jms/src/main/java/org/springframework/jms/connection/ConnectionFactoriesRuntimeHints.java b/spring-jms/src/main/java/org/springframework/jms/connection/ConnectionFactoriesRuntimeHints.java new file mode 100644 index 00000000000..e0d98ba8349 --- /dev/null +++ b/spring-jms/src/main/java/org/springframework/jms/connection/ConnectionFactoriesRuntimeHints.java @@ -0,0 +1,49 @@ +/* + * Copyright 2002-2024 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.jms.connection; + +import jakarta.jms.Connection; +import jakarta.jms.QueueConnection; +import jakarta.jms.QueueSession; +import jakarta.jms.TopicConnection; +import jakarta.jms.TopicSession; + +import org.springframework.aot.hint.RuntimeHints; +import org.springframework.aot.hint.RuntimeHintsRegistrar; +import org.springframework.aot.hint.TypeReference; +import org.springframework.lang.Nullable; + +/** + * {@link RuntimeHintsRegistrar} to register hints for JMS connection factories. + * + * @author Brian Clozel + * @see CachingConnectionFactory + * @see SingleConnectionFactory + * @see TransactionAwareConnectionFactoryProxy + */ +class ConnectionFactoriesRuntimeHints implements RuntimeHintsRegistrar { + + @Override + public void registerHints(RuntimeHints hints, @Nullable ClassLoader classLoader) { + hints.proxies().registerJdkProxy(builder -> builder.onReachableType(TypeReference.of(CachingConnectionFactory.class)) + .proxiedInterfaces(SessionProxy.class, TopicSession.class, QueueSession.class)); + hints.proxies().registerJdkProxy(builder -> builder.onReachableType(TypeReference.of(SingleConnectionFactory.class)) + .proxiedInterfaces(Connection.class, QueueConnection.class, TopicConnection.class)); + hints.proxies().registerJdkProxy(builder -> builder.onReachableType(TypeReference.of(TransactionAwareConnectionFactoryProxy.class)) + .proxiedInterfaces(Connection.class, QueueConnection.class, TopicConnection.class)); + } +} diff --git a/spring-jms/src/main/resources/META-INF/spring/aot.factories b/spring-jms/src/main/resources/META-INF/spring/aot.factories new file mode 100644 index 00000000000..bfe2e244765 --- /dev/null +++ b/spring-jms/src/main/resources/META-INF/spring/aot.factories @@ -0,0 +1,2 @@ +org.springframework.aot.hint.RuntimeHintsRegistrar=\ +org.springframework.jms.connection.ConnectionFactoriesRuntimeHints \ No newline at end of file diff --git a/spring-jms/src/test/java/org/springframework/jms/connection/ConnectionFactoriesRuntimeHintsTests.java b/spring-jms/src/test/java/org/springframework/jms/connection/ConnectionFactoriesRuntimeHintsTests.java new file mode 100644 index 00000000000..94b33b8f76c --- /dev/null +++ b/spring-jms/src/test/java/org/springframework/jms/connection/ConnectionFactoriesRuntimeHintsTests.java @@ -0,0 +1,56 @@ +/* + * Copyright 2002-2024 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.jms.connection; + +import jakarta.jms.Connection; +import jakarta.jms.QueueConnection; +import jakarta.jms.QueueSession; +import jakarta.jms.TopicConnection; +import jakarta.jms.TopicSession; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import org.springframework.aot.hint.RuntimeHints; +import org.springframework.aot.hint.RuntimeHintsRegistrar; +import org.springframework.aot.hint.predicate.RuntimeHintsPredicates; +import org.springframework.core.io.support.SpringFactoriesLoader; +import org.springframework.util.ClassUtils; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for {@link ConnectionFactoriesRuntimeHints}. + */ +class ConnectionFactoriesRuntimeHintsTests { + + private RuntimeHints hints; + + @BeforeEach + void setup() { + this.hints = new RuntimeHints(); + SpringFactoriesLoader.forResourceLocation("META-INF/spring/aot.factories") + .load(RuntimeHintsRegistrar.class).forEach(registrar -> registrar + .registerHints(this.hints, ClassUtils.getDefaultClassLoader())); + } + + @Test + void shouldRegisterProxyHints() throws Exception { + assertThat(RuntimeHintsPredicates.proxies().forInterfaces(SessionProxy.class, TopicSession.class, QueueSession.class)).accepts(this.hints); + assertThat(RuntimeHintsPredicates.proxies().forInterfaces(Connection.class, QueueConnection.class, TopicConnection.class)).accepts(this.hints); + } + +}