codebase/using-amazon-textract-in-spring-boot-to-extract-text-from-images [BAEL-6759] (#17362)

* adding module skeleton

* listing module names alphabetically

* adding textract configurations

* fix: adding region configuration property

* adding service layer

* incorporate review comments

* adding live test

* adding textract file type validation

Author: hardikSinghBehl

aws-modules/amazon-textract/pom.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <artifactId>amazon-textract</artifactId>
+    <version>0.0.1</version>
+    <packaging>jar</packaging>
+    <name>amazon-textract</name>
+    <description>codebase demonstrating the integration of Amazon Textract in Spring Boot to extract texts from images</description>
+
+    <parent>
+        <groupId>com.baeldung</groupId>
+        <artifactId>parent-boot-3</artifactId>
+        <version>0.0.1-SNAPSHOT</version>
+        <relativePath>../../parent-boot-3</relativePath>
+    </parent>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-configuration-processor</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>textract</artifactId>
+            <version>${amazon-textract.version}</version>
+        </dependency>
+    </dependencies>
+
+    <properties>
+        <java.version>17</java.version>
+        <amazon-textract.version>2.27.5</amazon-textract.version>
+    </properties>
+
+</project>

aws-modules/amazon-textract/src/main/java/com/baeldung/textract/Application.java

@@ -0,0 +1,13 @@
+package com.baeldung.textract;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class Application {
+
+    public static void main(String[] args) {
+        SpringApplication.run(Application.class, args);
+    }
+
+}

aws-modules/amazon-textract/src/main/java/com/baeldung/textract/configuration/AmazonTextractConfiguration.java

@@ -0,0 +1,35 @@
+package com.baeldung.textract.configuration;
+
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
+import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
+import software.amazon.awssdk.regions.Region;
+import software.amazon.awssdk.services.textract.TextractClient;
+
+@Configuration
+@EnableConfigurationProperties(AwsConfigurationProperties.class)
+public class AmazonTextractConfiguration {
+
+    private final AwsConfigurationProperties awsConfigurationProperties;
+
+    public AmazonTextractConfiguration(AwsConfigurationProperties awsConfigurationProperties) {
+        this.awsConfigurationProperties = awsConfigurationProperties;
+    }
+
+    @Bean
+    public TextractClient textractClient() {
+        String region = awsConfigurationProperties.getRegion();
+        String accessKey = awsConfigurationProperties.getAccessKey();
+        String secretKey = awsConfigurationProperties.getSecretKey();
+        AwsBasicCredentials awsCredentials = AwsBasicCredentials.create(accessKey, secretKey);
+
+        return TextractClient.builder()
+            .region(Region.of(region))
+            .credentialsProvider(StaticCredentialsProvider.create(awsCredentials))
+            .build();
+    }
+
+}

aws-modules/amazon-textract/src/main/java/com/baeldung/textract/configuration/AwsConfigurationProperties.java

@@ -0,0 +1,45 @@
+package com.baeldung.textract.configuration;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.validation.annotation.Validated;
+
+import jakarta.validation.constraints.NotBlank;
+
+@Validated
+@ConfigurationProperties(prefix = "com.baeldung.aws")
+public class AwsConfigurationProperties {
+
+    @NotBlank(message = "AWS region must be configured")
+    private String region;
+
+    @NotBlank(message = "AWS access key must be configured")
+    private String accessKey;
+
+    @NotBlank(message = "AWS secret key must be configured")
+    private String secretKey;
+
+    public String getRegion() {
+        return region;
+    }
+
+    public void setRegion(String region) {
+        this.region = region;
+    }
+
+    public String getAccessKey() {
+        return accessKey;
+    }
+
+    public void setAccessKey(String accessKey) {
+        this.accessKey = accessKey;
+    }
+
+    public String getSecretKey() {
+        return secretKey;
+    }
+
+    public void setSecretKey(String secretKey) {
+        this.secretKey = secretKey;
+    }
+
+}

aws-modules/amazon-textract/src/main/java/com/baeldung/textract/service/TextExtractor.java

@@ -0,0 +1,60 @@
+package com.baeldung.textract.service;
+
+import java.io.IOException;
+import java.util.stream.Collectors;
+
+import org.springframework.stereotype.Service;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.multipart.MultipartFile;
+
+import com.baeldung.textract.validation.ValidFileType;
+
+import software.amazon.awssdk.core.SdkBytes;
+import software.amazon.awssdk.services.textract.TextractClient;
+import software.amazon.awssdk.services.textract.model.Block;
+import software.amazon.awssdk.services.textract.model.BlockType;
+import software.amazon.awssdk.services.textract.model.DetectDocumentTextResponse;
+
+@Service
+@Validated
+public class TextExtractor {
+
+    private final TextractClient textractClient;
+
+    public TextExtractor(TextractClient textractClient) {
+        this.textractClient = textractClient;
+    }
+
+    public String extract(@ValidFileType MultipartFile image) throws IOException {
+        byte[] imageBytes = image.getBytes();
+        DetectDocumentTextResponse response = textractClient.detectDocumentText(request -> request
+            .document(document -> document
+                .bytes(SdkBytes.fromByteArray(imageBytes))
+                .build())
+            .build());
+        
+        return transformTextDetectionResponse(response);
+    }
+
+    public String extract(String bucketName, String objectKey) {
+        DetectDocumentTextResponse response = textractClient.detectDocumentText(request -> request
+            .document(document -> document
+                .s3Object(s3Object -> s3Object
+                    .bucket(bucketName)
+                    .name(objectKey)
+                    .build())
+                .build())
+            .build());
+        
+        return transformTextDetectionResponse(response);
+    }
+
+    private String transformTextDetectionResponse(DetectDocumentTextResponse response) {
+        return response.blocks()
+            .stream()
+            .filter(block -> block.blockType().equals(BlockType.LINE))
+            .map(Block::text)
+            .collect(Collectors.joining(" "));
+    }
+
+}

aws-modules/amazon-textract/src/main/java/com/baeldung/textract/validation/TextractFileValidator.java

@@ -0,0 +1,26 @@
+package com.baeldung.textract.validation;
+
+import java.util.List;
+
+import org.springframework.web.multipart.MultipartFile;
+
+import jakarta.validation.ConstraintValidator;
+import jakarta.validation.ConstraintValidatorContext;
+
+public class TextractFileValidator implements ConstraintValidator<ValidFileType, MultipartFile> {
+
+    private static final List<String> VALID_CONTENT_TYPES = List.of(
+        "image/png",
+        "image/jpeg",
+        "image/tiff",
+        "application/pdf");
+
+    @Override
+    public boolean isValid(MultipartFile file, ConstraintValidatorContext context) {
+        if (file == null || file.isEmpty()) {
+            return false;
+        }
+        return VALID_CONTENT_TYPES.contains(file.getContentType());
+    }
+
+}

aws-modules/amazon-textract/src/main/java/com/baeldung/textract/validation/ValidFileType.java

@@ -0,0 +1,24 @@
+package com.baeldung.textract.validation;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import jakarta.validation.Constraint;
+import jakarta.validation.Payload;
+
+@Documented
+@Target(ElementType.PARAMETER)
+@Retention(RetentionPolicy.RUNTIME)
+@Constraint(validatedBy = TextractFileValidator.class)
+public @interface ValidFileType {
+
+    String message() default "Invalid file type. Allowed types are PNG, JPEG, TIFF, and PDF.";
+
+    Class<?>[] groups() default {};
+
+    Class<? extends Payload>[] payload() default {};
+
+}

aws-modules/amazon-textract/src/main/resources/application.yaml

@@ -0,0 +1,6 @@
+com:
+  baeldung:
+    aws:
+      region: ${AWS_REGION}
+      access-key: ${AWS_ACCESS_KEY}
+      secret-key: ${AWS_SECRET_KEY}

aws-modules/amazon-textract/src/test/java/com/baeldung/textract/service/TextExtractorLiveTest.java

@@ -0,0 +1,60 @@
+package com.baeldung.textract.service;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.core.io.ClassPathResource;
+import org.springframework.mock.web.MockMultipartFile;
+import org.springframework.web.multipart.MultipartFile;
+
+import jakarta.validation.ConstraintViolationException;
+import net.bytebuddy.utility.RandomString;
+
+@SpringBootTest
+class TextExtractorLiveTest {
+
+    @Autowired
+    private TextExtractor textExtractor;
+
+    @Test
+    void whenTextractCalledWithImage_thenCorrectTextExtracted() throws IOException {
+        String fileName = "sample-image.png";
+        Path filePath = new ClassPathResource(fileName).getFile().toPath();
+        ByteArrayInputStream fileContent = new ByteArrayInputStream(Files.readAllBytes(filePath));
+        MultipartFile file = new MockMultipartFile(fileName, fileName, "image/png", fileContent);
+
+        String response = textExtractor.extract(file);
+
+        assertThat(response).isEqualTo("Exploring Amazon Textract");
+    }
+
+    @Test
+    void whenTextractCalledWithS3Object_thenCorrectTextExtracted() {
+        String bucketName = "baeldung-amazon-textract-tutorial-bucket";
+        String objectKey = "sample-image.png";
+
+        String response = textExtractor.extract(bucketName, objectKey);
+
+        assertThat(response).isEqualTo("Exploring Amazon Textract");
+    }
+
+    @Test
+    void whenInvalidFileTypeProvided_thenConstraintViolationExceptionThrown() throws IOException {
+        String fileName = "invalid-file.txt";
+        ByteArrayInputStream fileContent = new ByteArrayInputStream(RandomString.make().getBytes());
+        MultipartFile invalidFile = new MockMultipartFile(fileName, fileName, "text/plain", fileContent);
+
+        assertThatThrownBy(() -> textExtractor.extract(invalidFile))
+            .isInstanceOf(ConstraintViolationException.class)
+            .hasMessageContaining("Invalid file type. Allowed types are PNG, JPEG, TIFF, and PDF.");
+    }
+
+}