GH-3462: Upgrade to Smack 4.4.5

Fixes #3462

Author: Flowdalic

build.gradle

@@ -96,7 +96,7 @@ ext {
     rsocketVersion = '1.1.1'
     saajVersion = '2.0.1'
     servletApiVersion = '5.0.0'
-    smackVersion = '4.3.5'
+    smackVersion = '4.4.5'
     springAmqpVersion = project.hasProperty('springAmqpVersion') ? project.springAmqpVersion : '3.0.0-SNAPSHOT'
     springDataVersion = project.hasProperty('springDataVersion') ? project.springDataVersion : '2022.0.0-SNAPSHOT'
     springGraphqlVersion = '1.0.0-SNAPSHOT'
@@ -1005,12 +1005,12 @@ project('spring-integration-xml') {
 }
 
 project('spring-integration-xmpp') {
-    description = 'Spring Integration XMPP Support'
-    dependencies {
-        api project(':spring-integration-core')
-        api "org.igniterealtime.smack:smack-tcp:$smackVersion"
-        api "org.igniterealtime.smack:smack-java7:$smackVersion"
-        api "org.igniterealtime.smack:smack-extensions:$smackVersion"
+	description = 'Spring Integration XMPP Support'
+	dependencies {
+		api project(':spring-integration-core')
+		api "org.igniterealtime.smack:smack-tcp:$smackVersion"
+		api "org.igniterealtime.smack:smack-java8:$smackVersion"
+		api "org.igniterealtime.smack:smack-extensions:$smackVersion"
 
         testImplementation project(':spring-integration-stream')
         testImplementation "org.igniterealtime.smack:smack-experimental:$smackVersion"

spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/inbound/ChatMessageListeningEndpoint.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2022 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.
@@ -42,6 +42,7 @@
  * @author Oleg Zhurakousky
  * @author Artem Bilan
  * @author Gary Russell
+ * @author Florian Schmaus
  *
  * @since 2.0
  */
@@ -122,10 +123,9 @@ private class ChatMessagePublishingStanzaListener implements StanzaListener {
 
 		@Override
 		public void processStanza(Stanza packet) {
-			if (packet instanceof org.jivesoftware.smack.packet.Message) {
-				org.jivesoftware.smack.packet.Message xmppMessage = (org.jivesoftware.smack.packet.Message) packet;
+			if (packet instanceof org.jivesoftware.smack.packet.Message xmppMessage) {
 				Map<String, ?> mappedHeaders =
-						ChatMessageListeningEndpoint.this.headerMapper.toHeadersFromRequest(xmppMessage);
+						ChatMessageListeningEndpoint.this.headerMapper.toHeadersFromRequest(xmppMessage.asBuilder());
 
 				Object messageBody = xmppMessage.getBody();
 

spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/outbound/ChatMessageSendingMessageHandler.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2022 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.
@@ -16,16 +16,18 @@
 
 package org.springframework.integration.xmpp.outbound;
 
-import java.io.StringReader;
 import java.util.regex.Pattern;
 
 import org.jivesoftware.smack.AbstractXMPPConnection;
 import org.jivesoftware.smack.XMPPConnection;
 import org.jivesoftware.smack.packet.ExtensionElement;
+import org.jivesoftware.smack.packet.MessageBuilder;
+import org.jivesoftware.smack.packet.StanzaBuilder;
 import org.jivesoftware.smack.provider.ExtensionElementProvider;
 import org.jivesoftware.smack.util.PacketParserUtils;
+import org.jivesoftware.smack.xml.XmlPullParser;
+import org.jxmpp.jid.Jid;
 import org.jxmpp.jid.impl.JidCreate;
-import org.xmlpull.v1.XmlPullParser;
 
 import org.springframework.integration.xmpp.XmppHeaders;
 import org.springframework.integration.xmpp.core.AbstractXmppConnectionAwareMessageHandler;
@@ -44,6 +46,7 @@
  * @author Mario Gray
  * @author Oleg Zhurakousky
  * @author Artem Bilan
+ * @author Florian Schmaus
  *
  * @since 2.0
  */
@@ -85,27 +88,30 @@ public String getComponentType() {
 
 	@Override
 	protected void handleMessageInternal(Message<?> message) {
+		org.jivesoftware.smack.packet.Message xmppMessage;
 		Assert.isTrue(isInitialized(),
 				() -> getComponentName() + "#" + getComponentType() + " must be initialized");
 		try {
 			Object payload = message.getPayload();
-			org.jivesoftware.smack.packet.Message xmppMessage;
+			MessageBuilder xmppMessageBuilder;
 			if (payload instanceof org.jivesoftware.smack.packet.Message) {
 				xmppMessage = (org.jivesoftware.smack.packet.Message) payload;
+				xmppMessageBuilder = xmppMessage.asBuilder();
 			}
 			else {
 				String to = message.getHeaders().get(XmppHeaders.TO, String.class);
 				Assert.state(StringUtils.hasText(to), () -> "The '" + XmppHeaders.TO + "' header must not be null");
-				xmppMessage = buildXmppMessage(payload, to);
+				xmppMessageBuilder = buildXmppMessage(payload, to);
 			}
 
 			if (this.headerMapper != null) {
-				this.headerMapper.fromHeadersToRequest(message.getHeaders(), xmppMessage);
+				this.headerMapper.fromHeadersToRequest(message.getHeaders(), xmppMessageBuilder);
 			}
 			XMPPConnection xmppConnection = getXmppConnection();
 			if (!xmppConnection.isConnected() && xmppConnection instanceof AbstractXMPPConnection) {
 				((AbstractXMPPConnection) xmppConnection).connect();
 			}
+			xmppMessage = xmppMessageBuilder.build();
 			xmppConnection.sendStanza(xmppMessage);
 		}
 		catch (InterruptedException e) {
@@ -117,14 +123,16 @@ protected void handleMessageInternal(Message<?> message) {
 		}
 	}
 
-	private org.jivesoftware.smack.packet.Message buildXmppMessage(Object payload, String to)
+	private MessageBuilder buildXmppMessage(Object payload, String to)
 			throws Exception { // NOSONAR Smack throws it
 
-		org.jivesoftware.smack.packet.Message xmppMessage;
-		xmppMessage = new org.jivesoftware.smack.packet.Message(JidCreate.from(to));
+		Jid toJid = JidCreate.from(to);
+		MessageBuilder xmppMessageBuilder =
+				StanzaBuilder.buildMessage()
+						.to(toJid);
 
-		if (payload instanceof ExtensionElement) {
-			xmppMessage.addExtension((ExtensionElement) payload);
+		if (payload instanceof ExtensionElement extensionElement) {
+			xmppMessageBuilder.addExtension(extensionElement);
 		}
 		else if (payload instanceof String) {
 			if (this.extensionProvider != null) {
@@ -135,13 +143,13 @@ else if (payload instanceof String) {
 					// if the target content isn't XML.
 					data = "<root>" + data + "</root>";
 				}
-				XmlPullParser xmlPullParser = PacketParserUtils.newXmppParser(new StringReader(data));
-				xmlPullParser.next();
+				XmlPullParser xmlPullParser = PacketParserUtils.getParserFor(data);
 				ExtensionElement extension = this.extensionProvider.parse(xmlPullParser);
-				xmppMessage.addExtension(extension);
+				xmppMessageBuilder.addExtension(extension);
 			}
 			else {
-				xmppMessage.setBody((String) payload);
+				String body = (String) payload;
+				xmppMessageBuilder.setBody(body);
 			}
 		}
 		else {
@@ -151,7 +159,7 @@ else if (payload instanceof String) {
 							"are supported. Received [" + payload.getClass().getName() +
 							"]. Consider adding a Transformer prior to this adapter.");
 		}
-		return xmppMessage;
+		return xmppMessageBuilder;
 	}
 
 }

spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/support/DefaultXmppHeaderMapper.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2020 the original author or authors.
+ * Copyright 2002-2022 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.
@@ -22,10 +22,10 @@
 import java.util.Map;
 
 import org.jivesoftware.smack.packet.Message;
+import org.jivesoftware.smack.packet.MessageBuilder;
 import org.jivesoftware.smackx.jiveproperties.JivePropertiesManager;
 import org.jivesoftware.smackx.jiveproperties.packet.JivePropertiesExtension;
 import org.jxmpp.jid.Jid;
-import org.jxmpp.jid.impl.JidCreate;
 import org.jxmpp.stringprep.XmppStringprepException;
 
 import org.springframework.integration.mapping.AbstractHeaderMapper;
@@ -43,7 +43,7 @@
  *
  * @since 2.1
  */
-public class DefaultXmppHeaderMapper extends AbstractHeaderMapper<Message> implements XmppHeaderMapper {
+public class DefaultXmppHeaderMapper extends AbstractHeaderMapper<MessageBuilder> implements XmppHeaderMapper {
 
 	private static final List<String> STANDARD_HEADER_NAMES = new ArrayList<>();
 
@@ -60,7 +60,7 @@ public DefaultXmppHeaderMapper() {
 	}
 
 	@Override
-	protected Map<String, Object> extractStandardHeaders(Message source) {
+	protected Map<String, Object> extractStandardHeaders(MessageBuilder source) {
 		Map<String, Object> headers = new HashMap<>();
 		Jid from = source.getFrom();
 		if (from != null) {
@@ -86,9 +86,9 @@ protected Map<String, Object> extractStandardHeaders(Message source) {
 	}
 
 	@Override
-	protected Map<String, Object> extractUserDefinedHeaders(Message source) {
+	protected Map<String, Object> extractUserDefinedHeaders(MessageBuilder source) {
 		Map<String, Object> headers = new HashMap<>();
-		JivePropertiesExtension jpe = (JivePropertiesExtension) source.getExtension(JivePropertiesExtension.NAMESPACE);
+		JivePropertiesExtension jpe = JivePropertiesExtension.from(source.build());
 		if (jpe == null) {
 			return headers;
 		}
@@ -99,7 +99,7 @@ protected Map<String, Object> extractUserDefinedHeaders(Message source) {
 	}
 
 	@Override
-	protected void populateStandardHeaders(Map<String, Object> headers, Message target) {
+	protected void populateStandardHeaders(Map<String, Object> headers, MessageBuilder target) {
 		String threadId = getHeaderIfAvailable(headers, XmppHeaders.THREAD, String.class);
 		if (StringUtils.hasText(threadId)) {
 			target.setThread(threadId);
@@ -125,28 +125,28 @@ protected void populateStandardHeaders(Map<String, Object> headers, Message targ
 				}
 			}
 		}
-		if (typeHeader instanceof Message.Type) {
-			target.setType((Message.Type) typeHeader);
+		if (typeHeader instanceof Message.Type messageType) {
+			target.ofType(messageType);
 		}
 	}
 
-	private void populateToHeader(Map<String, Object> headers, Message target) {
+	private void populateToHeader(Map<String, Object> headers, MessageBuilder target) {
 		String to = getHeaderIfAvailable(headers, XmppHeaders.TO, String.class);
 		if (StringUtils.hasText(to)) {
 			try {
-				target.setTo(JidCreate.from(to));
+				target.to(to);
 			}
 			catch (XmppStringprepException e) {
 				throw new IllegalStateException("Cannot parse 'xmpp_to' header value", e);
 			}
 		}
 	}
 
-	private void populateFromHeader(Map<String, Object> headers, Message target) {
+	private void populateFromHeader(Map<String, Object> headers, MessageBuilder target) {
 		String from = getHeaderIfAvailable(headers, XmppHeaders.FROM, String.class);
 		if (StringUtils.hasText(from)) {
 			try {
-				target.setFrom(JidCreate.from(from));
+				target.from(from);
 			}
 			catch (XmppStringprepException e) {
 				throw new IllegalStateException("Cannot parse 'xmpp_from' header value", e);
@@ -155,7 +155,7 @@ private void populateFromHeader(Map<String, Object> headers, Message target) {
 	}
 
 	@Override
-	protected void populateUserDefinedHeader(String headerName, Object headerValue, Message target) {
+	protected void populateUserDefinedHeader(String headerName, Object headerValue, MessageBuilder target) {
 		JivePropertiesManager.addProperty(target, headerName, headerValue);
 	}
 

spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/support/XmppHeaderMapper.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2022 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.
@@ -16,17 +16,19 @@
 
 package org.springframework.integration.xmpp.support;
 
-import org.jivesoftware.smack.packet.Message;
+import org.jivesoftware.smack.packet.MessageBuilder;
 
 import org.springframework.integration.mapping.RequestReplyHeaderMapper;
 
 /**
  * A convenience interface that extends {@link RequestReplyHeaderMapper}
- * but parameterized with the Smack API {@link Message}.
+ * but parameterized with the Smack API {@link MessageBuilder}.
  *
  * @author Mark Fisher
  * @author Gary Russell
+ * @author Florian Schmaus
+ *
  * @since 2.1
  */
-public interface XmppHeaderMapper extends RequestReplyHeaderMapper<Message> {
+public interface XmppHeaderMapper extends RequestReplyHeaderMapper<MessageBuilder> {
 }

spring-integration-xmpp/src/test/java/org/springframework/integration/xmpp/config/ChatMessageInboundChannelAdapterParserTests-context.xml

@@ -12,7 +12,7 @@
 	<beans:bean id="testConnection" class="org.mockito.Mockito" factory-method="spy">
 		<beans:constructor-arg>
 			<beans:bean class="org.jivesoftware.smack.tcp.XMPPTCPConnection">
-				<beans:constructor-arg value="guest"/>
+				<beans:constructor-arg value="guest@example.org"/>
 				<beans:constructor-arg value="guest"/>
 			</beans:bean>
 		</beans:constructor-arg>

spring-integration-xmpp/src/test/java/org/springframework/integration/xmpp/config/ChatMessageInboundChannelAdapterParserTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2021 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.
@@ -23,7 +23,8 @@
 
 import org.jivesoftware.smack.StanzaListener;
 import org.jivesoftware.smack.XMPPConnection;
-import org.jivesoftware.smack.packet.Message;
+import org.jivesoftware.smack.packet.MessageBuilder;
+import org.jivesoftware.smack.packet.StanzaBuilder;
 import org.jivesoftware.smackx.jiveproperties.JivePropertiesManager;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -102,12 +103,12 @@ public void testInboundAdapterUsageWithHeaderMapper() throws Exception {
 
 		StanzaListener stanzaListener = TestUtils.getPropertyValue(adapter, "stanzaListener", StanzaListener.class);
 
-		Message message = new Message();
+		MessageBuilder message = StanzaBuilder.buildMessage();
 		message.setBody("hello");
-		message.setTo(JidCreate.from("oleg"));
+		message.to(JidCreate.from("oleg"));
 		JivePropertiesManager.addProperty(message, "foo", "foo");
 		JivePropertiesManager.addProperty(message, "bar", "bar");
-		stanzaListener.processStanza(message);
+		stanzaListener.processStanza(message.build());
 		org.springframework.messaging.Message<?> siMessage = xmppInbound.receive(0);
 		assertThat(siMessage.getHeaders().get("foo")).isEqualTo("foo");
 		assertThat(siMessage.getHeaders().get("xmpp_to")).isEqualTo("oleg");

spring-integration-xmpp/src/test/java/org/springframework/integration/xmpp/ignore/OutboundPresenceTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2022 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.
@@ -17,6 +17,7 @@
 package org.springframework.integration.xmpp.ignore;
 
 import org.jivesoftware.smack.packet.Presence;
+import org.jivesoftware.smack.packet.StanzaBuilder;
 import org.junit.Ignore;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -33,6 +34,8 @@
  * Tests {@link PresenceSendingMessageHandler} to ensure that we are able to publish status.
  *
  * @author Josh Long
+ * @author Florian Schmaus
+ *
  * @since 2.0
  */
 @ContextConfiguration
@@ -46,8 +49,9 @@ public class OutboundPresenceTests {
 	@Test
 	@Ignore
 	public void testOutbound() throws Throwable {
-		Presence presence = new Presence(Presence.Type.available);
-		input.send(new GenericMessage<Presence>(presence));
+		Presence presence = StanzaBuilder.buildPresence().build();
+		input.send(new GenericMessage<>(presence));
 		Thread.sleep(60 * 1000);
 	}
+
 }