From 32e34bf2ec2b833ab669f8f6c06a127aa2ffdda4 Mon Sep 17 00:00:00 2001
From: Artem Bilan <abilan@vmware.com>
Date: Mon, 22 May 2023 11:59:47 -0400
Subject: [PATCH] GH-5871: Add missed `order` attr to XSDs (#8624)

* GH-5871: Add missed `order` attr to XSDs

Fixes https://github.com/spring-projects/spring-integration/issues/5871

* * Fix `spring-integration-xml.xsd` for duplicates
---
 .../xml/spring-integration-cassandra.xsd      | 11 ++++++-
 .../jmx/config/spring-integration-jmx.xsd     | 16 ++++++++++
 .../mail/config/spring-integration-mail.xsd   | 19 +----------
 .../config/spring-integration-mongodb.xsd     |  8 +++++
 .../redis/config/spring-integration-redis.xsd | 10 +++++-
 .../stomp/config/spring-integration-stomp.xsd | 10 ++++++
 .../config/spring-integration-websocket.xsd   | 10 ++++++
 .../ws/config/spring-integration-ws.xsd       | 21 ++----------
 .../xml/config/spring-integration-xml.xsd     | 10 +++---
 .../xmpp/config/spring-integration-xmpp.xsd   | 32 +++----------------
 10 files changed, 75 insertions(+), 72 deletions(-)

diff --git a/spring-integration-cassandra/src/main/resources/org/springframework/integration/config/xml/spring-integration-cassandra.xsd b/spring-integration-cassandra/src/main/resources/org/springframework/integration/config/xml/spring-integration-cassandra.xsd
index 989bcef2a2..bcd56c2059 100644
--- a/spring-integration-cassandra/src/main/resources/org/springframework/integration/config/xml/spring-integration-cassandra.xsd
+++ b/spring-integration-cassandra/src/main/resources/org/springframework/integration/config/xml/spring-integration-cassandra.xsd
@@ -187,9 +187,18 @@
 				</xsd:documentation>
 			</xsd:annotation>
 			<xsd:simpleType>
-				<xsd:union memberTypes="xsd:boolean xsd:string" />
+				<xsd:union memberTypes="xsd:boolean xsd:string"/>
 			</xsd:simpleType>
 		</xsd:attribute>
+		<xsd:attribute name="order" type="xsd:string">
+			<xsd:annotation>
+				<xsd:documentation>
+					Specifies the order for invocation when this
+					endpoint is connected as a
+					subscriber to a channel.
+				</xsd:documentation>
+			</xsd:annotation>
+		</xsd:attribute>
 	</xsd:complexType>
 
 	<xsd:complexType name="queryParameterType">
diff --git a/spring-integration-jmx/src/main/resources/org/springframework/integration/jmx/config/spring-integration-jmx.xsd b/spring-integration-jmx/src/main/resources/org/springframework/integration/jmx/config/spring-integration-jmx.xsd
index bb21b1ef80..b8e589ea8b 100644
--- a/spring-integration-jmx/src/main/resources/org/springframework/integration/jmx/config/spring-integration-jmx.xsd
+++ b/spring-integration-jmx/src/main/resources/org/springframework/integration/jmx/config/spring-integration-jmx.xsd
@@ -163,6 +163,14 @@
 									 minOccurs="0" maxOccurs="1"/>
 					</xsd:all>
 					<xsd:attribute name="default-notification-type" type="xsd:string" use="optional"/>
+					<xsd:attribute name="order" type="xsd:string">
+						<xsd:annotation>
+							<xsd:documentation>
+								The order for dispatching when the channel adapter is connected
+								as a subscriber to a 'SubscribableChannel'.
+							</xsd:documentation>
+						</xsd:annotation>
+					</xsd:attribute>
 				</xsd:extension>
 			</xsd:complexContent>
 		</xsd:complexType>
@@ -328,6 +336,14 @@
 			<xsd:extension base="mbeanServerIdentifierType">
 				<xsd:attribute name="object-name" type="xsd:string"/>
 				<xsd:attribute name="operation-name" type="xsd:string"/>
+				<xsd:attribute name="order" type="xsd:string">
+					<xsd:annotation>
+						<xsd:documentation>
+							The order for dispatching when the channel adapter is connected
+							as a subscriber to a 'SubscribableChannel'.
+					</xsd:documentation>
+					</xsd:annotation>
+				</xsd:attribute>
 			</xsd:extension>
 		</xsd:complexContent>
 	</xsd:complexType>
diff --git a/spring-integration-mail/src/main/resources/org/springframework/integration/mail/config/spring-integration-mail.xsd b/spring-integration-mail/src/main/resources/org/springframework/integration/mail/config/spring-integration-mail.xsd
index b38af9d71a..5e782c336e 100644
--- a/spring-integration-mail/src/main/resources/org/springframework/integration/mail/config/spring-integration-mail.xsd
+++ b/spring-integration-mail/src/main/resources/org/springframework/integration/mail/config/spring-integration-mail.xsd
@@ -370,24 +370,7 @@
 
 	<xsd:complexType name="transformerType">
 		<xsd:attribute name="id" type="xsd:string"/>
-		<xsd:attribute name="input-channel" type="xsd:string">
-			<xsd:annotation>
-				<xsd:appinfo>
-					<tool:annotation kind="ref">
-						<tool:expected-type type="org.springframework.messaging.MessageChannel"/>
-					</tool:annotation>
-				</xsd:appinfo>
-			</xsd:annotation>
-		</xsd:attribute>
-		<xsd:attribute name="output-channel" type="xsd:string">
-			<xsd:annotation>
-				<xsd:appinfo>
-					<tool:annotation kind="ref">
-						<tool:expected-type type="org.springframework.messaging.MessageChannel"/>
-					</tool:annotation>
-				</xsd:appinfo>
-			</xsd:annotation>
-		</xsd:attribute>
+		<xsd:attributeGroup ref="integration:inputOutputChannelGroup"/>
 	</xsd:complexType>
 
 	<xsd:attributeGroup name="inboundMappingGroup">
diff --git a/spring-integration-mongodb/src/main/resources/org/springframework/integration/mongodb/config/spring-integration-mongodb.xsd b/spring-integration-mongodb/src/main/resources/org/springframework/integration/mongodb/config/spring-integration-mongodb.xsd
index 2403ea04d0..41c7214882 100644
--- a/spring-integration-mongodb/src/main/resources/org/springframework/integration/mongodb/config/spring-integration-mongodb.xsd
+++ b/spring-integration-mongodb/src/main/resources/org/springframework/integration/mongodb/config/spring-integration-mongodb.xsd
@@ -126,6 +126,14 @@
 						<xsd:element name="request-handler-advice-chain" type="integration:handlerAdviceChainType"
 									 minOccurs="0" maxOccurs="1"/>
 					</xsd:choice>
+					<xsd:attribute name="order" type="xsd:string">
+						<xsd:annotation>
+							<xsd:documentation>
+								Specifies the order for invocation when this adapter is connected as a
+								subscriber to a SubscribableChannel.
+							</xsd:documentation>
+						</xsd:annotation>
+					</xsd:attribute>
 				</xsd:extension>
 			</xsd:complexContent>
 		</xsd:complexType>
diff --git a/spring-integration-redis/src/main/resources/org/springframework/integration/redis/config/spring-integration-redis.xsd b/spring-integration-redis/src/main/resources/org/springframework/integration/redis/config/spring-integration-redis.xsd
index 04d02e2379..21963f70ee 100644
--- a/spring-integration-redis/src/main/resources/org/springframework/integration/redis/config/spring-integration-redis.xsd
+++ b/spring-integration-redis/src/main/resources/org/springframework/integration/redis/config/spring-integration-redis.xsd
@@ -343,6 +343,14 @@
 							</xsd:appinfo>
 						</xsd:annotation>
 					</xsd:attribute>
+					<xsd:attribute name="order" type="xsd:string">
+						<xsd:annotation>
+							<xsd:documentation>
+								Specifies the order for invocation when this adapter is connected as a
+								subscriber to a SubscribableChannel.
+							</xsd:documentation>
+						</xsd:annotation>
+					</xsd:attribute>
 				</xsd:extension>
 			</xsd:complexContent>
 		</xsd:complexType>
@@ -674,7 +682,7 @@
 			<xsd:documentation><![CDATA[
 				Configures a Consumer Endpoint for the
 				'org.springframework.integration.redis.outbound.RedisQueueOutboundGateway' that
-				 pushes a conversation UUID to the the 'queue', then pushes the value to the
+				 pushes a conversation UUID to the 'queue', then pushes the value to the
 				Redis List with that UUID as a key and receives a reply from the Redis List with
 				'<UUID>.reply' as its key. A new UUID is used for each interaction.
 			]]></xsd:documentation>
diff --git a/spring-integration-stomp/src/main/resources/org/springframework/integration/stomp/config/spring-integration-stomp.xsd b/spring-integration-stomp/src/main/resources/org/springframework/integration/stomp/config/spring-integration-stomp.xsd
index f6b31c9044..41b41b8e2e 100644
--- a/spring-integration-stomp/src/main/resources/org/springframework/integration/stomp/config/spring-integration-stomp.xsd
+++ b/spring-integration-stomp/src/main/resources/org/springframework/integration/stomp/config/spring-integration-stomp.xsd
@@ -107,6 +107,16 @@
 							</xsd:documentation>
 						</xsd:annotation>
 					</xsd:attribute>
+					<xsd:attribute name="order">
+						<xsd:annotation>
+							<xsd:documentation>
+								Specifies the order for invocation when this endpoint is connected as a
+								subscriber to a channel. This is particularly relevant when that channel
+								is using a "failover" dispatching strategy. It has no effect when this
+								endpoint itself is a Polling Consumer for a channel with a queue.
+							</xsd:documentation>
+						</xsd:annotation>
+					</xsd:attribute>
 				</xsd:extension>
 			</xsd:complexContent>
 		</xsd:complexType>
diff --git a/spring-integration-websocket/src/main/resources/org/springframework/integration/websocket/config/spring-integration-websocket.xsd b/spring-integration-websocket/src/main/resources/org/springframework/integration/websocket/config/spring-integration-websocket.xsd
index 6f739885d0..79f79f0bbf 100644
--- a/spring-integration-websocket/src/main/resources/org/springframework/integration/websocket/config/spring-integration-websocket.xsd
+++ b/spring-integration-websocket/src/main/resources/org/springframework/integration/websocket/config/spring-integration-websocket.xsd
@@ -358,6 +358,16 @@
 						<xsd:element name="request-handler-advice-chain" type="integration:handlerAdviceChainType"
 									 minOccurs="0" maxOccurs="1"/>
 					</xsd:choice>
+					<xsd:attribute name="order">
+						<xsd:annotation>
+							<xsd:documentation>
+								Specifies the order for invocation when this endpoint is connected as a
+								subscriber to a channel. This is particularly relevant when that channel
+								is using a "failover" dispatching strategy. It has no effect when this
+								endpoint itself is a Polling Consumer for a channel with a queue.
+							</xsd:documentation>
+						</xsd:annotation>
+					</xsd:attribute>
 				</xsd:extension>
 			</xsd:complexContent>
 		</xsd:complexType>
diff --git a/spring-integration-ws/src/main/resources/org/springframework/integration/ws/config/spring-integration-ws.xsd b/spring-integration-ws/src/main/resources/org/springframework/integration/ws/config/spring-integration-ws.xsd
index d0a8ee1afa..7c9ee390f1 100644
--- a/spring-integration-ws/src/main/resources/org/springframework/integration/ws/config/spring-integration-ws.xsd
+++ b/spring-integration-ws/src/main/resources/org/springframework/integration/ws/config/spring-integration-ws.xsd
@@ -87,7 +87,7 @@
 					]]></xsd:documentation>
 				</xsd:annotation>
 			</xsd:attribute>
-			<xsd:attribute name="requires-reply" type="xsd:string" use="optional" default="false">
+			<xsd:attribute name="requires-reply" type="xsd:string" default="false">
 				<xsd:annotation>
 					<xsd:documentation>
 						Specify whether this outbound gateway must return a non-null value. This value is
@@ -495,24 +495,7 @@ this list can also be simple patterns to be matched against the header names (e.
 
 	<xsd:complexType name="transformerType">
 		<xsd:attribute name="id" type="xsd:string"/>
-		<xsd:attribute name="input-channel" type="xsd:string">
-			<xsd:annotation>
-				<xsd:appinfo>
-					<tool:annotation kind="ref">
-						<tool:expected-type type="org.springframework.messaging.MessageChannel"/>
-					</tool:annotation>
-				</xsd:appinfo>
-			</xsd:annotation>
-		</xsd:attribute>
-		<xsd:attribute name="output-channel" type="xsd:string">
-			<xsd:annotation>
-				<xsd:appinfo>
-					<tool:annotation kind="ref">
-						<tool:expected-type type="org.springframework.messaging.MessageChannel"/>
-					</tool:annotation>
-				</xsd:appinfo>
-			</xsd:annotation>
-		</xsd:attribute>
+		<xsd:attributeGroup ref="integration:inputOutputChannelGroup"/>
 	</xsd:complexType>
 
 	<xsd:simpleType name="encodingModeEnumeration">
diff --git a/spring-integration-xml/src/main/resources/org/springframework/integration/xml/config/spring-integration-xml.xsd b/spring-integration-xml/src/main/resources/org/springframework/integration/xml/config/spring-integration-xml.xsd
index b24e7dc783..8f54320f1f 100644
--- a/spring-integration-xml/src/main/resources/org/springframework/integration/xml/config/spring-integration-xml.xsd
+++ b/spring-integration-xml/src/main/resources/org/springframework/integration/xml/config/spring-integration-xml.xsd
@@ -492,7 +492,7 @@
 						<xsd:documentation><![CDATA[
 						By default XPath expressions are evaluated as NODESET type and then converted
 						to a List of channel names, thus handling single channel scenarios as well as multiple.
-						However certain XPath expressions may evaluate to String type results from the very
+						However, certain XPath expressions may evaluate to String type results from the very
 						beginning (e.g., 'name(./node())' - which will return the name of the root node) thus resulting in
 						an exception if the default evaluation type (NODESET) is used.
 
@@ -505,7 +505,7 @@
 						<xsd:union memberTypes="xsd:boolean xsd:string"/>
 					</xsd:simpleType>
 				</xsd:attribute>
-				<xsd:attribute name="xpath-expression-ref" type="xsd:string" use="optional">
+				<xsd:attribute name="xpath-expression-ref" type="xsd:string">
 					<xsd:annotation>
 						<xsd:documentation>
 							Reference to the XPathExpression instance to be
@@ -534,13 +534,13 @@
 							<xsd:documentation><![CDATA[
 								Internally XPath expressions will be evaluated as
 								NODESET type and converted to a List<String>
-								representing channel names. Typically such a list
+								representing channel names. Typically, such a list
 								will contain a single channel name. However,
 								based on the results of an XPath Expression, the
 								XPath router can also take on the characteristics
 								of a Recipient List Router if the XPath Expression
-								returns more then one value. In that case, the
-								List<String> will contain more then one channel
+								returns more than one value. In that case, the
+								List<String> will contain more than one channel
 								name and consequently Messages will be sent to
 								all channels in the list.
 							]]></xsd:documentation>
diff --git a/spring-integration-xmpp/src/main/resources/org/springframework/integration/xmpp/config/spring-integration-xmpp.xsd b/spring-integration-xmpp/src/main/resources/org/springframework/integration/xmpp/config/spring-integration-xmpp.xsd
index 714493e307..a65c28b8b6 100644
--- a/spring-integration-xmpp/src/main/resources/org/springframework/integration/xmpp/config/spring-integration-xmpp.xsd
+++ b/spring-integration-xmpp/src/main/resources/org/springframework/integration/xmpp/config/spring-integration-xmpp.xsd
@@ -112,7 +112,7 @@
 								A SpEL expression to evaluate a 'payload' with the incoming
 								'org.jivesoftware.smack.packet.Message' as root object.
 								It useful in case of custom (XEP) XMPP interactions, e.g. GCM.
-								By default a Message 'body' is used as 'payload'.
+								By default, a Message 'body' is used as 'payload'.
 								The '#extension' SpEL variable is registered in the evaluation context
 								if one and only one extension is present in the Message.
 								Replaces 'extract-payload' attribute since 4.3.
@@ -295,7 +295,7 @@
 						<xsd:element name="chat-to" type="headerType">
 							<xsd:annotation>
 								<xsd:documentation>
-									The id of the user you sending a message to (e.g., user@gmail.com)
+									The id of the user the message is sent to (e.g., user@gmail.com)
 								</xsd:documentation>
 							</xsd:annotation>
 						</xsd:element>
@@ -333,7 +333,7 @@
 		<xsd:attribute name="value" type="xsd:string">
 			<xsd:annotation>
 				<xsd:documentation>
-					Value of this header inside of a Message
+					Value of this header in a Message
 				</xsd:documentation>
 			</xsd:annotation>
 		</xsd:attribute>
@@ -366,31 +366,7 @@
 
 	<xsd:complexType name="transformerType">
 		<xsd:attribute name="id" type="xsd:string"/>
-		<xsd:attribute name="input-channel" type="xsd:string">
-			<xsd:annotation>
-				<xsd:appinfo>
-					<tool:annotation kind="ref">
-						<tool:expected-type type="org.springframework.messaging.MessageChannel"/>
-					</tool:annotation>
-				</xsd:appinfo>
-				<xsd:documentation>
-					The receiving Message channel of this endpoint
-				</xsd:documentation>
-			</xsd:annotation>
-		</xsd:attribute>
-		<xsd:attribute name="output-channel" type="xsd:string">
-			<xsd:annotation>
-				<xsd:appinfo>
-					<tool:annotation kind="ref">
-						<tool:expected-type type="org.springframework.messaging.MessageChannel"/>
-					</tool:annotation>
-				</xsd:appinfo>
-				<xsd:documentation>
-					Identifies the Message channel where Message will be sent after it's being processed by this
-					endpoint
-				</xsd:documentation>
-			</xsd:annotation>
-		</xsd:attribute>
+		<xsd:attributeGroup ref="integration:inputOutputChannelGroup"/>
 	</xsd:complexType>
 
 </xsd:schema>