Migrate Zip Extension as a core module

Author: artembilan

build.gradle

@@ -87,33 +87,34 @@ ext {
     lettuceVersion = '6.2.3.RELEASE'
     log4jVersion = '2.19.0'
     mailVersion = '1.0.0'
-    micrometerPropagationVersion = '1.0.1-SNAPSHOT'
-    micrometerTracingVersion = '1.0.2-SNAPSHOT'
+    micrometerPropagationVersion = '1.0.2'
+    micrometerTracingVersion = '1.0.2'
     micrometerVersion = '1.11.0-SNAPSHOT'
     mockitoVersion = '5.1.1'
     mongoDriverVersion = '4.8.2'
     mysqlVersion = '8.0.32'
     pahoMqttClientVersion = '1.2.5'
     postgresVersion = '42.5.2'
     r2dbch2Version = '1.0.0.RELEASE'
-    reactorVersion = '2022.0.3-SNAPSHOT'
+    reactorVersion = '2022.0.3'
     resilience4jVersion = '2.0.2'
     romeToolsVersion = '1.18.0'
     rsocketVersion = '1.1.3'
     servletApiVersion = '6.0.0'
     smackVersion = '4.4.6'
     springAmqpVersion = '3.0.2-SNAPSHOT'
     springDataVersion = '2023.0.0-SNAPSHOT'
-    springGraphqlVersion = '1.2.0-SNAPSHOT'
+    springGraphqlVersion = '1.1.2-SNAPSHOT'
     springKafkaVersion = '3.0.3-SNAPSHOT'
     springRetryVersion = '2.0.0'
     springSecurityVersion = '6.1.0-SNAPSHOT'
-    springVersion = '6.0.5-SNAPSHOT'
+    springVersion = '6.0.5'
     springWsVersion = '4.0.1'
     testcontainersVersion = '1.17.6'
     tomcatVersion = '11.0.0-M1'
     xmlUnitVersion = '2.9.1'
     xstreamVersion = '1.4.20'
+    ztZipVersion = '1.15'
 
     javaProjects = subprojects - project(':spring-integration-bom')
 }
@@ -1094,6 +1095,15 @@ project('spring-integration-zeromq') {
     }
 }
 
+project('spring-integration-zip') {
+    description = 'Spring Integration Zip Support'
+    dependencies {
+        api project(':spring-integration-file')
+        api "org.zeroturnaround:zt-zip:$ztZipVersion"
+    }
+}
+
+
 project('spring-integration-zookeeper') {
     description = 'Spring Integration Zookeeper Support'
     dependencies {

spring-integration-zip/src/main/java/org/springframework/integration/zip/ZipHeaders.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2015-2023 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.integration.zip;
+
+/**
+ * Zip adapter specific message headers.
+ *
+ * @author Gunnar Hillert
+ *
+ * @since 6.1
+ */
+public abstract class ZipHeaders {
+
+	public static final String PREFIX = "zip_";
+
+	public static final String ZIP_ENTRY_FILE_NAME = PREFIX + "entryFilename";
+
+	public static final String ZIP_ENTRY_PATH = PREFIX + "entryPath";
+
+	public static final String ZIP_ENTRY_LAST_MODIFIED_DATE = PREFIX + "entryLastModifiedDate";
+
+}

spring-integration-zip/src/main/java/org/springframework/integration/zip/config/xml/AbstractZipTransformerParser.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2015-2023 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.integration.zip.config.xml;
+
+import org.w3c.dom.Element;
+
+import org.springframework.beans.factory.support.BeanDefinitionBuilder;
+import org.springframework.beans.factory.xml.ParserContext;
+import org.springframework.integration.config.xml.AbstractTransformerParser;
+import org.springframework.integration.config.xml.IntegrationNamespaceUtils;
+import org.springframework.util.StringUtils;
+
+/**
+ * Base class for Zip transformer parsers.
+ *
+ * @author Gunnar Hillert
+ * @author Artem Bilan
+ *
+ * @since 6.1
+ */
+public abstract class AbstractZipTransformerParser extends AbstractTransformerParser {
+
+	/**
+	 * @param element The XML Element to process
+	 * @param parserContext The Spring ParserContext
+	 * @param builder BeanDefinitionBuilder for constructing Bean Definitions
+	 */
+	@Override
+	protected final void parseTransformer(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
+		String deleteFiles = element.getAttribute("delete-files");
+		if (StringUtils.hasText(deleteFiles)) {
+			builder.addPropertyValue("deleteFiles", deleteFiles);
+		}
+		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "charset");
+		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "result-type", "zipResultType");
+		postProcessTransformer(element, parserContext, builder);
+	}
+
+	/**
+	 * Subclasses may override this method to provide additional configuration.
+	 *
+	 * @param element The XML Element to process
+	 * @param parserContext The Spring ParserContext
+	 * @param builder BeanDefinitionBuilder for constructing Bean Definitions
+	 */
+	protected void postProcessTransformer(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
+	}
+
+}

spring-integration-zip/src/main/java/org/springframework/integration/zip/config/xml/UnZipTransformerParser.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2015-2023 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.integration.zip.config.xml;
+
+import org.w3c.dom.Element;
+
+import org.springframework.beans.factory.support.BeanDefinitionBuilder;
+import org.springframework.beans.factory.xml.ParserContext;
+import org.springframework.integration.config.xml.IntegrationNamespaceUtils;
+import org.springframework.integration.zip.transformer.UnZipTransformer;
+
+/**
+ * Parser for the 'unzip-transformer' element.
+ *
+ * @author Gunnar Hillert
+ * @author Artem Bilan
+ *
+ * @since 6.1
+ */
+public class UnZipTransformerParser extends AbstractZipTransformerParser {
+
+	@Override
+	protected String getTransformerClassName() {
+		return UnZipTransformer.class.getName();
+	}
+
+	@Override
+	protected void postProcessTransformer(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
+		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "expect-single-result");
+	}
+
+}

spring-integration-zip/src/main/java/org/springframework/integration/zip/config/xml/ZipNamespaceHandler.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2015-2023 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.integration.zip.config.xml;
+
+import org.springframework.integration.config.xml.AbstractIntegrationNamespaceHandler;
+
+/**
+ * The namespace handler for the Zip namespace
+ *
+ * @author Gunnar Hillert
+ *
+ * @since 6.1
+ *
+ */
+public class ZipNamespaceHandler extends AbstractIntegrationNamespaceHandler {
+
+	@Override
+	public void init() {
+		this.registerBeanDefinitionParser("zip-transformer",  new ZipTransformerParser());
+		this.registerBeanDefinitionParser("unzip-transformer",  new UnZipTransformerParser());
+	}
+
+}

spring-integration-zip/src/main/java/org/springframework/integration/zip/config/xml/ZipTransformerParser.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2015-2023 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.integration.zip.config.xml;
+
+import org.w3c.dom.Element;
+
+import org.springframework.beans.factory.support.BeanDefinitionBuilder;
+import org.springframework.beans.factory.xml.ParserContext;
+import org.springframework.integration.config.xml.IntegrationNamespaceUtils;
+import org.springframework.integration.zip.transformer.ZipTransformer;
+
+/**
+ * Parser for the 'zip-transformer' element.
+ *
+ * @author Gunnar Hillert
+ * @author Artem Bilan
+ *
+ * @since 6.1
+ */
+public class ZipTransformerParser extends AbstractZipTransformerParser {
+
+	@Override
+	protected String getTransformerClassName() {
+		return ZipTransformer.class.getName();
+	}
+
+	@Override
+	protected void postProcessTransformer(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
+		IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "compression-level");
+	}
+
+}

spring-integration-zip/src/main/java/org/springframework/integration/zip/config/xml/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Provides parser classes to provide Xml namespace support for the Zip components.
+ */
+package org.springframework.integration.zip.config.xml;

spring-integration-zip/src/main/java/org/springframework/integration/zip/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Root package of the Zip Module.
+ */
+package org.springframework.integration.zip;

spring-integration-zip/src/main/java/org/springframework/integration/zip/splitter/UnZipResultSplitter.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2015-2023 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.integration.zip.splitter;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+import org.apache.commons.io.FilenameUtils;
+
+import org.springframework.integration.file.FileHeaders;
+import org.springframework.integration.splitter.AbstractMessageSplitter;
+import org.springframework.integration.support.MessageBuilder;
+import org.springframework.integration.zip.ZipHeaders;
+import org.springframework.messaging.Message;
+import org.springframework.messaging.MessageHeaders;
+import org.springframework.util.Assert;
+
+/**
+ *
+ * @author Gunnar Hillert
+ * @author Andriy Kryvtsun
+ * @author Artem Bilan
+ *
+ * @since 6.1
+ */
+public class UnZipResultSplitter extends AbstractMessageSplitter {
+
+	@Override
+	@SuppressWarnings("unchecked")
+	protected Object splitMessage(Message<?> message) {
+		Assert.state(message.getPayload() instanceof Map,
+				"The UnZipResultSplitter supports only Map<String, Object> payload");
+		Map<String, Object> unzippedEntries = (Map<String, Object>) message.getPayload();
+		MessageHeaders headers = message.getHeaders();
+
+		List<MessageBuilder<Object>> messageBuilders = new ArrayList<>(unzippedEntries.size());
+
+		for (Map.Entry<String, Object> entry : unzippedEntries.entrySet()) {
+			String path = FilenameUtils.getPath(entry.getKey());
+			String filename = FilenameUtils.getName(entry.getKey());
+			MessageBuilder<Object> messageBuilder = MessageBuilder.withPayload(entry.getValue())
+					.setHeader(FileHeaders.FILENAME, filename)
+					.setHeader(ZipHeaders.ZIP_ENTRY_PATH, path)
+					.copyHeadersIfAbsent(headers);
+			messageBuilders.add(messageBuilder);
+		}
+
+		return messageBuilders;
+	}
+
+}

spring-integration-zip/src/main/java/org/springframework/integration/zip/splitter/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Classes to support Splitter pattern for Zip.
+ */
+package org.springframework.integration.zip.splitter;