Apache PDFBOX Quickstart

README.md

@@ -46,6 +46,7 @@ See [CONTRIBUTING](CONTRIBUTING.md) for how to build these examples.
 * [Amazon SQS](./amazon-sqs-quickstart): How to connect to an Amazon SQS (Simple Queue Service)
 * [Amazon SSM](./amazon-ssm-quickstart): How to connect to Amazon SSM (Simple Systems Manager)
 * [AWT Graphics, ImageIO](./awt-graphics-rest-quickstart): How to create a service that watermarks images and draws text
+* [Apache PDFBox, Graphics](./awt-graphics-pdfbox-quickstart): How to use PDFBOX to convert a PDF page to a PNG image
 * [Hibernate Reactive Panache and RESTEasy Reactive](./hibernate-reactive-quickstart): Exposing a CRUD service over REST using Hibernate Reactive and Panache to connect to a PostgreSQL database
 * [Hibernate Reactive and RESTEasy](./hibernate-reactive-quickstart): Exposing a CRUD service over REST using Hibernate Reactive to connect to a PostgreSQL database
 * [Hibernate Reactive and Vert.x Web](./hibernate-reactive-routes-quickstart): Exposing a CRUD service with Reactive Routes using Hibernate Reactive to connect to a PostgreSQL database

awt-graphics-pdfbox-quickstart/.dockerignore

@@ -0,0 +1,5 @@
+*
+!target/*-runner
+!target/*-runner.jar
+!target/lib/*
+!target/quarkus-app/

awt-graphics-pdfbox-quickstart/.gitignore

@@ -0,0 +1,35 @@
+# Eclipse
+.project
+.classpath
+.settings/
+bin/
+
+# IntelliJ
+.idea
+*.ipr
+*.iml
+*.iws
+
+# NetBeans
+nb-configuration.xml
+
+# Visual Studio Code
+.vscode
+
+# OSX
+.DS_Store
+
+# Vim
+*.swp
+*.swo
+
+# patch
+*.orig
+*.rej
+
+# Maven
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+release.properties

awt-graphics-pdfbox-quickstart/.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.6/apache-maven-3.8.6-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar

awt-graphics-pdfbox-quickstart/README.md

@@ -0,0 +1,44 @@
+# Web service to convert PDF to PNG
+
+This quickstart demonstrates a use case for [Quarkus AWT extension](https://github.com/quarkusio/quarkus/tree/main/extensions/awt) and [Apache PDFBox](https://github.com/apache/pdfbox).
+
+There is a single POST endpoint that consumes a PDF file as a multipart form data
+and returns an octet stream with a PNG image of the PDF's first page.
+
+[Quarkus AWT extension](https://github.com/quarkusio/quarkus/tree/main/extensions/awt) enables a set of
+ImageIO and AWT functionality in Quarkus Native images that is essential for Apache PDFBox rendering.
+See the extension documentation and tests to learn the available scope.
+Given the nature of native libraries in JDK implementing various image processing algorithms,
+venturing outside the tested scope might result in native image build time or runtime failure.
+
+# Additional system dependencies
+Note `microdnf` command installing `fontconfig` library in [Dockerfile.jvm](./src/main/docker/Dockerfile.jvm)
+and [Dockerfile.legacy-jar](./src/main/docker/Dockerfile.legacy-jar) to support jvm mode. 
+Both `freetype` and `fontconfig` libraries are needed for native mode in [Dockerfile.native](./src/main/docker/Dockerfile.native).
+
+# Usage with curl
+
+e.g.
+
+```bash
+curl -F "pdf=@/tmp/test-pdf.pdf" http://localhost:8080/pdf2png --output /tmp/result.png;
+```
+
+Converts the first page of the given PDF to a PNG file and returns it.
+
+# Usage with a client code
+
+See [PdfBoxResourceTest.java](./src/test/java/org/acme/awt/rest/PdfBoxResourceTest.java). The test is executed
+in native mode with:
+
+```bash
+./mvnw clean verify -Pnative
+```
+To run native tests locally, a JDK 11.0.16+ with Mandrel (or GraalVM) 21.3+ is required.
+Additionally, `freetype-devel` and `fontconfig` libraries must be installed. 
+
+# What the result looks like
+
+You can use the attached [test-pdf.pdf](./src/test/resources/test-pdf.pdf) and see how it converts to the image below:
+
+![Alt text](./doc/example.png)